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

    Interface EditGridComponentSchema

    The editgrid component schema.

    Edit grids ("repeating groups") are used as a blueprint for array values with complex nested structures (as opposed to textfield with multiple true) inside.

    The nested components describe a single group of fields that are repeated for every item. Because of that, the defaultValue type cannot be statically defined, as it is derived from the dynamic configuration.

    Edit grids are essentially always 'multiple: true', so this property does not apply to this component type either.

    interface EditGridComponentSchema {
        addAnother?: string;
        clearOnHide?: boolean;
        components: AnyComponentSchema[];
        conditional?: OFConditionalOptions;
        defaultValue?: unknown[];
        description?: string;
        disableAddingRemovingRows: boolean;
        groupLabel: string;
        hidden?: boolean;
        hideLabel?: boolean;
        id: string;
        isSensitiveData?: boolean;
        key: string;
        label: string;
        openForms?: { translations: ComponentTranslations<TK> };
        removeRow?: string;
        saveRow?: string;
        tooltip?: string;
        type: "editgrid";
        validate?: OFValidateOptions<Validator>;
    }

    Hierarchy

    Index

    Properties

    addAnother? clearOnHide? components conditional? defaultValue? description? disableAddingRemovingRows groupLabel hidden? hideLabel? id isSensitiveData? key label openForms? removeRow? saveRow? tooltip? type validate?

    Properties

    addAnother?: string

    Button label to add another item.

    clearOnHide?: boolean

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

    components: AnyComponentSchema[]

    Nested components inside the group.

    conditional?: OFConditionalOptions

    Dynamically determines if the component is visible/available.

    defaultValue?: unknown[]

    The default value of this compoennt.

    description?: string
    disableAddingRemovingRows: boolean

    Control whether any rows can be added or removed.

    groupLabel: string

    Label for an individual item, interpolated with the index of each item.

    hidden?: boolean

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

    hideLabel?: boolean
    id: string
    isSensitiveData?: boolean
    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> }
    removeRow?: string

    Button label to remove a single item.

    saveRow?: string

    Button label to save/confirm a single item.

    tooltip?: string
    type: "editgrid"
    validate?: OFValidateOptions<Validator>

    Settings

    Member Visibility

    On This Page

    Properties