prep for v1

Author: jackfranklin

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+**v1.0.0** [10 May 2019]
+
+* Released the breaking changes in 0.7-beta as a v1.
+* Allow passing an `onSetupError` function to handle errors registering Elm web components. Thanks @PChambino for this PR.
+
 **v0.7.0-beta** [14 Feb 2019]
 
 * **BREAKING**: this version supports the new Web Components V1 spec and **removes support for the V0 spec**. If you need to stay on the V0 spec, please stick to v0.6.1. Thanks @PChambino for the pull request implementing this.

README.md

@@ -2,7 +2,7 @@
 
 A small JavaScript package to let you wrap your Elm applications up in a web component.
 
-## NOTE: this documentation is for v0.7.0-beta, which supports V1 of the Web Elements spec. If you still need V0, please [check the docs for 0.6.1](https://github.com/thread/elm-web-components/tree/0.6.1)
+**Only supports the V1 web component spec**.
 
 ## Install
 
@@ -140,7 +140,7 @@ Rendering the component with:
 
 Will pass the flags as `{ someId : Int }`, rather than `{ someId : String }`.
 
-## `onDetached` (new in 0.3.0)
+## `onDetached`
 
 If you need to do some work when the Elm component is removed from the DOM, you can now pass `onDetached: () => ...` as another option:
 
@@ -158,6 +158,18 @@ elmWebComponents.register('component-with-ports', ComponentWithPorts, {
 
 This is useful for tidying up any event listeners you might have.
 
+## Handling errors
+
+If you want to catch any errors registering the component, you can pass `onSetupError`:
+
+```js
+elmWebComponents.register('component-with-ports', ComponentWithPorts, {
+  onSetupError: error => {
+    console.log('Something went wrong', error)
+  },
+})
+```
+
 ## Examples
 
 You can find full examples in the `example` directory. If you have cloned the repository, you can run `yarn run example` to run them locally.

src/index.js

@@ -41,7 +41,7 @@ const elmWebComponents = {
       staticFlags = {},
       onDetached = () => {},
       mapFlags = flags => flags,
-      onSetupError = () => {}
+      onSetupError,
     } = {}
   ) {
     if (!this.__elmVersion) {
@@ -62,13 +62,13 @@ const elmWebComponents = {
 
     class ElmElement extends HTMLElement {
       connectedCallback() {
-        const context = {};
+        const context = {}
         try {
           let props = Object.assign({}, getProps(this), staticFlags)
           if (Object.keys(props).length === 0) props = undefined
 
           const flags = mapFlags(props)
-          context.flags = flags;
+          context.flags = flags
 
           if (elmVersion === '0.19') {
             /* a change in Elm 0.19 means that ElmComponent.init now replaces the node you give it
@@ -90,8 +90,15 @@ const elmWebComponents = {
             setupPorts(elmElement.ports)
           }
         } catch (error) {
-          console.error(error)
-          onSetupError(error, context)
+          if (onSetupError) {
+            onSetupError(error, context)
+          } else {
+            console.error(
+              `Error from elm-web-components registering ${name}`,
+              'You can pass an `onSetupError` to handle these.',
+              error
+            )
+          }
         }
       }
 
@@ -100,7 +107,7 @@ const elmWebComponents = {
       }
     }
 
-    customElements.define(name, ElmElement);
+    customElements.define(name, ElmElement)
   },
 }