-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #16 from anvilco/bo/update
[Breaking] Update dependencies
- Loading branch information
Showing
15 changed files
with
5,463 additions
and
6,881 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,5 +9,4 @@ | |
}, | ||
"version": "independent", | ||
"npmClient": "yarn", | ||
"useWorkspaces": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,23 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
## @anvilco/anvil-embed-frame@1.1.0 - 2022-10-05 | ||
|
||
### Merged | ||
|
||
- Add Typescript support to `AnvilEmbedFrame` [`#13`](https://github.com/anvilco/react-ui/pull/13) | ||
- New `@anvilco/anvil-embed-frame` package [`#12`](https://github.com/anvilco/react-ui/pull/12) | ||
- Update Readme [`#11`](https://github.com/anvilco/react-ui/pull/11) | ||
- [1-min] Fix output path for type defs [`#10`](https://github.com/anvilco/react-ui/pull/10) | ||
- Add Typescript typings [`#9`](https://github.com/anvilco/react-ui/pull/9) | ||
- Update dependencies and peer dependencies [`#7`](https://github.com/anvilco/react-ui/pull/7) | ||
- Add onError handler [`#6`](https://github.com/anvilco/react-ui/pull/6) | ||
- Add onFinishSigning prop & upgrade all minor version deps [`#5`](https://github.com/anvilco/react-ui/pull/5) | ||
- Refactor the Docs [`#3`](https://github.com/anvilco/react-ui/pull/3) | ||
- Review Follow Ups and Refactoring [`#2`](https://github.com/anvilco/react-ui/pull/2) | ||
- Setup Linting [`#1`](https://github.com/anvilco/react-ui/pull/1) | ||
|
||
### Commits | ||
|
||
- AnvilSignatureFrame and AnvilSignatureModal [`7ab8fc2`](https://github.com/anvilco/react-ui/commit/7ab8fc2026411cbcc0186d9650290ba3d1afcfa5) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
# AnvilEmbedFrame | ||
|
||
A very minimal component that allows you to embed Anvil [Etch e-signatures](https://www.useanvil.com/docs/api/e-signatures#embedding-the-signing-ui-in-an-iframe), [Workflows](https://www.useanvil.com/docs/api/workflows#embedding-workflows-in-your-app), and editors into your app with an `iframe`. It will give you information via callback `onEvent`. | ||
`AnvilEmbedFrame` is a very minimal React component that allows you to embed Anvil [Etch e-signatures](https://www.useanvil.com/docs/api/e-signatures#embedding-the-signing-ui-in-an-iframe), [Workflows](https://www.useanvil.com/docs/api/workflows#embedding-workflows-in-your-app), and [embedded builders](https://www.useanvil.com/blog/engineering/embedded-edit-pdf-experience/) into your app with an `iframe`. It will give you information via callback `onEvent`. | ||
|
||
See the Etch e-sign [live demo](https://esign-demo.useanvil.com/) and open-source [demo repository](https://github.com/anvilco/anvil-e-signature-api-node-example) for an embedded Etch e-sign usage example. | ||
See the Etch e-sign [live demo](https://esign-demo.useanvil.com/) and open-source [demo repository](https://github.com/anvilco/anvil-e-signature-api-node-example) for an embedded Etch e-sign usage example using this component. | ||
|
||
## What is Anvil? | ||
|
||
|
@@ -30,11 +30,16 @@ import AnvilEmbedFrame from '@anvilco/anvil-embed-frame' | |
|
||
<AnvilEmbedFrame | ||
iframeURL={etchSignURL || workflowURL || editorURL} | ||
onEvent={(event) => console.log('Event object:', event)} | ||
onEvent={(eventObject) => console.log('Event object:', eventObject)} | ||
className="anvil-embed-frame" | ||
style={{ border: 'none' }} | ||
/> | ||
``` | ||
|
||
## Upgrading from v1 to v2 | ||
|
||
Beginning in v2.0, the `enableDefaultStyles` prop has been removed. There are now _no_ default styles embedded in the `AnvilEmbedFrame`, the frame will use default browser `iframe` styling. You can style the iframe with CSS and add `className` and `style` props to the component | ||
|
||
## Props | ||
|
||
### iframeURL | ||
|
@@ -59,17 +64,11 @@ Example | |
### onEvent | ||
|
||
*Function* - This function is called when an event is triggered. | ||
Possible event types for Etch e-sign include: `signerComplete`, `signerError` | ||
Possible event types for Workflwos include: `forgeSubmitPage`, `forgeComplete` | ||
Possible event types for [Etch e-sign include](https://www.useanvil.com/docs/api/e-signatures/#iframe-event-details): `signerComplete`, `signerError`. | ||
Possible event types for [Workflows include](https://www.useanvil.com/docs/api/workflows/#iframe-event-details): `forgeSubmitPage`, `forgeComplete`, `weldComplete`. | ||
|
||
Defaults to `(eventObject) => {}` | ||
|
||
### enableDefaultStyles | ||
|
||
*Boolean* - Set to false to disable the default inline styles of the component. | ||
|
||
Defaults to `true`. | ||
|
||
### scroll | ||
|
||
*String* - Set scroll to the iframe | ||
|
@@ -78,10 +77,6 @@ Defaults to `true`. | |
* `smooth` smoothly scrolls the window to the iframe when mounted | ||
* `null` - disables scrolling | ||
|
||
## Styling | ||
|
||
Customize the component by setting the `enableDefaultStyles` prop to false, then import CSS or pass in inline styles. Override IDs or classNames by passing them in as props. | ||
|
||
## Anvil Documentation | ||
|
||
* [Get started with Anvil API](https://www.useanvil.com/docs/api/getting-started) | ||
|
@@ -91,7 +86,7 @@ Customize the component by setting the `enableDefaultStyles` prop to false, then | |
## Notes | ||
|
||
* To enable iframe embedding, go to your organization's settings in Anvil, and enable "Iframe Embedding" in the API section. | ||
* Please contact us at [[email protected]](mailto:[email protected]) to enable iframe embedding for editors. | ||
* Please contact us at [[email protected]](mailto:[email protected]) to enable iframe embedding for our [embedded builders UIs](https://www.useanvil.com/blog/engineering/embedded-edit-pdf-experience/): the PDF template builder, e-sign packet builder, or Workflow builder. | ||
* React >= v16.0 required. | ||
|
||
## Bugs | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,24 @@ | |
|
||
All notable changes to this project will be documented in this file. | ||
|
||
## [@anvilco/react-signature-modal@2.0.0-alpha.0](https://github.com/anvilco/react-ui/compare/@anvilco/[email protected]...@anvilco/[email protected]) - 2023-09-18 | ||
|
||
### Commits | ||
|
||
- Update deps [`52a73bd`](https://github.com/anvilco/react-ui/commit/52a73bd5f16d5435f80cd8ae76f20b2834807c40) | ||
- Upgrade all deps [`2a89f80`](https://github.com/anvilco/react-ui/commit/2a89f80996fdf9bac6b4dfc2cd343641955dc20c) | ||
- Publish [`4024144`](https://github.com/anvilco/react-ui/commit/4024144e3122e2e2feae8b0a119a413348e47651) | ||
|
||
## [@anvilco/react-signature-modal@1.8.4](https://github.com/anvilco/react-ui/compare/@anvilco/[email protected]...@anvilco/[email protected]) - 2023-08-04 | ||
|
||
### Merged | ||
|
||
- Update readme to fix import error [`#15`](https://github.com/anvilco/react-ui/pull/15) | ||
|
||
### Commits | ||
|
||
- Remove AnvilSignatureFrame from main readme + fix import [`f93ef25`](https://github.com/anvilco/react-ui/commit/f93ef251be022bae5521fa57cd3fac818e896954) | ||
|
||
## [@anvilco/react-signature-modal@1.8.3](https://github.com/anvilco/react-ui/compare/@anvilco/[email protected]...@anvilco/[email protected]) - 2022-10-05 | ||
|
||
### Merged | ||
|
Oops, something went wrong.