Interface FieldsetComponentSchema

The fieldset component schema.

Fieldsets are used to manage group fields together. They can improve accessibility by grouping related fields together.

The key property has no effect on the submission data structure (it does not create a nesting level, the component is purely presentational).

The label is displayed as the legend element, while the upstream component uses an explicit legend property for this purpose.

Hierarchy

  • Omit<LayoutComponentSchema<never>, "placeholder" | "multiple" | "defaultValue" | "errors" | "description" | "hideLabel" | "disabled" | "validateOn">
    • FieldsetComponentSchema

Properties

clearOnHide?: boolean

If the value of this field should be cleared when it is conditionally hidden.

components: AnyComponentSchema[]

Nested components inside the group/fieldset.

conditional?: ConditionalOptions

Determines when this component should be added to the form for both processing and input.

hidden?: boolean

Determines if the component should be within the form, but not visible. This can be overridden with the conditionals.

hideHeader: boolean

Control whether the fieldset header/legend is displayed or not.

Deprecated

This should probably use the built-in hideLabel property instead, which requires a backend data migration and update to the SDK code.

id: string
key: string
label: string
openForms?: {
    translations: ComponentTranslations<"label">;
}

Type declaration

tooltip?: string
type: "fieldset"

Generated using TypeDoc