Libraries
    Preparing search index...

    Type Alias FieldProps<TSchema>

    type FieldProps<TSchema extends ObjectSchemaBuilder<any, any, any>> = {
        fieldProps?: Record<string, unknown>;
        form: SchemaFormInstance<TSchema>;
        forProperty: (
            tree: PropertyDescriptorTree<TSchema, TSchema>,
        ) => PropertyDescriptor<TSchema, any, any>;
        label?: string;
        name?: string;
        renderer?: FieldRenderer;
        variant?: string;
    }

    Type Parameters

    • TSchema extends ObjectSchemaBuilder<any, any, any>
    Index

    Properties

    fieldProps? form forProperty label? name? renderer? variant?

    Properties

    fieldProps?: Record<string, unknown>

    Bag of extra renderer-specific props forwarded to the renderer via FieldRenderProps.fieldProps (e.g. placeholder, autoComplete).

    form: SchemaFormInstance<TSchema>
    forProperty: (
        tree: PropertyDescriptorTree<TSchema, TSchema>,
    ) => PropertyDescriptor<TSchema, any, any>
    label?: string

    Visible label text forwarded to the renderer via FieldRenderProps.label.

    name?: string

    HTML name attribute forwarded to the renderer via FieldRenderProps.name.

    renderer?: FieldRenderer
    variant?: string

    Rendering variant hint. Participates in renderer resolution: the registry is checked for "type:variant" (e.g. "string:password") before falling back to the base "type" key. Also forwarded to the renderer via FieldRenderProps.variant.

    Settings

    Member Visibility

    On This Page

    Properties