Member Junction
    Preparing search index...

    Interface ComponentProperty

    Definition of a single property of a component.

    interface ComponentProperty {
        constraints?: PropertyConstraint[];
        defaultValue?: any;
        description: string;
        name: string;
        possibleValues?: string[];
        required: boolean;
        type: string;
    }
    Index

    Properties

    constraints? defaultValue? description name possibleValues? required type

    Properties

    constraints?: PropertyConstraint[]

    Optional constraints that validate this property's value at lint-time. Used to catch errors early by validating prop values against business rules.

    defaultValue?: any

    The default value, if any, for this property if it is not provided.

    description: string

    A description of what this property is used for

    name: string

    The name of the property

    possibleValues?: string[]

    Optional list of possible values for this property.

    required: boolean

    Indicates if this property is required for the component to function correctly. If true, the component will not work without this property being set.

    type: string

    The type of the property. It can be one of 'string', 'number', 'boolean', 'object', 'array', 'function', or 'any'. For complex types, use extended syntax like "Array<string | ColumnDef>". These types are for aligning users of the component. Components are in JavaScript and do not actually enforce types at runtime, but this is used to provide guidance for users (AI and Human)

    Settings

    Member Visibility

    On This Page

    Properties