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

    Interface HtmlRenderProps

    Props for HTML render functions. Extends BaseRenderProps with a narrower three-argument renderChild and no onChange — HTML rendering is pure output with no event handling.

    interface HtmlRenderProps {
        value: unknown;
        readOnly: boolean;
        writeOnly: boolean;
        meta: SchemaMeta;
        constraints: AllConstraints;
        path: string;
        examples?: unknown[];
        tree: WalkedField;
        renderChild: (
            tree: WalkedField,
            value: unknown,
            pathSuffix?: string,
        ) => string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    value readOnly writeOnly meta constraints path examples? tree renderChild

    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.

    renderChild: (tree: WalkedField, value: unknown, pathSuffix?: string) => string

    Render a child field to an HTML string. Theme adapters call this to recursively render nested structures.

    Type Declaration

      • (tree: WalkedField, value: unknown, pathSuffix?: string): string

      • Parameters

        • tree: WalkedField

          The walked field tree for the child

        • value: unknown

          The child's current value

        • OptionalpathSuffix: string

          Path segment from the parent (e.g. "city", "[0]"). When omitted, the child's description is used as fallback.

        Returns string

    Settings

    Member Visibility

    On This Page

    Properties