@theredhead — Frontend Library - v1.0.0
    Preparing search index...

    Interface PropertyFieldDefinition<T>

    Definition for a single property field in a UIPropertySheet.

    interface PropertyFieldDefinition<T = Record<string, unknown>> {
        group?: string;
        key: string & keyof T;
        label: string;
        max?: number;
        min?: number;
        options?: readonly SelectOption[];
        placeholder?: string;
        readonly?: boolean;
        step?: number;
        type: PropertyFieldType;
    }

    Type Parameters

    • T = Record<string, unknown>

      The data object type.

    Index

    Properties

    group? key label max? min? options? placeholder? readonly? step? type

    Properties

    group?: string

    Category/group name. Fields with the same group are rendered together under a shared heading.

    key: string & keyof T

    The key on the data object this field reads/writes.

    label: string

    Human-readable label.

    max?: number

    Maximum value for 'number' / 'slider' fields.

    min?: number

    Minimum value for 'number' / 'slider' fields.

    options?: readonly SelectOption[]

    Options for 'select' fields.

    placeholder?: string

    Placeholder text (string / number fields).

    readonly?: boolean

    Whether this field is read-only.

    step?: number

    Step for 'number' / 'slider' fields.

    type: PropertyFieldType

    Editor type.

    Settings

    Member Visibility

    On This Page

    Properties