@open-formulieren/types
    Preparing search index...

    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.

    interface FieldsetComponentSchema {
        clearOnHide?: boolean;
        components: AnyComponentSchema[];
        conditional?: OFConditionalOptions;
        hidden?: boolean;
        hideHeader: boolean;
        id: string;
        key: string;
        label: string;
        openForms?: { translations: ComponentTranslations<TK> };
        tooltip?: string;
        type: "fieldset";
    }

    Hierarchy

    • Omit<
          LayoutComponentSchema<never>,

              | "placeholder"
              | "multiple"
              | "defaultValue"
              | "errors"
              | "description"
              | "hideLabel"
              | "disabled"
              | "validateOn",
      >
      • FieldsetComponentSchema
    Index

    Properties

    clearOnHide? components conditional? hidden? hideHeader id key label openForms? tooltip? type

    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?: OFConditionalOptions

    Dynamically determines if the component is visible/available.

    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.

    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

    The data key for this component (how the data is stored in the database, referenced as API key in docs).

    label: string

    The HTML label to give this component.

    openForms?: { translations: ComponentTranslations<TK> }
    tooltip?: string
    type: "fieldset"

    The type of component

    Settings

    Member Visibility

    On This Page

    Properties