OpenForm

FormFieldset

Last updated on

Logical grouping of fields rendered as a section

FormFieldset defines a logical grouping of fields that are rendered together as a section. Unlike FieldsetField (which is a field type with type: "fieldset"), FormFieldset is a top-level grouping construct with its own identifier.

Properties

id: string
Fieldset identifier (slug)
title?: string
Title/heading for the fieldset
description?: string
Description/help text for the fieldset
fields: Record<string, FormField>
Map of field identifiers to field definitions
required?: boolean
Whether completion of the entire fieldset is required
order?: number
Display order hint (lower numbers first)

FormFieldset vs FieldsetField

TypeUsageLocation
FormFieldsetTop-level section grouping with its own idStandalone grouping construct
FieldsetFieldNested field with type: "fieldset"Inside form.fields record

Use FormFieldset when you need a named section with explicit ordering. Use FieldsetField when you want nested fields within the form's field hierarchy.

Examples

fieldsets:
  - id: personal-info
    title: Personal Information
    description: Basic contact details
    order: 1
    required: true
    fields:
      firstName:
        type: text
        label: First Name
        required: true
      lastName:
        type: text
        label: Last Name
        required: true
      email:
        type: email
        label: Email Address
        required: true

  - id: employment
    title: Employment Details
    description: Current employment information
    order: 2
    fields:
      employer:
        type: text
        label: Employer Name
      jobTitle:
        type: text
        label: Job Title
      annualIncome:
        type: money
        label: Annual Income

Related

  • FormField - Field definitions including FieldsetField
  • Form - Form artifact overview

On this page