Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update FORM command docs #116

Merged
merged 3 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 105 additions & 18 deletions docs/050-command-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -853,25 +853,112 @@ If it isn't, the block is not inserted
**Parameters**:

- Block reference pointing to the Form Configuration. The Form Configuration should be a tree
- The root of the tree will be the form label
- fields - a tree of fields to include in the form
- name - the name of each field. When the form is submitted, this name is used for the output variable
- type - The type of field. The following values are supported
- text
- number
- select
- page
- block
- flag
- embed
- label - The label describing the field to the user
- default - The default value the field should have
- output - what to do once the form is submitted. The supported values are:
- fields - a tree of fields to include in the form
- name - the name of each field. When the form is submitted, this name is used for the output variable
- type - The type of field. The following values are supported
- text
- number
- select
- page
- block
- variables
- submit - the text assigned to the submit button
- cancel - the text assigned to the cancel button
- The form config supports nested smartblock commands.
- flag
- embed
- autocomplete
- label - The label describing the field to the user
- default - The default value the field should have
- options - For `select` and `autocomplete` types, specifies the options available for selection.
- conditional - Specifies a field `name` that this field depends on to be displayed.
- conditionalValues - Specifies the values of the conditional field for which this field will be displayed.
- output - what to do once the form is submitted. The supported values are:
- block
- variables
- submit - the text assigned to the submit button
- cancel - the text assigned to the cancel button

\*The form config supports nested SmartBlock commands.

**Example Form**

```
- Example Form
- fields
- This is Some Text
- type
- text
- label
- Text Field
- This is a Number
- type
- number
- label
- Number Field
- Just a Label
- type
- label
- label
- Text Field
- Like a checkbox
- type
- flag
- label
- Flag Field
- This is text that is conditional on the checkbox
- type
- text
- label
- Conditional Text Field
- conditional
- Like a checkbox
- This searches all pages
- type
- page
- label
- Page Field
- This searches all blocks
- type
- block
- label
- Block Field
- This is a multiple choice
- type
- select
- label
- Select Field
- options
- apple
- banana
- orange
- conditional select 1
- This is a conditional text field based on the multiple choice
- type
- text
- label
- Conditional Text Field
- conditional
- This is a multiple choice
- conditionalValues
- conditional select 1
- orange
- This is an autocomplete field
- type
- autocomplete
- label
- Autocomplete Field
- options:
- apple
- banana
- orange
- This is like a roam block
- type
- embed
- label
- Embed Field
```

```
- Form #SmartBlock
- <%FORM:((S2MbRYozb))%>
```

**Embed Default**

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "smartblocks",
"version": "1.7.1",
"version": "1.7.2",
"description": "Create custom and programmable templates from within Roam!",
"main": "./build/main.js",
"scripts": {
Expand Down
Loading