Sanity Library Reference Docs
    Preparing search index...

    Interface ReferenceDefinition

    interface ReferenceDefinition {
        components?: ReferenceComponents;
        deprecated?: DeprecatedProperty;
        description?: string | Element;
        hidden?: ConditionalProperty;
        icon?: ReactNode | ComponentType<{}>;
        initialValue?: InitialValueProperty<any, Omit<Reference, "_type">>;
        name: string;
        options?: ReferenceOptions;
        readOnly?: ConditionalProperty;
        title?: string;
        to: ReferenceTo;
        type: "reference";
        validation?: ValidationBuilder<ReferenceRule, Reference>;
        weak?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    components?: ReferenceComponents
    deprecated?: DeprecatedProperty
    description?: string | Element
    icon?: ReactNode | ComponentType<{}>
    initialValue?: InitialValueProperty<any, Omit<Reference, "_type">>
    name: string
    title?: string
    type: "reference"
    weak?: boolean