Sanity Library Reference Docs
Preparing search index...
sanity
index
ReferenceDefinition
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
)
BaseSchemaDefinition
ReferenceDefinition
Index
Properties
components?
deprecated?
description?
hidden?
icon?
initial
Value?
name
options?
read
Only?
title?
to
type
validation?
weak?
Properties
Optional
Beta
components
components
?:
ReferenceComponents
Hidden
Optional
deprecated
deprecated
?:
DeprecatedProperty
Optional
description
description
?:
string
|
Element
Optional
hidden
hidden
?:
ConditionalProperty
Optional
icon
icon
?:
ReactNode
|
ComponentType
<
{}
>
Optional
initial
Value
initialValue
?:
InitialValueProperty
<
any
,
Omit
<
Reference
,
"_type"
>
>
name
name
:
string
Optional
options
options
?:
ReferenceOptions
Optional
read
Only
readOnly
?:
ConditionalProperty
Optional
title
title
?:
string
to
to
:
ReferenceTo
type
type
:
"reference"
Optional
validation
validation
?:
ValidationBuilder
<
ReferenceRule
,
Reference
>
Optional
weak
weak
?:
boolean
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
components
deprecated
description
hidden
icon
initial
Value
name
options
read
Only
title
to
type
validation
weak
Sanity Library Reference Docs
Loading...
Hidden