Sanity Library Reference Docs
    Preparing search index...

    Interface SystemVariant

    interface SystemVariant {
        _createdAt: string;
        _id: `_.variants.${string}`;
        _rev: string;
        _system?: Partial<DocumentSystem>;
        _type: "system.variant";
        _updatedAt: string;
        conditions: Record<string, string>;
        metadata?: {
            description?: PortableTextBlock[];
            title?: string;
            type?: string;
            [key: string]: unknown;
        };
        name?: string;
        priority: number;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    _createdAt _id _rev _system? _type _updatedAt conditions metadata? name? priority

    Properties

    _createdAt

    _createdAt: string

    _id

    _id: `_.variants.${string}`

    _rev

    _rev: string

    Optional_system

    _system?: Partial<DocumentSystem>

    System-managed attributes. Which fields are present depends on the document (e.g. variants/scopeId only exist on version documents, and documents predating the _system migration may carry only some of them), hence the partial shape.

    _type

    _type: "system.variant"

    _updatedAt

    _updatedAt: string
    conditions: Record<string, string>
    metadata?: {
        description?: PortableTextBlock[];
        title?: string;
        type?: string;
        [key: string]: unknown;
    }

    Type declaration

    • [key: string]: unknown
    • Optionaldescription?: PortableTextBlock[]
    • Optionaltitle?: string
    • Optionaltype?: string

      Variant type key. Missing values are read as variant.

    name?: string
    priority: number

    Settings

    Member Visibility

    On This Page

    Properties