@anvilco/anvil-embed-frame - npm Package Compare versions

Comparing version 2.0.0-alpha.0 to 2.0.0

CHANGELOG.md

@@ -5,2 +5,12 @@ # Changelog
 
+## [@anvilco/anvil-embed-frame@2.0.0-alpha.0](https://github.com/anvilco/react-ui/compare/@anvilco/anvil-embed-frame@1.1.0...@anvilco/anvil-embed-frame@2.0.0-alpha.0) - 2023-09-18
+
+### Merged
+
+- Update readme to fix import error [`#15`](https://github.com/anvilco/react-ui/pull/15)
+
+### Commits
+
+- Update deps [`52a73bd`](https://github.com/anvilco/react-ui/commit/52a73bd5f16d5435f80cd8ae76f20b2834807c40)
+
 ## @anvilco/anvil-embed-frame@1.1.0 - 2022-10-05
@@ -7,0 +17,0 @@

dist/index.d.ts

@@ -6,3 +6,2 @@ export default AnvilEmbedFrame;
     anvilURL: string;
-    enableDefaultStyles: boolean;
     scroll: string;
@@ -15,3 +14,2 @@ };
  * @prop {String} anvilURL
- * @prop {boolean} enableDefaultStyles
  * @prop {String} scroll
@@ -18,0 +16,0 @@ */

package.json

 {
   "name": "@anvilco/anvil-embed-frame",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0",
   "description": "The AnvilEmbedFrame React component for embedded Etch signatures and Workflows.",
@@ -57,3 +57,3 @@ "author": "Anvil Foundry Inc.",
   },
-  "gitHead": "4024144e3122e2e2feae8b0a119a413348e47651"
+  "gitHead": "2167b989737d7295473efb3c79e4976ba810257f"
 }

README.md

 # 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.
 
@@ -33,7 +33,12 @@ ## What is Anvil?
   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
@@ -63,13 +68,7 @@
 *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
@@ -83,6 +82,2 @@
 
-## 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
@@ -97,3 +92,3 @@
 * To enable iframe embedding, go to your organization's settings in Anvil, and enable "Iframe Embedding" in the API section.
-* Please contact us at [[e-mail]](mailto:[e-mail]) to enable iframe embedding for editors.
+* Please contact us at [[e-mail]](mailto:[e-mail]) 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.
@@ -100,0 +95,0 @@

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19596

increased by4.28%

Number of low quality alerts

1

decreased by-50%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Lines of code

178

decreased by-1.11%

Number of lines in readme file

103

decreased by-4.63%

No dependency changes