Sanity Library Reference Docs
    Preparing search index...

    Interface CrossDatasetReferenceDefinition

    interface CrossDatasetReferenceDefinition {
        components?: CrossDatasetReferenceComponents;
        dataset: string;
        deprecated?: DeprecatedProperty;
        description?: string | Element;
        hidden?: ConditionalProperty;
        icon?: ReactNode | ComponentType<{}>;
        initialValue?: unknown;
        name: string;
        options?: ReferenceOptions;
        projectId?: string;
        readOnly?: ConditionalProperty;
        studioUrl?: (document: { id: string; type?: string }) => string;
        title?: string;
        to: {
            __experimental_search?: {
                mapWith?: string;
                path: string | string[];
                weight?: number;
            }[];
            icon?: ComponentType;
            preview?: PreviewConfig;
            title?: string;
            type: string;
        }[];
        tokenId?: string;
        type: "crossDatasetReference";
        validation?: unknown;
        weak?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    components? dataset deprecated? description? hidden? icon? initialValue? name options? projectId? readOnly? studioUrl? title? to tokenId? type validation? weak?

    Properties

    components?: CrossDatasetReferenceComponents
    dataset: string
    deprecated?: DeprecatedProperty
    description?: string | Element
    hidden?: ConditionalProperty
    icon?: ReactNode | ComponentType<{}>
    initialValue?: unknown
    name: string
    options?: ReferenceOptions
    projectId?: string

    Cross-project references are no longer supported, only cross-dataset

    readOnly?: ConditionalProperty
    studioUrl?: (document: { id: string; type?: string }) => string
    title?: string
    to: {
        __experimental_search?: {
            mapWith?: string;
            path: string | string[];
            weight?: number;
        }[];
        icon?: ComponentType;
        preview?: PreviewConfig;
        title?: string;
        type: string;
    }[]

    Type declaration

    • Optional__experimental_search?: { mapWith?: string; path: string | string[]; weight?: number }[]

      Unused. Configuring search is no longer supported.

    • Optionalicon?: ComponentType
    • Optionalpreview?: PreviewConfig
    • Optionaltitle?: string
    • type: string
    tokenId?: string
    type: "crossDatasetReference"
    validation?: unknown
    weak?: boolean

    Settings

    Member Visibility

    On This Page

    Properties