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

    Interface BaseFieldProps

    Properties available on every schema field, regardless of rendering target. Both React and HTML renderers receive these.

    Per-type schema data — enum values, object fields, array element schema, union options, record key/value types, tuple prefixItems, conditional if/then/else clauses, negation negated, recursive refTarget, literal values — lives on the discriminated tree. Renderers narrow on tree.type and read from the matching variant; there are no duplicate sibling fields on these props.

    interface BaseFieldProps {
        value: unknown;
        readOnly: boolean;
        writeOnly: boolean;
        meta: SchemaMeta;
        constraints: AllConstraints;
        path: string;
        examples?: unknown[];
        tree: WalkedField;
    }

    Hierarchy (View Summary)

    Index

    Properties

    value readOnly writeOnly meta constraints path examples? tree

    Properties

    value: unknown

    Current field value.

    readOnly: boolean

    Whether to render as read-only display.

    writeOnly: boolean

    Whether to render as an empty input.

    meta: SchemaMeta

    Schema metadata for this field.

    constraints: AllConstraints

    Constraints from schema checks.

    path: string

    Dot-separated path from root (e.g. "address.city").

    examples?: unknown[]

    Example values from the schema's examples keyword.

    tree: WalkedField

    Walked field tree for recursive rendering.

    Settings

    Member Visibility

    On This Page

    Properties