@bpmn-io/form-js-viewer 1.0.0 → 1.3.0-alpha.0

package/LICENSE

@@ -1,23 +1,23 @@
-Copyright (c) 2021-present Camunda Services GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in the
-Software without restriction, including without limitation the rights to use, copy,
-modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
-and to permit persons to whom the Software is furnished to do so, subject to the
-following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-The source code responsible for displaying the bpmn.io project watermark that
-links back to https://bpmn.io as part of rendered diagrams MUST NOT be
-removed or changed. When this software is being used in a website or application,
-the watermark must stay fully visible and not visually overlapped by other elements.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
-PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+Copyright (c) 2021-present Camunda Services GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in the
+Software without restriction, including without limitation the rights to use, copy,
+modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+The source code responsible for displaying the bpmn.io project watermark that
+links back to https://bpmn.io as part of rendered diagrams MUST NOT be
+removed or changed. When this software is being used in a website or application,
+the watermark must stay fully visible and not visually overlapped by other elements.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,164 +1,164 @@
-# @bpmn-io/form-js-viewer
-
-This library exports a form viewer for viewing and submitting forms. Use [our editor](../form-js-editor) to create and edit forms.
-
-
-## Installation
-
-```
-npm install @bpmn-io/form-js-viewer
-```
-
-
-## Usage
-
-```javascript
-import { Form } from '@bpmn-io/form-js-viewer';
-
-const schema = {
-  components: [
-    {
-      key: 'creditor',
-      label: 'Creditor',
-      type: 'textfield',
-      validate: {
-        required: true
-      }
-    }
-  ]
-};
-
-const data = {
-  creditor: 'John Doe Company'
-};
-
-const form = new Form({
-  container: document.querySelector('#form')
-});
-
-await form.importSchema(schema, data);
-
-// add event listeners
-form.on('submit', event => {
-  console.log('Form <submit>', event);
-});
-
-// provide a priority to event listeners
-form.on('changed', 500, event => {
-  console.log('Form <changed>', event);
-});
-```
-
-Check out [a full example](https://github.com/bpmn-io/form-js-examples).
-
-
-## Styling
-
-For proper styling include the `form-js.css` stylesheet and font used:
-
-```html
-<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,400;0,600;1,400&display=swap" rel="stylesheet">
-
-<link href="https://unpkg.com/@bpmn-io/form-js/dist/assets/form-js.css" rel="stylesheet">
-```
-
-
-## API
-
-### `Form`
-
-Create a new form with options `{ container?: HTMLElement }`.
-
-```javascript
-import { Form } from '@bpmn-io/form-js-viewer';
-
-const form = new Form({
-  container: document.querySelector('#form')
-});
-```
-
-
-### `Form#importSchema(schema: Schema, data?: Data) => Promise<Result, Error>`
-
-Display a form represented via a form schema and the optional data.
-
-```javascript
-try {
-  await form.importSchema(schema);
-} catch (err) {
-  console.log('importing form failed', err);
-}
-```
-
-
-### `Form#submit() => { data: Data, errors: Errors }`
-
-Submit a form programatically.
-
-```javascript
-const {
-  data,
-  errors
-} = form.submit();
-
-if (Object.keys(errors).length) {
-  console.error('Form submitted with errors', errors);
-}
-```
-
-
-### `Form#validate() => Errors`
-
-Validate a form programatically.
-
-```javascript
-const errors = form.validate();
-
-if (Object.keys(errors).length) {
-  console.error('Form has errors', errors);
-}
-```
-
-
-### `Form#reset() => void`
-
-Reset a form programatically.
-
-
-### `Form#setProperty(key, value) => void`
-
-Set a form property such as `readOnly`.
-
-
-### `Form#attachTo(parentNode: HTMLElement) => void`
-
-
-Attach the form to a parent node.
-
-
-### `Form#detach() => void`
-
-
-Detach the form from its parent node.
-
-
-### `Form#on(event, fn) => void`
-
-Subscribe to an [event](#events).
-
-
-### `Form#destroy() => void`
-
-Remove form from the document.
-
-
-## Events
-
-The form emits the `changed` and `submit` events you may hook into.
-
-Both events receive `{ data, errors }` as a payload.
-
-
-## License
-
-Use under the terms of the [bpmn.io license](http://bpmn.io/license).
+# @bpmn-io/form-js-viewer
+
+This library exports a form viewer for viewing and submitting forms. Use [our editor](../form-js-editor) to create and edit forms.
+
+
+## Installation
+
+```
+npm install @bpmn-io/form-js-viewer
+```
+
+
+## Usage
+
+```javascript
+import { Form } from '@bpmn-io/form-js-viewer';
+
+const schema = {
+  components: [
+    {
+      key: 'creditor',
+      label: 'Creditor',
+      type: 'textfield',
+      validate: {
+        required: true
+      }
+    }
+  ]
+};
+
+const data = {
+  creditor: 'John Doe Company'
+};
+
+const form = new Form({
+  container: document.querySelector('#form')
+});
+
+await form.importSchema(schema, data);
+
+// add event listeners
+form.on('submit', event => {
+  console.log('Form <submit>', event);
+});
+
+// provide a priority to event listeners
+form.on('changed', 500, event => {
+  console.log('Form <changed>', event);
+});
+```
+
+Check out [a full example](https://github.com/bpmn-io/form-js-examples).
+
+
+## Styling
+
+For proper styling include the `form-js.css` stylesheet and font used:
+
+```html
+<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,400;0,600;1,400&display=swap" rel="stylesheet">
+
+<link href="https://unpkg.com/@bpmn-io/form-js/dist/assets/form-js.css" rel="stylesheet">
+```
+
+
+## API
+
+### `Form`
+
+Create a new form with options `{ container?: HTMLElement }`.
+
+```javascript
+import { Form } from '@bpmn-io/form-js-viewer';
+
+const form = new Form({
+  container: document.querySelector('#form')
+});
+```
+
+
+### `Form#importSchema(schema: Schema, data?: Data) => Promise<Result, Error>`
+
+Display a form represented via a form schema and the optional data.
+
+```javascript
+try {
+  await form.importSchema(schema);
+} catch (err) {
+  console.log('importing form failed', err);
+}
+```
+
+
+### `Form#submit() => { data: Data, errors: Errors }`
+
+Submit a form programatically.
+
+```javascript
+const {
+  data,
+  errors
+} = form.submit();
+
+if (Object.keys(errors).length) {
+  console.error('Form submitted with errors', errors);
+}
+```
+
+
+### `Form#validate() => Errors`
+
+Validate a form programatically.
+
+```javascript
+const errors = form.validate();
+
+if (Object.keys(errors).length) {
+  console.error('Form has errors', errors);
+}
+```
+
+
+### `Form#reset() => void`
+
+Reset a form programatically.
+
+
+### `Form#setProperty(key, value) => void`
+
+Set a form property such as `readOnly`.
+
+
+### `Form#attachTo(parentNode: HTMLElement) => void`
+
+
+Attach the form to a parent node.
+
+
+### `Form#detach() => void`
+
+
+Detach the form from its parent node.
+
+
+### `Form#on(event, fn) => void`
+
+Subscribe to an [event](#events).
+
+
+### `Form#destroy() => void`
+
+Remove form from the document.
+
+
+## Events
+
+The form emits the `changed` and `submit` events you may hook into.
+
+Both events receive `{ data, errors }` as a payload.
+
+
+## License
+
+Use under the terms of the [bpmn.io license](http://bpmn.io/license).