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

    Interface SchemaFieldProps<T, SchemaRef, P>

    Props accepted by SchemaField. The generic P constrains path to dot-paths reachable through the schema's inferred value type — typed schemas get autocomplete; runtime schemas fall back to string.

    interface SchemaFieldProps<
        T = unknown,
        SchemaRef extends string | undefined = undefined,
        P extends
            string =
            | PathOfType<InferSchemaType<T>>
            | (string extends PathOfType<InferSchemaType<T>> ? string : never),
    > {
        path: P;
        schema: RejectUnrepresentableZod<T>;
        schemaRef?: SchemaRef;
        value?: unknown;
        onChange?: (value: unknown) => void;
        meta?: SchemaMeta;
        validate?: boolean;
        onValidationError?: (error: unknown) => void;
    }

    Type Parameters

    Index

    Properties

    path schema schemaRef? value? onChange? meta? validate? onValidationError?

    Properties

    path: P
    schema: RejectUnrepresentableZod<T>
    schemaRef?: SchemaRef
    value?: unknown
    onChange?: (value: unknown) => void
    meta?: SchemaMeta
    validate?: boolean
    onValidationError?: (error: unknown) => void

    Settings

    Member Visibility

    On This Page

    Properties