schema-components - v3.7.0
    Preparing search index...

    Interface FieldShellProps

    Render-time inputs to FieldShell. The shell does not depend on a theme; it consumes only the field metadata the walker has already produced.

    interface FieldShellProps {
        props: RenderProps;
        inputId: string;
        children: (ariaAttrs: Record<string, string>) => ReactNode;
        label?: string;
        hideLabel?: boolean;
    }
    Index

    Properties

    props inputId children label? hideLabel?

    Properties

    props: RenderProps

    The walked field props passed to the theme's render function.

    inputId: string

    Stable DOM id for the host input.

    children: (ariaAttrs: Record<string, string>) => ReactNode

    Children-as-function. Receives the ARIA attribute bundle so the caller can spread the attributes onto whatever element it produces; the shell does not inject them because the spread point varies between libraries (inputProps, top-level, slot props, …).

    label?: string

    Optional override for the label text. Defaults to props.meta.description when undefined.

    hideLabel?: boolean

    When true, suppress the wrapping <label> element. Useful for adapters whose host primitive (e.g. MUI's TextField) already renders its own label.

    Settings

    Member Visibility

    On This Page

    Properties