Skip to content

Document fieldset formwidget #258

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.

Sign up for GitHub

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

Open
mjauvin wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Document fieldset formwidget #258

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe83669
Document fieldset formwidget
mjauvin Feb 20, 2026
227f594
Apply suggestion from @LukeTowers
LukeTowers Feb 20, 2026
b91af19
Apply suggestion from @LukeTowers
LukeTowers Feb 20, 2026
018812d
add precisions for both fieldset/nestedform POST data behavior
mjauvin Feb 20, 2026
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
31 changes: 31 additions & 0 deletions backend/forms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,6 +791,7 @@ There are various form widgets included as standard, although it is common for p
- [Color picker](#color-picker)
- [Data table](#data-table)
- [Date picker](#date-picker)
- [Fieldset](#fieldset)
- [File upload](#file-upload)
- [Icon picker](#icon-picker)
- [Markdown editor](#markdown-editor)
Expand Down Expand Up @@ -1003,6 +1004,36 @@ Option | Description
`showWeekNumber` | show week numbers at head of row. Default: `false`
`ignoreTimezone` | store date and time exactly as it is displayed, ignoring the backend specified timezone preference.

### Fieldset

`fieldset` - renders a group of fields in a `<fieldset>` tag.

> **NOTE:** Contrary to the [nestedform](#nested-form), the fields defined in a fieldset are part of the main form. They are only grouped visually within the `<fieldset>` tag.
Copy link
Copy Markdown
Member

@LukeTowers LukeTowers Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mjauvin can you add a similar note to the nestedform section

Copy link
Copy Markdown
Member Author

@mjauvin mjauvin Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


```yaml
groupedFields:
type: fieldset
label: Grouped Fields
form:
fields:
name:
label: Your name
address:
label: Your address
phone:
label: Your phone
type: tel
website:
label: Your website URL
type: url
```

A fieldset provides a way of ***visually*** grouping fields. The form definition does not support tabs or secondary tabs as it is only used to define the fields for grouping purpose.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix grammatical error.

The phrase "for grouping purpose" should use the plural form "purposes".

📝 Proposed fix 
-A fieldset provides a way of ***visually*** grouping fields. The form definition does not support tabs or secondary tabs as it is only used to define the fields for grouping purpose.
+A fieldset provides a way of ***visually*** grouping fields. The form definition does not support tabs or secondary tabs as it is only used to define the fields for grouping purposes.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
A fieldset provides a way of ***visually*** grouping fields. The form definition does not support tabs or secondary tabs as it is only used to define the fields for grouping purpose.
A fieldset provides a way of ***visually*** grouping fields. The form definition does not support tabs or secondary tabs as it is only used to define the fields for grouping purposes.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@backend/forms.md` at line 1031, Fix the grammar in the sentence inside the
form description by changing the phrase "for grouping purpose" to "for grouping
purposes" so the sentence reads that the form definition is only used to define
the fields for grouping purposes; locate this text in the form description
string (the sentence starting "The form definition does not support tabs or
secondary tabs as it is only used to define the fields for grouping...") and
update the plural.


Option | Description
------------- | -------------
`form` | contains the [form definition](#defining-form-fields) used to define the grouped fields.

### File upload

`fileupload` - renders a file uploader for images or regular files.
Expand Down