Open Forms TS types
    Preparing search index...

    Interface ColumnsComponentSchema

    Component shape/options for a columns component.

    The generated documentation might be slightly off due to rendering the type alias as an interface. Double check with the actual TS types!

    interface ColumnsComponentSchema {
        clearOnHide?: boolean;
        columns: Column[];
        id: string;
        key: string;
        type: "columns";
    }
    Index

    Properties

    clearOnHide?: boolean

    Clear the value (remove the key from the submission data) when the field is hidden. This is applied if the component itself or any parent is hidden, irrespective the mechanism that made it hidden.

    Related: hidden, conditional.

    columns: Column[]

    The columns to display side-by-side, each with their configured size.

    id: string

    Unique ID for a component in a form definition. Used to render HTML IDs.

    The new renderer does not need this.

    key: string

    Unique key for the component in a larger form definition.

    The value must comply with the (\w|\w[\w.\-]*\w) regex, meaning that periods/dots are allowed unless they're start or end. The period character creates a nesting level in the submission data.

    'myField'
    
    'parent.child' // creates `{parent: {child: <value}}` data.
    
    type: "columns"

    Discriminator to determine the component type. Uniquely determines the shape of the component configuration options.