Sanity Library Reference Docs
    Preparing search index...

    Interface GlobalDocumentReferenceDefinition

    interface GlobalDocumentReferenceDefinition {
        deprecated?: DeprecatedProperty;
        description?: string | Element;
        hidden?: ConditionalProperty;
        icon?: ReactNode | ComponentType<{}>;
        initialValue?: unknown;
        name: string;
        options?: ReferenceOptions;
        readOnly?: ConditionalProperty;
        resourceId: string;
        resourceType: string;
        studioUrl?: string | ((document: { id: string; type?: string }) => string);
        title?: string;
        to: {
            icon?: ComponentType;
            preview?: PreviewConfig;
            title?: string;
            type: string;
        }[];
        type: "globalDocumentReference";
        validation?: unknown;
        weak?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    deprecated?: DeprecatedProperty
    description?: string | Element
    icon?: ReactNode | ComponentType<{}>
    initialValue?: unknown
    name: string
    resourceId: string
    resourceType: string
    studioUrl?: string | ((document: { id: string; type?: string }) => string)
    title?: string
    to: {
        icon?: ComponentType;
        preview?: PreviewConfig;
        title?: string;
        type: string;
    }[]
    type: "globalDocumentReference"
    validation?: unknown
    weak?: boolean