update docs

This commit is contained in:
burnettk 2024-01-10 18:47:35 -05:00
parent 12f929f777
commit 14f2107b91
No known key found for this signature in database
1 changed files with 31 additions and 18 deletions

View File

@ -42,19 +42,21 @@ To create forms inside editor, we utilize user tasks within the BPMN file.
Upon creating a new BPMN file, open it to access the editor. Upon creating a new BPMN file, open it to access the editor.
**Initiating the Form Editor** **Initiating the Form Editor**
- In the editor, proceed to the "Web form" section. Navigate to the "Web form" section. If starting from scratch, launch the editor and name your file (e.g., "demo"). After saving, it will automatically generate three essential files for us: a schema, UI settings, and some example data. - In the editor, proceed to the "Web form" section. Navigate to the "Web form" section. If starting from scratch, launch the editor and name your file (e.g., "demo"). After saving, it will automatically generate three essential files for us: a schema, UI settings, and some example data.
![Form Editor](images/Form_editor.png) ![Form Editor](images/Form_editor.png)
**Understanding the Three Core Files** **Understanding the Three Core Files**
- **JSON Schema**: This file describes the form. It allows you to define titles, property names, and more. As you make changes in this file, they will reflect in the form preview window. This schema outlines the properties or data points you aim to collect. - **JSON Schema**: This file describes the form. It allows you to define titles, property names, and more. As you make changes in this file, they will reflect in the form preview window. This schema outlines the properties or data points you aim to collect.
![Form Editor](images/Form_editor1.png) ![Form Editor](images/Form_editor1.png)
- **UI Settings**: This file offers customization options for your form. You can edit descriptions, titles, and more. Changes made here are reflected in real-time on the form. - **UI Settings**: This file offers customization options for your form. You can edit descriptions, titles, and more. Changes made here are reflected in real-time on the form.
![Form Editor](images/Form_editor2.png) ![Form Editor](images/Form_editor2.png)
- **Data View**: This section displays the data users input into the form. It provides a preview of what will be captured when the form is submitted. Both the data view and the form stay synchronized, ensuring consistency. - **Data View**: This section displays the data users input into the form. It provides a preview of what will be captured when the form is submitted. Both the data view and the form stay synchronized, ensuring consistency.
![Form Editor](images/Form_editor3.png) ![Form Editor](images/Form_editor3.png)
**Adding and Customizing Form Elements** **Adding and Customizing Form Elements**
@ -64,7 +66,6 @@ For instance, you can set the UI widget correctly for each element, ensuring it
![Form Editor](images/Form_editor4.png) ![Form Editor](images/Form_editor4.png)
## SpiffArena react-jsonschema-form enhancements ## SpiffArena react-jsonschema-form enhancements
SpiffArena has enhanced the capabilities of react-jsonschema-form to provide users with more dynamic and flexible form-building options. SpiffArena has enhanced the capabilities of react-jsonschema-form to provide users with more dynamic and flexible form-building options.
@ -156,7 +157,7 @@ For instance, you can require that a date must be equal to or greater than anoth
- To implement date validation compared to another date, use the your JSON schema and specify the date field to compare with using the "minimumDate" property with a format like "field:field_name:start_or_end." - To implement date validation compared to another date, use the your JSON schema and specify the date field to compare with using the "minimumDate" property with a format like "field:field_name:start_or_end."
- "start_or_end" can be either "start" or "end". - "start_or_end" can be either "start" or "end".
You can choose to use end if the reference field is part of a range. You can choose to use end if the reference field is part of a range.
This is an example where end_date must be after start_date: This is an example where end_date must be after start_date:
@ -178,18 +179,26 @@ Perhaps, you want to let a user fill out a name, and have First Name and Last Na
Don't actually do this; use Full name as a single field. :) Don't actually do this; use Full name as a single field. :)
But in some other case where you actually want to have fields laid out horizontally instead of vertically, do the following: But in some other case where you actually want to have fields laid out horizontally instead of vertically, do the following:
Example form schema: Example form schema:
{ {
"title": "Side by side",
"description": "A simple form demonstrating side-by-side layout of fields",
"type": "object",
"properties": {
"firstName": { "firstName": {
"type": "string", "type": "string"
}, },
lastName": { "lastName": {
"type": "string", "type": "string"
},
"notes": {
"type": "string"
}
} }
} }
Example uiSchema: Example uiSchema:
{ {
"ui:layout": [ "ui:layout": [
@ -204,13 +213,16 @@ But in some other case where you actually want to have fields laid out horizonta
"md": 2, "md": 2,
"lg": 4 "lg": 4
} }
},
{
"notes": {}
} }
] ]
} }
In this case, we are saying that we want firstName and lastName in the same row, since there is only one "row" in the UI layout (one element of the array). In this case, we are saying that we want firstName and lastName in the same row, since they are both in the first element of the ui:layout array.
We are saying that firstName should take up 4 columns when a large display is used. We are saying that firstName should take up 4 columns when a large display is used.
The lastName also takes up 4 columns, which fills up the whole row, which has 8 columns available for large displays. The lastName also takes up 4 columns, so the two of them together fill up the whole row, which has 8 columns available for large displays.
Medium displays have 5 columns available and small displays have 4. Medium displays have 5 columns available and small displays have 4.
If you just specific a uiSchema like this, it will figure out the column widths for you: If you just specific a uiSchema like this, it will figure out the column widths for you:
@ -278,6 +290,7 @@ To incorporate the markdown widget into your rjsf form, follow these steps:
```json ```json
"ui:widget": "markdown" "ui:widget": "markdown"
``` ```
![rsjf markdown](images/rsjf_markdown.png) ![rsjf markdown](images/rsjf_markdown.png)
### Numeric Range Field ### Numeric Range Field