Sanity Library Reference Docs
    Preparing search index...

    Interface CrossDatasetReferenceSchemaTypeBeta

    interface CrossDatasetReferenceSchemaType {
        __experimental_actions?: string[];
        __experimental_formPreviewTitle?: boolean;
        __experimental_omnisearch_visibility?: boolean;
        __experimental_search?: {
            mapWith?: string;
            path: (string | number)[];
            weight: number;
        }[];
        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>;
        };
        dataset: string;
        deprecated?: DeprecatedProperty;
        description?: string;
        fields: ObjectField<SchemaType>[];
        fieldsets?: Fieldset[];
        groups?: FieldGroup[];
        hidden?: ConditionalProperty;
        icon?: ComponentType;
        initialValue?: InitialValueProperty<any, Record<string, unknown>>;
        jsonType: "object";
        liveEdit?: boolean;
        name: string;
        options?: ReferenceFilterOptions;
        orderings?: SortOrdering[];
        placeholder?: string;
        preview?: PreviewConfig;
        readOnly?: ConditionalProperty;
        studioUrl?: (document: { id: string; type?: string }) => string;
        title?: string;
        to: CrossDatasetType[];
        type?: SchemaType;
        validation?: SchemaValidationValue;
        weak?: boolean;
    }

    Hierarchy

    Index

    Properties

    __experimental_actions?: string[]
    __experimental_formPreviewTitle?: boolean
    __experimental_omnisearch_visibility?: boolean
    __experimental_search?: {
        mapWith?: string;
        path: (string | number)[];
        weight: number;
    }[]

    Unused. Use the new field-level search config.

    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>;
    }
    dataset: string
    deprecated?: DeprecatedProperty
    description?: string
    fieldsets?: Fieldset[]
    groups?: FieldGroup[]
    icon?: ComponentType
    initialValue?: InitialValueProperty<any, Record<string, unknown>>
    jsonType: "object"
    liveEdit?: boolean
    name: string
    orderings?: SortOrdering[]
    placeholder?: string

    This will be removed.

    preview?: PreviewConfig
    studioUrl?: (document: { id: string; type?: string }) => string
    title?: string
    type?: SchemaType
    weak?: boolean