@bpmn-io/form-js - npm Package Compare versions

Comparing version 0.2.3 to 0.2.4

CHANGELOG.md

@@ -9,2 +9,10 @@ # Changelog
 
+## 0.2.4
+
+* `FIX`: make options optional when creating `Form` and `FormEditor` instances ([`8d9e09ae`](https://github.com/bpmn-io/form-js/commit/8d9e09ae410cbfe42a8e11a2371e45df9d926fd0))
+* `FIX`: import `schemaVersion` ([`05622a95`](https://github.com/bpmn-io/form-js/commit/05622a9568787a8c6f2fce79c60c7ff01f2b6083))
+* `FIX`: ensure `required` works with empty string ([`0279c4c4`](https://github.com/bpmn-io/form-js/commit/0279c4c4e55a0d6c3cb7d57a6818b15ecd6a583e))
+* `DOCS`: document new usage patterns ([#106](https://github.com/bpmn-io/form-js/issues/106))
+* `DOCS`: document editor API ([#24](https://github.com/bpmn-io/form-js/issues/24))
+
 ## 0.2.3
@@ -11,0 +19,0 @@

package.json

 {
   "name": "@bpmn-io/form-js",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "View and edit forms - powered by bpmn.io",
@@ -53,4 +53,4 @@ "exports": {
   "dependencies": {
-    "@bpmn-io/form-js-editor": "^0.2.3",
-    "@bpmn-io/form-js-viewer": "^0.2.3"
+    "@bpmn-io/form-js-editor": "^0.2.4",
+    "@bpmn-io/form-js-viewer": "^0.2.4"
   },
@@ -63,3 +63,3 @@ "sideEffects": [
   ],
-  "gitHead": "a3c25a7709b89ab6ab613c498c3e02fced3accb5"
+  "gitHead": "b4764afdaefaeaf9bae4924cff713552592222eb"
 }

README.md

@@ -1,25 +0,26 @@
-# form-js - Forms powered by bpmn.io
+# @bpmn-io/form-js
 
 [![CI](https://github.com/bpmn-io/form-js/workflows/CI/badge.svg)](https://github.com/bpmn-io/form-js/actions?query=workflow%3ACI)
 
-[View](../form-js-viewer) and edit JSON-based forms.
+[View](../form-js-viewer) and [edit](../form-js-editor) JSON-based forms.
 
 
+
 ## Usage
 
-This library exports a form viewer.
+This library exports a [form viewer](./packages/form-js-viewer) and [editor](./packages/form-js-editor).
 
-### Display a Form
+### Display a Form <a id="viewer" />
 
-Renders a form based on [a form schema](../../docs/FORM_SCHEMA.md) and existing data:
+Renders a form based on [a form schema](./docs/FORM_SCHEMA.md) and existing data:
 
 ```javascript
-import { createForm } from '@bpmn-io/form-js';
+import { Form } from '@bpmn-io/form-js';
 
-const form = createForm({
-  schema,
-  data,
+const form = new Form({
   container: document.querySelector('#form')
 });
 
+await form.importSchema(schema, data);
+
 form.on('submit', (event) => {
@@ -30,7 +31,25 @@ console.log(event.data, event.errors);
 
-See [viewer documentation](../form-js-viewer) for further details.
+See [viewer documentation](./packages/form-js-viewer) for further details.
 
 
+### Create and Edit a Form <a id="builder" />
+
+Create a new form or edit an exsting one:
+
+```javascript
+import { FormEditor } from '@bpmn-io/form-js';
+
+const formEditor = new FormEditor({
+  container: document.querySelector('#form-editor')
+});
+
+await formEditor.importSchema(schema);
+```
+
+See [editor documentation](./packages/form-js-editor) for further details.
+
+
 ## Resources
 
+* [Demo](https://demo.bpmn.io/form)
 * [Issues](https://github.com/bpmn-io/form-js/issues)
@@ -37,0 +56,0 @@ * [Changelog](../form-js/CHANGELOG.md)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

317341

increased by0.32%

Number of lines in readme file

62

increased by44.19%

Worsened metrics

Lines of code

8794

decreased by-0.1%

Dependency changes

• Updated@bpmn-io/form-js-editor@^0.2.4

• Updated@bpmn-io/form-js-viewer@^0.2.4