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
+32 −0
Open

Document fieldset formwidget #258

Changes from all 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
32 changes: 32 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 parent form. They are only grouped visually within the `<fieldset>` tag, but will get submitted within the same array as the parent form in the POST data.

```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 purposes.

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 Expand Up @@ -1125,6 +1156,7 @@ Option | Description
`nestedform` - renders a nested form as the contents of this field and returns the form data as an array.

> **NOTE:** In order to use this with a model, the field should be defined as a `jsonable` attribute, or as another attribute that can handle storing arrayed data.
> **NOTE:** The fields defined in a nestedform are separate from the main(parent) form. They will get submitted within a nested array named after the nestedform field's name in the POST data.

```yaml
content:
Expand Down