Sanity Library Reference Docs
Preparing search index...
sanity
index
Module index
Functions
buildLegacyTheme
createSanityMediaLibraryFileSource
createSanityMediaLibraryImageSource
defineArrayMember
defineAssetAspect
defineField
defineLocale
defineLocaleResourceBundle
defineSearchFilter
defineSearchFilterOperators
defineSearchOperator
defineType
documentIdEquals
EditPortal
FormBuilder
FormProvider
getDocumentVariantType
Hotkeys
isCrossDatasetReference
isDocumentSchemaType
isGlobalDocumentReference
isImage
isKeyedObject
isPortableTextListBlock
isPortableTextSpan
isPortableTextTextBlock
isSanityDefinedAction
isSanityDocument
isSlug
isTypedObject
PortableTextInput
StudioLayout
Translate
useCanvasCompanionDoc
useClient
useColorSchemeSetValue
useColorSchemeValue
useCurrentLocale
useCurrentUser
useDataset
useDateTimeFormat
useDocumentVersionTypeSortedList
useFormattedDuration
useFormValue
useGetFormValue
useListFormat
useNumberFormat
useOnlyHasVersions
usePerspective
useProjectId
useReferringDocuments
userHasRole
useSchema
useTranslation
useUnitFormatter
useUserListWithPermissions
useWorkspaceSchemaId
validateDocument
Interfaces
ArrayDefinition
ArrayOfObjectsFormNode
ArrayOfPrimitivesFormNode
ArrayOptions
ArrayRule
ArraySchemaType
Asset
AssetSchemaTypeOptions
AssetSource
AssetSourceComponentProps
AssetSourceSpec
AssetSourceUploader
AssetSourceUploadFile
AuthConfig
AuthProvider
BaseItemProps
BaseSchemaDefinition
BaseSchemaType
BaseSchemaTypeOptions
BlockAnnotationDefinition
BlockAnnotationProps
BlockDecoratorDefinition
BlockDecoratorProps
BlockDefinition
BlockListDefinition
BlockListItemProps
BlockMarksDefinition
BlockOptions
BlockProps
BlockRule
BlockStyleDefinition
BlockStyleProps
BooleanDefinition
BooleanOptions
BooleanRule
BooleanSchemaType
CanvasAppOptions
CollapseOptions
ConditionalPropertyCallbackContext
ConfigContext
CrossDatasetReferenceDefinition
CrossDatasetReferenceSchemaType
CrossDatasetReferenceValue
CrossDatasetType
CurrentUser
CustomValidator
DateDefinition
DateOptions
DateRule
DatetimeDefinition
DatetimeOptions
DatetimeRule
DefineSchemaOptions
DeprecatedProperty
DeprecationConfiguration
DocumentDefinition
DocumentOptions
DocumentRule
EmailDefinition
EmailOptions
EmailRule
EmptyProps
EnumListProps
FieldDefinitionBase
FieldError
FieldGroup
FieldMember
FieldReference
FieldSetMember
File
FileAsset
FileDefinition
FileOptions
FileRule
FileSchemaType
FileValue
FormattedDuration
FormBuilderProps
FormNodeValidation
FormProviderProps
GeopointDefinition
GeopointOptions
GeopointRule
GeopointValue
GetHookCollectionStateProps
GlobalDocumentReferenceDefinition
GlobalDocumentReferenceSchemaType
GlobalDocumentReferenceType
GlobalDocumentReferenceValue
HookCollectionActionHook
HotspotOptions
HotspotPreview
I18nTitledListValue
Image
ImageAsset
ImageCrop
ImageDefinition
ImageDimensions
ImageHotspot
ImageMetadata
ImageOptions
ImagePalette
ImageRule
ImageSchemaType
ImageSwatch
ImageValue
InitialValueResolverContext
InitialValueTemplateItem
IntrinsicDefinitions
KeyedObject
LegacyThemeProps
Locale
LocaleConfigContext
LocaleDefinition
LocalePluginOptions
LocaleResourceBundle
LocaleResourceRecord
LocaleSource
LocaleWeekInfo
LocalizedValidationMessages
MediaLibraryAssetAspectDocument
MediaLibraryConfig
MediaValidationValue
MediaValidator
MultiFieldSet
NumberDefinition
NumberOptions
NumberRule
NumberSchemaType
ObjectArrayFormNode
ObjectDefinition
ObjectField
ObjectFormNode
ObjectItemProps
ObjectOptions
ObjectRule
ObjectSchemaType
OperatorButtonValueComponentProps
OperatorInputComponentProps
PerspectiveContextValue
PluginOptions
PortableTextInputProps
PortableTextListBlock
PortableTextObject
PortableTextPluginsProps
PortableTextSpan
PortableTextTextBlock
PrepareViewOptions
PreviewConfig
PreviewValue
PrimitiveItemProps
Reference
ReferenceBaseOptions
ReferenceDefinition
ReferenceFilterQueryOptions
ReferenceFilterResolverContext
ReferenceFilterResolverOptions
ReferenceRule
ReferenceSchemaType
Role
Rule
RuleDef
SanityCreateOptions
SanityDocument
SanityDocumentLike
SanityFormConfig
ScheduledPublishingPluginOptions
Schema
SchemaValidationError
SearchConfiguration
SearchOperatorBase
SearchOperatorBuilder
SingleFieldSet
Slug
SlugDefinition
SlugOptions
SlugRule
SlugSchemaType
SlugSourceContext
SlugValidationContext
SlugValue
SortOrderingItem
Source
SourceClientOptions
StringDefinition
StringOptions
StringRule
StringSchemaType
StudioTheme
Template
TemplateFieldDefinition
TemplateItem
TemplateReferenceTarget
TextDefinition
TextOptions
TextRule
TextSchemaType
TitledListValue
Tool
TranslationProps
TypeAliasDefinition
TypedObject
TypeReference
TypeTarget
UriValidationOptions
UrlDefinition
UrlOptions
UrlRule
UseFormattedDurationOptions
UseListFormatOptions
User
UserListWithPermissionsOptions
UseTranslationOptions
ValidateDocumentOptions
ValidationContext
ValidationError
ValidationMarker
ValuelessSearchOperatorBuilder
WeakCrossDatasetReferenceValue
WeakGlobalDocumentReferenceValue
WidenInitialValue
WidenValidation
Workspace
Variables
AvatarSkeleton
CommentsProvider
MEDIA_LIBRARY_ASSET_ASPECT_TYPE_NAME
ScheduleAction
ScheduledBadge
searchStrategies
Namespaces
ScheduleAction
Type Aliases
AppsOptions
ArrayActionName
ArrayOfEntry
ArrayOfType
AssetFromSource
AssetMetadataType
AssetSourceUploaderClass
AssetSourceUploadEvent
AssetSourceUploadEventAbort
AssetSourceUploadEventAllComplete
AssetSourceUploadEventError
AssetSourceUploadEventProgress
AssetSourceUploadEventStatus
AssetSourceUploadSubscriber
AutocompleteString
BooleanFormNode
ComposableOption
ConditionalProperty
ConditionalPropertyCallback
CrossDatasetReferenceFilterResolver
CrossDatasetReferenceFilterSearchOptions
CustomValidatorResult
DefaultPluginsWorkspaceOptions
DefineArrayMemberBase
DefineSchemaBase
DefineSchemaType
DeprecatedSchemaType
DocumentField
DocumentRevision
DocumentVariantType
DuplicateKeysError
FieldDefinition
FieldGroupDefinition
FieldRules
Fieldset
FieldsetDefinition
FormattableMeasurementUnit
GeneralPreviewLayoutKey
GlobalDocumentReferenceFilterResolver
GlobalDocumentReferenceFilterSearchOptions
HotkeysProps
I18nSearchOperatorDescriptionKey
I18nSearchOperatorNameKey
I18nTextRecord
ImageMetadataType
ImplicitLocaleResourceBundle
IncompatibleTypeError
IndexTuple
InitialValueProperty
InitialValueResolver
InlineFieldDefinition
IntrinsicArrayOfBase
IntrinsicArrayOfDefinition
IntrinsicBase
IntrinsicTypeName
ItemProps
KeyedSegment
LocaleNestedResource
LocaleResourceKey
LocalesBundlesOption
LocalesOption
LoginMethod
MapDocument
MaybeAllowUnknownProps
MaybePreview
MediaAssetTypes
MediaLibraryAssetAspectDefinition
MediaLibraryAssetAspectSupportedFieldDefinitions
MediaLibraryAssetAspectTypeName
MediaLibraryAssetType
MissingKeysError
MixedArrayError
NarrowPreview
NumberFormNode
ObjectFieldType
ObjectItem
ObjectMember
Path
PathSegment
PerspectiveStack
PortableTextBlock
PortableTextChild
PortableTextPreviewLayoutKey
PreviewLayoutKey
ReferenceFilterOptions
ReferenceFilterResolver
ReferenceFilterSearchOptions
ReferenceOptions
ReferenceTo
ReferenceValue
ReleaseId
RuleBuilder
RuleSpec
RuleTypeConstraint
SchemaType
SchemaTypeDefinition
SchemaValidationValue
SearchFilterDefinition
SearchOperatorButtonValue
SearchOperatorInput
SearchOperatorParams
SearchOperatorType
SearchStrategy
SearchValueFormatterContext
SelectedPerspective
SlugifierFn
SlugIsUniqueValidator
SlugParent
SlugSourceFn
SortOrdering
StaticLocaleResourceBundle
StrictDefinition
StringFormNode
StudioThemeColorSchemeKey
SwatchName
TemplateArrayFieldDefinition
TemplateParameter
TemplateResolver
TranslateComponentMap
TypeAnnotationMismatchError
UndeclaredMembersError
UnitFormatter
UseDateTimeFormatOptions
UseNumberFormatOptions
UseTranslationResponse
UseUnitFormatterOptions
ValidationBuilder
ValuelessSearchOperatorParams
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Functions
build
Legacy
Theme
create
Sanity
Media
Library
File
Source
create
Sanity
Media
Library
Image
Source
define
Array
Member
define
Asset
Aspect
define
Field
define
Locale
define
Locale
Resource
Bundle
define
Search
Filter
define
Search
Filter
Operators
define
Search
Operator
define
Type
document
Id
Equals
Edit
Portal
Form
Builder
Form
Provider
get
Document
Variant
Type
Hotkeys
is
Cross
Dataset
Reference
is
Document
Schema
Type
is
Global
Document
Reference
is
Image
is
Keyed
Object
is
Portable
Text
List
Block
is
Portable
Text
Span
is
Portable
Text
Text
Block
is
Sanity
Defined
Action
is
Sanity
Document
is
Slug
is
Typed
Object
Portable
Text
Input
Studio
Layout
Translate
use
Canvas
Companion
Doc
use
Client
use
Color
Scheme
Set
Value
use
Color
Scheme
Value
use
Current
Locale
use
Current
User
use
Dataset
use
Date
Time
Format
use
Document
Version
Type
Sorted
List
use
Formatted
Duration
use
Form
Value
use
Get
Form
Value
use
List
Format
use
Number
Format
use
Only
Has
Versions
use
Perspective
use
Project
Id
use
Referring
Documents
user
Has
Role
use
Schema
use
Translation
use
Unit
Formatter
use
User
List
With
Permissions
use
Workspace
Schema
Id
validate
Document
Interfaces
Array
Definition
Array
Of
Objects
Form
Node
Array
Of
Primitives
Form
Node
Array
Options
Array
Rule
Array
Schema
Type
Asset
Asset
Schema
Type
Options
Asset
Source
Asset
Source
Component
Props
Asset
Source
Spec
Asset
Source
Uploader
Asset
Source
Upload
File
Auth
Config
Auth
Provider
Base
Item
Props
Base
Schema
Definition
Base
Schema
Type
Base
Schema
Type
Options
Block
Annotation
Definition
Block
Annotation
Props
Block
Decorator
Definition
Block
Decorator
Props
Block
Definition
Block
List
Definition
Block
List
Item
Props
Block
Marks
Definition
Block
Options
Block
Props
Block
Rule
Block
Style
Definition
Block
Style
Props
Boolean
Definition
Boolean
Options
Boolean
Rule
Boolean
Schema
Type
Canvas
App
Options
Collapse
Options
Conditional
Property
Callback
Context
Config
Context
Cross
Dataset
Reference
Definition
Cross
Dataset
Reference
Schema
Type
Cross
Dataset
Reference
Value
Cross
Dataset
Type
Current
User
Custom
Validator
Date
Definition
Date
Options
Date
Rule
Datetime
Definition
Datetime
Options
Datetime
Rule
Define
Schema
Options
Deprecated
Property
Deprecation
Configuration
Document
Definition
Document
Options
Document
Rule
Email
Definition
Email
Options
Email
Rule
Empty
Props
Enum
List
Props
Field
Definition
Base
Field
Error
Field
Group
Field
Member
Field
Reference
Field
Set
Member
File
File
Asset
File
Definition
File
Options
File
Rule
File
Schema
Type
File
Value
Formatted
Duration
Form
Builder
Props
Form
Node
Validation
Form
Provider
Props
Geopoint
Definition
Geopoint
Options
Geopoint
Rule
Geopoint
Value
Get
Hook
Collection
State
Props
Global
Document
Reference
Definition
Global
Document
Reference
Schema
Type
Global
Document
Reference
Type
Global
Document
Reference
Value
Hook
Collection
Action
Hook
Hotspot
Options
Hotspot
Preview
I18n
Titled
List
Value
Image
Image
Asset
Image
Crop
Image
Definition
Image
Dimensions
Image
Hotspot
Image
Metadata
Image
Options
Image
Palette
Image
Rule
Image
Schema
Type
Image
Swatch
Image
Value
Initial
Value
Resolver
Context
Initial
Value
Template
Item
Intrinsic
Definitions
Keyed
Object
Legacy
Theme
Props
Locale
Locale
Config
Context
Locale
Definition
Locale
Plugin
Options
Locale
Resource
Bundle
Locale
Resource
Record
Locale
Source
Locale
Week
Info
Localized
Validation
Messages
Media
Library
Asset
Aspect
Document
Media
Library
Config
Media
Validation
Value
Media
Validator
Multi
Field
Set
Number
Definition
Number
Options
Number
Rule
Number
Schema
Type
Object
Array
Form
Node
Object
Definition
Object
Field
Object
Form
Node
Object
Item
Props
Object
Options
Object
Rule
Object
Schema
Type
Operator
Button
Value
Component
Props
Operator
Input
Component
Props
Perspective
Context
Value
Plugin
Options
Portable
Text
Input
Props
Portable
Text
List
Block
Portable
Text
Object
Portable
Text
Plugins
Props
Portable
Text
Span
Portable
Text
Text
Block
Prepare
View
Options
Preview
Config
Preview
Value
Primitive
Item
Props
Reference
Reference
Base
Options
Reference
Definition
Reference
Filter
Query
Options
Reference
Filter
Resolver
Context
Reference
Filter
Resolver
Options
Reference
Rule
Reference
Schema
Type
Role
Rule
Rule
Def
Sanity
Create
Options
Sanity
Document
Sanity
Document
Like
Sanity
Form
Config
Scheduled
Publishing
Plugin
Options
Schema
Schema
Validation
Error
Search
Configuration
Search
Operator
Base
Search
Operator
Builder
Single
Field
Set
Slug
Slug
Definition
Slug
Options
Slug
Rule
Slug
Schema
Type
Slug
Source
Context
Slug
Validation
Context
Slug
Value
Sort
Ordering
Item
Source
Source
Client
Options
String
Definition
String
Options
String
Rule
String
Schema
Type
Studio
Theme
Template
Template
Field
Definition
Template
Item
Template
Reference
Target
Text
Definition
Text
Options
Text
Rule
Text
Schema
Type
Titled
List
Value
Tool
Translation
Props
Type
Alias
Definition
Typed
Object
Type
Reference
Type
Target
Uri
Validation
Options
Url
Definition
Url
Options
Url
Rule
Use
Formatted
Duration
Options
Use
List
Format
Options
User
User
List
With
Permissions
Options
Use
Translation
Options
Validate
Document
Options
Validation
Context
Validation
Error
Validation
Marker
Valueless
Search
Operator
Builder
Weak
Cross
Dataset
Reference
Value
Weak
Global
Document
Reference
Value
Widen
Initial
Value
Widen
Validation
Workspace
Variables
Avatar
Skeleton
Comments
Provider
MEDIA_
LIBRARY_
ASSET_
ASPECT_
TYPE_
NAME
Schedule
Action
Scheduled
Badge
search
Strategies
Namespaces
Schedule
Action
Type Aliases
Apps
Options
Array
Action
Name
Array
Of
Entry
Array
Of
Type
Asset
From
Source
Asset
Metadata
Type
Asset
Source
Uploader
Class
Asset
Source
Upload
Event
Asset
Source
Upload
Event
Abort
Asset
Source
Upload
Event
All
Complete
Asset
Source
Upload
Event
Error
Asset
Source
Upload
Event
Progress
Asset
Source
Upload
Event
Status
Asset
Source
Upload
Subscriber
Autocomplete
String
Boolean
Form
Node
Composable
Option
Conditional
Property
Conditional
Property
Callback
Cross
Dataset
Reference
Filter
Resolver
Cross
Dataset
Reference
Filter
Search
Options
Custom
Validator
Result
Default
Plugins
Workspace
Options
Define
Array
Member
Base
Define
Schema
Base
Define
Schema
Type
Deprecated
Schema
Type
Document
Field
Document
Revision
Document
Variant
Type
Duplicate
Keys
Error
Field
Definition
Field
Group
Definition
Field
Rules
Fieldset
Fieldset
Definition
Formattable
Measurement
Unit
General
Preview
Layout
Key
Global
Document
Reference
Filter
Resolver
Global
Document
Reference
Filter
Search
Options
Hotkeys
Props
I18n
Search
Operator
Description
Key
I18n
Search
Operator
Name
Key
I18n
Text
Record
Image
Metadata
Type
Implicit
Locale
Resource
Bundle
Incompatible
Type
Error
Index
Tuple
Initial
Value
Property
Initial
Value
Resolver
Inline
Field
Definition
Intrinsic
Array
Of
Base
Intrinsic
Array
Of
Definition
Intrinsic
Base
Intrinsic
Type
Name
Item
Props
Keyed
Segment
Locale
Nested
Resource
Locale
Resource
Key
Locales
Bundles
Option
Locales
Option
Login
Method
Map
Document
Maybe
Allow
Unknown
Props
Maybe
Preview
Media
Asset
Types
Media
Library
Asset
Aspect
Definition
Media
Library
Asset
Aspect
Supported
Field
Definitions
Media
Library
Asset
Aspect
Type
Name
Media
Library
Asset
Type
Missing
Keys
Error
Mixed
Array
Error
Narrow
Preview
Number
Form
Node
Object
Field
Type
Object
Item
Object
Member
Path
Path
Segment
Perspective
Stack
Portable
Text
Block
Portable
Text
Child
Portable
Text
Preview
Layout
Key
Preview
Layout
Key
Reference
Filter
Options
Reference
Filter
Resolver
Reference
Filter
Search
Options
Reference
Options
Reference
To
Reference
Value
Release
Id
Rule
Builder
Rule
Spec
Rule
Type
Constraint
Schema
Type
Schema
Type
Definition
Schema
Validation
Value
Search
Filter
Definition
Search
Operator
Button
Value
Search
Operator
Input
Search
Operator
Params
Search
Operator
Type
Search
Strategy
Search
Value
Formatter
Context
Selected
Perspective
Slugifier
Fn
Slug
Is
Unique
Validator
Slug
Parent
Slug
Source
Fn
Sort
Ordering
Static
Locale
Resource
Bundle
Strict
Definition
String
Form
Node
Studio
Theme
Color
Scheme
Key
Swatch
Name
Template
Array
Field
Definition
Template
Parameter
Template
Resolver
Translate
Component
Map
Type
Annotation
Mismatch
Error
Undeclared
Members
Error
Unit
Formatter
Use
Date
Time
Format
Options
Use
Number
Format
Options
Use
Translation
Response
Use
Unit
Formatter
Options
Validation
Builder
Valueless
Search
Operator
Params
Sanity Library Reference Docs
Loading...