Form editor
Embed the editor that lets a user build and change the form of an existing form Item.
The Form editor widget opens one form Item so the user can arrange its components, bind them to the fields of a table, and set them up. The widget saves each change to the Item itself, with no save button. The rest of the contract (credential, error) is in Widgets.
URL and parameters
The URL is <site>/widgets/form-editor.
| Parameter | Meaning | Required |
|---|---|---|
item_id | The id of the form Item to edit. The user must be allowed to edit this Item. | Yes |
The form Item must already exist. The widget edits a form that is there and does not create an Item. Create the form Item through the API first.
Messages
| action | Direction | Payload |
|---|---|---|
error | widget to your page | { statusCode } when the form Item cannot be read, for example 403 or 404. |
This widget takes no post-widget-parameters, so it sends no ready and has no other message. Even after it has saved the form, the widget does not tell your page. If you need to know, read the form Item through the API.
Example
Continuing the example in Widgets, change the widget name to form-editor and set item_id to the id of the form Item.
Notes
- The widget saves only when the form has a name. A form with no name is not saved.
- The widget saves when the user has stopped editing for half a second. If the user closes the page right after an edit, the last change can be lost.
- A user who may not edit the Item cannot open the editor. Check the permissions of the token you use.
- The user fills in the finished form with the Form widget.