Sanity Library Reference Docs
    Preparing search index...

    Interface ArraySchemaType<V>

    Make all properties in T optional

    interface ArraySchemaType<V = unknown> {
        components?: {
            annotation?: ComponentType<any>;
            block?: ComponentType<any>;
            diff?: ComponentType<any>;
            field?: ComponentType<any>;
            inlineBlock?: ComponentType<any>;
            input?: ComponentType<any>;
            item?: ComponentType<any>;
            portableText?: { plugins?: ComponentType<any> };
            preview?: ComponentType<any>;
        };
        deprecated?: DeprecatedProperty;
        description?: string;
        hidden?: ConditionalProperty;
        icon?: ComponentType;
        initialValue?: any;
        jsonType: "array";
        liveEdit?: boolean;
        name: string;
        of: (
            | BooleanSchemaType
            | FileSchemaType
            | NumberSchemaType
            | ObjectSchemaType
            | StringSchemaType
            | ReferenceSchemaType
        )[];
        options?: ArrayOptions<V> & { layout?: V extends string ? "tag" : "grid" };
        placeholder?: string;
        preview?: PreviewConfig;
        readOnly?: ConditionalProperty;
        title?: string;
        type?: SchemaType;
        validation?: SchemaValidationValue;
    }

    Type Parameters

    • V = unknown

    Hierarchy (View Summary)

    Index

    Properties

    components?: {
        annotation?: ComponentType<any>;
        block?: ComponentType<any>;
        diff?: ComponentType<any>;
        field?: ComponentType<any>;
        inlineBlock?: ComponentType<any>;
        input?: ComponentType<any>;
        item?: ComponentType<any>;
        portableText?: { plugins?: ComponentType<any> };
        preview?: ComponentType<any>;
    }
    deprecated?: DeprecatedProperty
    description?: string
    icon?: ComponentType
    initialValue?: any
    jsonType: "array"
    liveEdit?: boolean
    name: string
    of: (
        | BooleanSchemaType
        | FileSchemaType
        | NumberSchemaType
        | ObjectSchemaType
        | StringSchemaType
        | ReferenceSchemaType
    )[]
    options?: ArrayOptions<V> & { layout?: V extends string ? "tag" : "grid" }
    placeholder?: string

    This will be removed.

    preview?: PreviewConfig
    title?: string
    type?: SchemaType