Sanity Library Reference Docs
Preparing search index...
sanity
index
GlobalDocumentReferenceDefinition
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
)
BaseSchemaDefinition
GlobalDocumentReferenceDefinition
Index
Properties
deprecated?
description?
hidden?
icon?
initial
Value?
name
options?
read
Only?
resource
Id
resource
Type
studio
Url?
title?
to
type
validation?
weak?
Properties
Optional
deprecated
deprecated
?:
DeprecatedProperty
Optional
description
description
?:
string
|
Element
Optional
hidden
hidden
?:
ConditionalProperty
Optional
icon
icon
?:
ReactNode
|
ComponentType
<
{}
>
Optional
initial
Value
initialValue
?:
unknown
name
name
:
string
Optional
options
options
?:
ReferenceOptions
Optional
read
Only
readOnly
?:
ConditionalProperty
resource
Id
resourceId
:
string
resource
Type
resourceType
:
string
Optional
studio
Url
studioUrl
?:
string
|
(
(
document
:
{
id
:
string
;
type
?:
string
}
)
=>
string
)
Optional
title
title
?:
string
to
to
:
{
icon
?:
ComponentType
;
preview
?:
PreviewConfig
;
title
?:
string
;
type
:
string
;
}
[]
type
type
:
"globalDocumentReference"
Optional
validation
validation
?:
unknown
Optional
weak
weak
?:
boolean
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
deprecated
description
hidden
icon
initial
Value
name
options
read
Only
resource
Id
resource
Type
studio
Url
title
to
type
validation
weak
Sanity Library Reference Docs
Loading...