Sanity Library Reference Docs
Preparing search index...
sanity
index
Module index
Namespaces
ScheduleAction
Classes
ArrayOfPrimitivesInput
PatchEvent
Timeline
TimelineController
Interfaces
ActionComponent
ActiveToolLayoutProps
AddonDatasetContextValue
ApiConfig
ArrayDefinition
ArrayFieldProps
ArrayInputCopyEvent
ArrayInputFunctionsProps
ArrayInputInsertEvent
ArrayInputMoveItemEvent
ArrayItemError
ArrayOfObjectsComponents
ArrayOfObjectsFormNode
ArrayOfObjectsInputProps
ArrayOfObjectsItemMember
ArrayOfPrimitivesComponents
ArrayOfPrimitivesFieldProps
ArrayOfPrimitivesFormNode
ArrayOfPrimitivesInputProps
ArrayOfPrimitivesItemMember
ArrayOptions
ArrayRule
ArraySchemaType
Asset
AssetSchemaTypeOptions
AssetSource
AssetSourceComponentProps
AssetSourceSpec
AssetSourceUploader
AssetSourceUploadFile
AuthConfig
AuthProvider
AuthState
AuthStore
BaseActionDescription
BaseEvent
BaseFieldProps
BaseFormNode
BaseInputProps
BaseItemProps
BaseOptions
BaseSchemaDefinition
BaseSchemaType
BaseSchemaTypeOptions
BlockAnnotationDefinition
BlockAnnotationProps
BlockDecoratorDefinition
BlockDecoratorProps
BlockDefinition
BlockListDefinition
BlockListItemProps
BlockMarksDefinition
BlockOptions
BlockProps
BlockRule
BlockStyleDefinition
BlockStyleProps
BooleanComponents
BooleanDefinition
BooleanFieldProps
BooleanInputProps
BooleanOptions
BooleanRule
BooleanSchemaType
CanvasAppOptions
CollapseOptions
CombinedDocument
CommentBaseCreatePayload
CommentContext
CommentDocument
CommentFieldCreatePayload
CommentOperations
CommentPath
CommentReactionItem
CommentReactionOption
CommentsIntentProviderProps
CommentsListBreadcrumbItem
CommentsTextSelectionItem
CommentTaskCreatePayload
CommentTextSelection
CommentThreadItem
CommentUpdateOperationOptions
CommittedEvent
ComplexElementProps
ConditionalPropertyCallbackContext
ConfigContext
CopyOptions
CopyPasteContextType
CreateDocumentVersionEvent
CreateLiveDocumentEvent
CrossDatasetReferenceComponents
CrossDatasetReferenceDefinition
CrossDatasetReferenceSchemaType
CrossDatasetReferenceValue
CrossDatasetType
CurrentUser
CustomValidator
DateComponents
DateDefinition
DateOptions
DateRule
DatetimeComponents
DatetimeDefinition
DatetimeOptions
DatetimeRule
DecisionParametersConfig
DecorationMember
DefaultPreviewProps
DefineSchemaOptions
DeleteDocumentGroupEvent
DeleteDocumentVersionEvent
DeprecatedProperty
DeprecationConfiguration
DocumentActionComponent
DocumentActionConfirmDialogProps
DocumentActionCustomDialogComponentProps
DocumentActionDescription
DocumentActionModalDialogProps
DocumentActionPopoverDialogProps
DocumentActionProps
DocumentActionsContext
DocumentBadgeComponent
DocumentBadgeDescription
DocumentBadgeProps
DocumentBadgesContext
DocumentCommentsEnabledContext
DocumentComponents
DocumentDefinition
DocumentFieldAction
DocumentFieldActionDivider
DocumentFieldActionGroup
DocumentFieldActionHook
DocumentFieldActionItem
DocumentFieldActionProps
DocumentFieldActionsResolverContext
DocumentInspector
DocumentInspectorContext
DocumentInspectorMenuItem
DocumentInspectorProps
DocumentInspectorUseMenuItemProps
DocumentLanguageFilterContext
DocumentMeta
DocumentMutationEvent
DocumentOptions
DocumentPluginOptions
DocumentPreviewStore
DocumentRebaseEvent
DocumentRemoteMutationEvent
DocumentRule
DocumentStackAvailability
DocumentStore
DocumentVersion
DraftsModelDocument
DraftsModelDocumentAvailability
DuplicateActionProps
DuplicateDocumentActionComponent
EditDocumentVersionEvent
EditStateFor
EmailComponents
EmailDefinition
EmailOptions
EmailRule
EmptyProps
EnumListProps
EventsStoreRevision
FieldDefinitionBase
FieldError
FieldGroup
FieldMember
FieldReference
FieldSetMember
FieldsetState
File
FileAsset
FileComponents
FileDefinition
FileLike
FileOptions
FileRule
FileSchemaType
FileValue
FormattedDuration
FormBuilderContextValue
FormBuilderProps
FormComponents
FormDecPatch
FormDiffMatchPatch
FormDocumentValue
FormFieldGroup
FormIncPatch
FormInsertPatch
FormNodePresence
FormNodeValidation
FormPatchBase
FormProviderProps
FormSetIfMissingPatch
FormSetPatch
FormUnsetPatch
GeopointComponents
GeopointDefinition
GeopointOptions
GeopointRule
GeopointValue
GetHookCollectionStateProps
GlobalDocumentReferenceDefinition
GlobalDocumentReferenceSchemaType
GlobalDocumentReferenceType
GlobalDocumentReferenceValue
GrantsStore
GroupableActionDescription
HistoryClearedEvent
HistoryStore
HookCollectionActionHook
HotspotOptions
HotspotPreview
I18nTitledListValue
Image
ImageAsset
ImageComponents
ImageCrop
ImageDefinition
ImageDimensions
ImageHotspot
ImageMetadata
ImageOptions
ImagePalette
ImageRule
ImageSchemaType
ImageSwatch
ImageValue
InitialValueErrorMsg
InitialValueLoadingMsg
InitialValueOptions
InitialValueResolverContext
InitialValueSuccessMsg
InitialValueTemplateItem
InputOnSelectFileFunctionProps
InsertMenuOptions
IntrinsicDefinitions
KeyedObject
LayoutProps
LegacyThemeProps
ListenQueryOptions
Loadable
Locale
LocaleConfigContext
LocaleDefinition
LocalePluginOptions
LocaleResourceBundle
LocaleResourceRecord
LocaleSource
LocaleWeekInfo
LocalizedValidationMessages
LogoProps
MediaLibraryAssetAspectDocument
MediaLibraryConfig
MediaLibraryFilter
MediaLibraryOptions
MediaValidationValue
MediaValidator
MemberItemProps
MissingConfigFile
MultiFieldSet
MutationPatchMsg
MutationPayload
NavbarProps
NewDocumentOptionsContext
NodeChronologyProps
NodeDiffProps
NumberComponents
NumberDefinition
NumberFieldProps
NumberInputProps
NumberOptions
NumberRule
NumberSchemaType
ObjectArrayFormNode
ObjectComponents
ObjectDefinition
ObjectField
ObjectFieldProps
ObjectFormNode
ObjectInputProps
ObjectItemProps
ObjectOptions
ObjectRule
ObjectSchemaType
ObserveDocumentAvailabilityFn
ObservePathsFn
OnPathFocusPayload
OperationError
OperationSuccess
OperatorButtonValueComponentProps
OperatorInputComponentProps
PasteOptions
PatchChannel
PatchMsgSubscriber
PermissionCheckResult
PerspectiveContextValue
PluginOptions
PortableTextInputProps
PortableTextListBlock
PortableTextMarker
PortableTextObject
PortableTextPluginsProps
PortableTextSpan
PortableTextTextBlock
PreparedSnapshot
PrepareViewOptions
PresenceStore
PreviewConfig
PreviewMediaDimensions
PreviewProps
PreviewValue
PrimitiveInputElementProps
PrimitiveItemProps
PrimitiveMemberItemProps
ProjectData
ProjectDatasetData
ProjectStore
ProvenanceDiffAnnotation
PublishDocumentVersionEvent
RebasePatchMsg
ReconnectEvent
Reference
ReferenceBaseOptions
ReferenceComponents
ReferenceDefinition
ReferenceFilterQueryOptions
ReferenceFilterResolverContext
ReferenceFilterResolverOptions
ReferenceRule
ReferenceSchemaType
ReleaseActionComponent
ReleaseActionDescription
ReleaseActionProps
RenderBlockActionsProps
RenderPreviewCallbackProps
ResolveProductionUrlContext
Role
RovingFocusProps
Rule
RuleDef
SanityClipboardItem
SanityCreateOptions
SanityDocument
SanityDocumentLike
SanityFormConfig
ScheduleDocumentVersionEvent
ScheduledPublishingPluginOptions
Schema
SchemaPluginOptions
SchemaValidationError
SearchConfiguration
SearchOperatorBase
SearchOperatorBuilder
SingleFieldSet
Slug
SlugComponents
SlugDefinition
SlugOptions
SlugRule
SlugSchemaType
SlugSourceContext
SlugValidationContext
SlugValue
SnapshotEvent
SortOrderingItem
Source
SourceClientOptions
SourceOptions
SpanComponents
SpanDefinition
StateTree
StringComponents
StringDefinition
StringFieldProps
StringInputProps
StringOptions
StringRule
StringSchemaType
StudioComponents
StudioComponentsPluginOptions
StudioProps
StudioProviderProps
StudioTheme
Template
TemplateFieldDefinition
TemplateItem
TemplatePreviewProps
TemplateReferenceTarget
TextComponents
TextDefinition
TextOptions
TextRule
TextSchemaType
TimelineOptions
TitledListValue
Tool
ToolLinkProps
ToolMenuProps
Transaction
TranslationProps
TypeAliasDefinition
TypedObject
TypeReference
TypeTarget
UnpublishDocumentEvent
UnscheduleDocumentVersionEvent
UpdateLiveDocumentEvent
UploadEvent
UriValidationOptions
UrlComponents
UrlDefinition
UrlOptions
UrlRule
UseFormattedDurationOptions
UseListFormatOptions
User
UserAvatarProps
UserListWithPermissionsOptions
UserStore
UserWithPermission
UseTranslationOptions
ValidateDocumentOptions
ValidationContext
ValidationError
ValidationMarker
ValuelessSearchOperatorBuilder
WeakCrossDatasetReferenceValue
WeakGlobalDocumentReferenceValue
WelcomeEvent
WidenInitialValue
WidenValidation
Workspace
WorkspaceOptions
Type Aliases
Annotation
AnnotationDetails
AppsOptions
ArrayActionName
ArrayOfEntry
ArrayOfObjectsMember
ArrayOfPrimitivesElementType
ArrayOfPrimitivesMember
ArrayOfType
AssetAccessPolicy
AssetFromSource
AssetMetadataType
AssetSourceResolver
AssetSourcesResolver
AssetSourceUploaderClass
AssetSourceUploadEvent
AssetSourceUploadEventAbort
AssetSourceUploadEventAllComplete
AssetSourceUploadEventError
AssetSourceUploadEventProgress
AssetSourceUploadEventStatus
AssetSourceUploadSubscriber
AsyncComposableOption
AutocompleteString
BlockImagePreviewProps
BooleanFormNode
BufferedDocumentEvent
Chunk
ChunkType
CommentCreatePayload
CommentIntentGetter
CommentListBreadcrumbs
CommentMessage
CommentPostPayload
CommentReactionShortNames
CommentStatus
CommentsType
CommentsUIMode
CommentUpdatePayload
CompactPreviewProps
ComposableOption
ComputeDiff
ConditionalProperty
ConditionalPropertyCallback
Config
CrossDatasetReferenceFilterResolver
CrossDatasetReferenceFilterSearchOptions
CrossDatasetReferenceInputProps
CustomValidatorResult
DateInputProps
DateTimeInputProps
DefaultPluginsWorkspaceOptions
DefineArrayMemberBase
DefineSchemaBase
DefineSchemaType
DeprecatedSchemaType
DetailPreviewProps
DocumentActionDialogProps
DocumentActionGroup
DocumentActionsResolver
DocumentActionsVersionType
DocumentAvailability
DocumentBadgesResolver
DocumentField
DocumentFieldActionNode
DocumentFieldActionsResolver
DocumentFieldActionStatus
DocumentFieldActionTone
DocumentGroupEvent
DocumentInspectorComponent
DocumentInspectorsResolver
DocumentLanguageFilterComponent
DocumentLanguageFilterResolver
DocumentRemoteMutationVersionEvent
DocumentRevision
DocumentValuePermission
DocumentVariantType
DocumentVersionEvent
DuplicateKeysError
EmailInputProps
FieldDefinition
FieldGroupDefinition
FieldName
FieldProps
FieldRules
Fieldset
FieldsetDefinition
FieldsetMembers
FieldsetRenderMembersCallback
FileInputProps
FormattableMeasurementUnit
FormBuilderCustomMarkersComponent
FormBuilderInputComponentMap
FormBuilderMarkersComponent
FormInsertPatchPosition
FormPatch
FormPatchJSONValue
FormPatchOrigin
GeneralDocumentListLayoutKey
GeneralPreviewLayoutKey
GlobalDocumentReferenceFilterResolver
GlobalDocumentReferenceFilterSearchOptions
HotkeysProps
I18nSearchOperatorDescriptionKey
I18nSearchOperatorNameKey
I18nTextRecord
ImageInputProps
ImageMetadataType
ImplicitLocaleResourceBundle
IncompatibleTypeError
IndexTuple
InitialValueMsg
InitialValueProperty
InitialValueResolver
InlineFieldDefinition
InlinePreviewProps
InputProps
IntrinsicArrayOfBase
IntrinsicArrayOfDefinition
IntrinsicBase
IntrinsicTypeName
InvalidationChannelEvent
InvalidItemTypeError
ItemProps
KeyedSegment
LocaleNestedResource
LocaleResourceKey
LocalesBundlesOption
LocalesOption
LoginComponentProps
LoginMethod
MapDocument
MarkdownConfig
MaybeAllowUnknownProps
MaybePreview
MediaAssetTypes
MediaLibraryAssetAspectDefinition
MediaLibraryAssetAspectSupportedFieldDefinitions
MediaLibraryAssetAspectTypeName
MediaLibraryAssetType
MediaPreviewProps
MissingKeysError
MixedArrayError
MutationResult
NarrowPreview
NewDocumentCreationContext
NewDocumentOptionsResolver
NumberFormNode
ObjectFieldType
ObjectItem
ObjectMember
ObjectRenderMembersCallback
ObserveForPreviewFn
Pair
ParsedTimeRef
PartialContext
PatchArg
PatchMsg
Path
PathSegment
PerspectiveStack
Plugin
PluginFactory
PortableTextBlock
PortableTextChild
PortableTextPreviewLayoutKey
Previewable
PreviewableType
PreviewComponent
PreviewLayoutKey
PreviewPath
PrimitiveFormNode
PrimitiveInputProps
ProjectGrants
QueryParams
ReferenceFilterOptions
ReferenceFilterResolver
ReferenceFilterSearchOptions
ReferenceInputProps
ReferenceOptions
ReferenceTo
ReferenceValue
ReleaseActionsContext
ReleaseActionsResolver
ReleaseId
RemoteSnapshotEvent
RemoteSnapshotVersionEvent
RenderAnnotationCallback
RenderArrayOfObjectsItemCallback
RenderArrayOfPrimitivesItemCallback
RenderBlockActionsCallback
RenderBlockCallback
RenderCustomMarkers
RenderFieldCallback
RenderInputCallback
RenderItemCallback
RenderPreviewCallback
ResolvedUploader
RovingFocusNavigationType
RuleBuilder
RuleSpec
RuleTypeConstraint
SchemaType
SchemaTypeDefinition
SchemaValidationValue
SearchFilterDefinition
SearchOperatorButtonValue
SearchOperatorInput
SearchOperatorParams
SearchOperatorType
SearchStrategy
SearchValueFormatterContext
SelectedPerspective
SelectionState
SingleWorkspace
SlugifierFn
SlugInputProps
SlugIsUniqueValidator
SlugParent
SlugSourceFn
SortOrdering
StaticLocaleResourceBundle
StatusButtonProps
StrictDefinition
StringFormNode
StudioLocaleResourceKeys
StudioThemeColorSchemeKey
SwatchName
SystemBundle
TagsArrayInputProps
TargetPerspective
TelephoneInputProps
TemplateArrayFieldDefinition
TemplateParameter
TemplateResolver
TextInputProps
TimelineControllerOptions
TranslateComponentMap
TypeAnnotationMismatchError
UndeclaredMembersError
UnitFormatter
Uploader
UploaderResolver
UploadOptions
UploadProgressEvent
UrlInputProps
UseDateTimeFormatOptions
UseNumberFormatOptions
UserListWithPermissionsHookValue
UseTranslationResponse
UseUnitFormatterOptions
ValidationBuilder
ValidationLocaleResourceKeys
ValuelessSearchOperatorParams
WithVersion
Variables
ALL_FIELDS_GROUP
AvatarSkeleton
CommentsEnabledProvider
CommentsIntentProvider
CommentsList
CommentsProvider
CopyPasteProvider
DECISION_PARAMETERS_SCHEMA
DEFAULT_ANNOTATIONS
MEDIA_LIBRARY_ASSET_ASPECT_TYPE_NAME
ObjectInput
SANITY_VERSION
ScheduleAction
ScheduledBadge
searchStrategies
StatusButton
systemBundles
ToolLink
TransformPatches
Functions
AddonDatasetProvider
ArrayOfObjectOptionsInput
ArrayOfObjectsFunctions
ArrayOfObjectsInput
ArrayOfObjectsItem
ArrayOfOptionsInput
ArrayOfPrimitiveOptionsInput
ArrayOfPrimitivesFunctions
ArrayOfPrimitivesItem
BlockImagePreview
BlockPreview
BooleanInput
buildLegacyTheme
CircularProgress
CommentDeleteDialog
CommentsAuthoringPathProvider
CompactPreview
createConfig
createPlugin
createSanityMediaLibraryFileSource
createSanityMediaLibraryImageSource
createSchema
CrossDatasetReferenceInput
DateInput
DateTimeInput
dec
DefaultPreview
defineArrayMember
defineAssetAspect
defineConfig
defineDocumentInspector
defineField
defineLocale
defineLocaleResourceBundle
definePlugin
defineSearchFilter
defineSearchFilterOperators
defineSearchOperator
defineType
DetailPreview
diffMatchPatch
documentIdEquals
EditPortal
EmailInput
EnhancedObjectDialog
FileInput
FormBuilder
FormProvider
getDocumentIsInPerspective
getDocumentVariantType
Hotkeys
ImageInput
inc
InlinePreview
insert
IntentButton
isArrayOfBlocksInputProps
isArrayOfObjectsInputProps
isArrayOfPrimitivesInputProps
isBooleanInputProps
isCreateDocumentVersionEvent
isCreateLiveDocumentEvent
isCrossDatasetReference
isDeleteDocumentGroupEvent
isDeleteDocumentVersionEvent
isDocumentSchemaType
isEditDocumentVersionEvent
isGlobalDocumentReference
isImage
isKeyedObject
isNumberInputProps
isObjectInputProps
isObjectItemProps
isPortableTextListBlock
isPortableTextSpan
isPortableTextTextBlock
isPublishDocumentVersionEvent
isSanityDefinedAction
isSanityDocument
isScheduleDocumentVersionEvent
isSlug
isStringInputProps
isTypedObject
isUnpublishDocumentEvent
isUnscheduleDocumentVersionEvent
isUpdateLiveDocumentEvent
LinearProgress
MediaPreview
NumberInput
PortableTextInput
ReferenceInput
removeUndefinedLocaleResources
SelectInput
set
setIfMissing
SlugInput
StringInput
Studio
StudioLayout
StudioLogo
StudioNavbar
StudioProvider
StudioToolMenu
TagsArrayInput
TelephoneInput
TemplatePreview
TextInput
Translate
UniversalArrayInput
unset
UrlInput
useAddonDataset
useCanvasCompanionDoc
useClient
useColorSchemeSetValue
useColorSchemeValue
useComments
useCommentsEnabled
useCopyPaste
useCurrentLocale
useCurrentUser
useDataset
useDateTimeFormat
useDialogStack
useDidUpdate
useDocumentPreviewStore
useDocumentStore
useDocumentVersions
useDocumentVersionTypeSortedList
useFormattedDuration
useFormBuilder
useFormValue
useGetDefaultPerspective
useGetFormValue
useGrantsStore
useHistoryStore
useListFormat
useNumberFormat
useOnlyHasVersions
usePerspective
usePresenceStore
useProjectId
useProjectStore
UserAvatar
useReferringDocuments
userHasRole
useRovingFocus
useSchema
useTemplates
useTools
useTranslation
useUnitFormatter
useUserListWithPermissions
useUserStore
useWorkspace
useWorkspaceSchemaId
validateDocument
References
BlockEditor
 →Â
PortableTextInput
DEFAULT_DECORATORS
 →Â
DEFAULT_ANNOTATIONS
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Namespaces
Schedule
Action
Classes
Array
Of
Primitives
Input
Patch
Event
Timeline
Timeline
Controller
Interfaces
Action
Component
Active
Tool
Layout
Props
Addon
Dataset
Context
Value
Api
Config
Array
Definition
Array
Field
Props
Array
Input
Copy
Event
Array
Input
Functions
Props
Array
Input
Insert
Event
Array
Input
Move
Item
Event
Array
Item
Error
Array
Of
Objects
Components
Array
Of
Objects
Form
Node
Array
Of
Objects
Input
Props
Array
Of
Objects
Item
Member
Array
Of
Primitives
Components
Array
Of
Primitives
Field
Props
Array
Of
Primitives
Form
Node
Array
Of
Primitives
Input
Props
Array
Of
Primitives
Item
Member
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
Auth
State
Auth
Store
Base
Action
Description
Base
Event
Base
Field
Props
Base
Form
Node
Base
Input
Props
Base
Item
Props
Base
Options
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
Components
Boolean
Definition
Boolean
Field
Props
Boolean
Input
Props
Boolean
Options
Boolean
Rule
Boolean
Schema
Type
Canvas
App
Options
Collapse
Options
Combined
Document
Comment
Base
Create
Payload
Comment
Context
Comment
Document
Comment
Field
Create
Payload
Comment
Operations
Comment
Path
Comment
Reaction
Item
Comment
Reaction
Option
Comments
Intent
Provider
Props
Comments
List
Breadcrumb
Item
Comments
Text
Selection
Item
Comment
Task
Create
Payload
Comment
Text
Selection
Comment
Thread
Item
Comment
Update
Operation
Options
Committed
Event
Complex
Element
Props
Conditional
Property
Callback
Context
Config
Context
Copy
Options
Copy
Paste
Context
Type
Create
Document
Version
Event
Create
Live
Document
Event
Cross
Dataset
Reference
Components
Cross
Dataset
Reference
Definition
Cross
Dataset
Reference
Schema
Type
Cross
Dataset
Reference
Value
Cross
Dataset
Type
Current
User
Custom
Validator
Date
Components
Date
Definition
Date
Options
Date
Rule
Datetime
Components
Datetime
Definition
Datetime
Options
Datetime
Rule
Decision
Parameters
Config
Decoration
Member
Default
Preview
Props
Define
Schema
Options
Delete
Document
Group
Event
Delete
Document
Version
Event
Deprecated
Property
Deprecation
Configuration
Document
Action
Component
Document
Action
Confirm
Dialog
Props
Document
Action
Custom
Dialog
Component
Props
Document
Action
Description
Document
Action
Modal
Dialog
Props
Document
Action
Popover
Dialog
Props
Document
Action
Props
Document
Actions
Context
Document
Badge
Component
Document
Badge
Description
Document
Badge
Props
Document
Badges
Context
Document
Comments
Enabled
Context
Document
Components
Document
Definition
Document
Field
Action
Document
Field
Action
Divider
Document
Field
Action
Group
Document
Field
Action
Hook
Document
Field
Action
Item
Document
Field
Action
Props
Document
Field
Actions
Resolver
Context
Document
Inspector
Document
Inspector
Context
Document
Inspector
Menu
Item
Document
Inspector
Props
Document
Inspector
Use
Menu
Item
Props
Document
Language
Filter
Context
Document
Meta
Document
Mutation
Event
Document
Options
Document
Plugin
Options
Document
Preview
Store
Document
Rebase
Event
Document
Remote
Mutation
Event
Document
Rule
Document
Stack
Availability
Document
Store
Document
Version
Drafts
Model
Document
Drafts
Model
Document
Availability
Duplicate
Action
Props
Duplicate
Document
Action
Component
Edit
Document
Version
Event
Edit
State
For
Email
Components
Email
Definition
Email
Options
Email
Rule
Empty
Props
Enum
List
Props
Events
Store
Revision
Field
Definition
Base
Field
Error
Field
Group
Field
Member
Field
Reference
Field
Set
Member
Fieldset
State
File
File
Asset
File
Components
File
Definition
File
Like
File
Options
File
Rule
File
Schema
Type
File
Value
Formatted
Duration
Form
Builder
Context
Value
Form
Builder
Props
Form
Components
Form
Dec
Patch
Form
Diff
Match
Patch
Form
Document
Value
Form
Field
Group
Form
Inc
Patch
Form
Insert
Patch
Form
Node
Presence
Form
Node
Validation
Form
Patch
Base
Form
Provider
Props
Form
Set
If
Missing
Patch
Form
Set
Patch
Form
Unset
Patch
Geopoint
Components
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
Grants
Store
Groupable
Action
Description
History
Cleared
Event
History
Store
Hook
Collection
Action
Hook
Hotspot
Options
Hotspot
Preview
I18n
Titled
List
Value
Image
Image
Asset
Image
Components
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
Error
Msg
Initial
Value
Loading
Msg
Initial
Value
Options
Initial
Value
Resolver
Context
Initial
Value
Success
Msg
Initial
Value
Template
Item
Input
On
Select
File
Function
Props
Insert
Menu
Options
Intrinsic
Definitions
Keyed
Object
Layout
Props
Legacy
Theme
Props
Listen
Query
Options
Loadable
Locale
Locale
Config
Context
Locale
Definition
Locale
Plugin
Options
Locale
Resource
Bundle
Locale
Resource
Record
Locale
Source
Locale
Week
Info
Localized
Validation
Messages
Logo
Props
Media
Library
Asset
Aspect
Document
Media
Library
Config
Media
Library
Filter
Media
Library
Options
Media
Validation
Value
Media
Validator
Member
Item
Props
Missing
Config
File
Multi
Field
Set
Mutation
Patch
Msg
Mutation
Payload
Navbar
Props
New
Document
Options
Context
Node
Chronology
Props
Node
Diff
Props
Number
Components
Number
Definition
Number
Field
Props
Number
Input
Props
Number
Options
Number
Rule
Number
Schema
Type
Object
Array
Form
Node
Object
Components
Object
Definition
Object
Field
Object
Field
Props
Object
Form
Node
Object
Input
Props
Object
Item
Props
Object
Options
Object
Rule
Object
Schema
Type
Observe
Document
Availability
Fn
Observe
Paths
Fn
On
Path
Focus
Payload
Operation
Error
Operation
Success
Operator
Button
Value
Component
Props
Operator
Input
Component
Props
Paste
Options
Patch
Channel
Patch
Msg
Subscriber
Permission
Check
Result
Perspective
Context
Value
Plugin
Options
Portable
Text
Input
Props
Portable
Text
List
Block
Portable
Text
Marker
Portable
Text
Object
Portable
Text
Plugins
Props
Portable
Text
Span
Portable
Text
Text
Block
Prepared
Snapshot
Prepare
View
Options
Presence
Store
Preview
Config
Preview
Media
Dimensions
Preview
Props
Preview
Value
Primitive
Input
Element
Props
Primitive
Item
Props
Primitive
Member
Item
Props
Project
Data
Project
Dataset
Data
Project
Store
Provenance
Diff
Annotation
Publish
Document
Version
Event
Rebase
Patch
Msg
Reconnect
Event
Reference
Reference
Base
Options
Reference
Components
Reference
Definition
Reference
Filter
Query
Options
Reference
Filter
Resolver
Context
Reference
Filter
Resolver
Options
Reference
Rule
Reference
Schema
Type
Release
Action
Component
Release
Action
Description
Release
Action
Props
Render
Block
Actions
Props
Render
Preview
Callback
Props
Resolve
Production
Url
Context
Role
Roving
Focus
Props
Rule
Rule
Def
Sanity
Clipboard
Item
Sanity
Create
Options
Sanity
Document
Sanity
Document
Like
Sanity
Form
Config
Schedule
Document
Version
Event
Scheduled
Publishing
Plugin
Options
Schema
Schema
Plugin
Options
Schema
Validation
Error
Search
Configuration
Search
Operator
Base
Search
Operator
Builder
Single
Field
Set
Slug
Slug
Components
Slug
Definition
Slug
Options
Slug
Rule
Slug
Schema
Type
Slug
Source
Context
Slug
Validation
Context
Slug
Value
Snapshot
Event
Sort
Ordering
Item
Source
Source
Client
Options
Source
Options
Span
Components
Span
Definition
State
Tree
String
Components
String
Definition
String
Field
Props
String
Input
Props
String
Options
String
Rule
String
Schema
Type
Studio
Components
Studio
Components
Plugin
Options
Studio
Props
Studio
Provider
Props
Studio
Theme
Template
Template
Field
Definition
Template
Item
Template
Preview
Props
Template
Reference
Target
Text
Components
Text
Definition
Text
Options
Text
Rule
Text
Schema
Type
Timeline
Options
Titled
List
Value
Tool
Tool
Link
Props
Tool
Menu
Props
Transaction
Translation
Props
Type
Alias
Definition
Typed
Object
Type
Reference
Type
Target
Unpublish
Document
Event
Unschedule
Document
Version
Event
Update
Live
Document
Event
Upload
Event
Uri
Validation
Options
Url
Components
Url
Definition
Url
Options
Url
Rule
Use
Formatted
Duration
Options
Use
List
Format
Options
User
User
Avatar
Props
User
List
With
Permissions
Options
User
Store
User
With
Permission
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
Welcome
Event
Widen
Initial
Value
Widen
Validation
Workspace
Workspace
Options
Type Aliases
Annotation
Annotation
Details
Apps
Options
Array
Action
Name
Array
Of
Entry
Array
Of
Objects
Member
Array
Of
Primitives
Element
Type
Array
Of
Primitives
Member
Array
Of
Type
Asset
Access
Policy
Asset
From
Source
Asset
Metadata
Type
Asset
Source
Resolver
Asset
Sources
Resolver
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
Async
Composable
Option
Autocomplete
String
Block
Image
Preview
Props
Boolean
Form
Node
Buffered
Document
Event
Chunk
Chunk
Type
Comment
Create
Payload
Comment
Intent
Getter
Comment
List
Breadcrumbs
Comment
Message
Comment
Post
Payload
Comment
Reaction
Short
Names
Comment
Status
Comments
Type
CommentsUIMode
Comment
Update
Payload
Compact
Preview
Props
Composable
Option
Compute
Diff
Conditional
Property
Conditional
Property
Callback
Config
Cross
Dataset
Reference
Filter
Resolver
Cross
Dataset
Reference
Filter
Search
Options
Cross
Dataset
Reference
Input
Props
Custom
Validator
Result
Date
Input
Props
Date
Time
Input
Props
Default
Plugins
Workspace
Options
Define
Array
Member
Base
Define
Schema
Base
Define
Schema
Type
Deprecated
Schema
Type
Detail
Preview
Props
Document
Action
Dialog
Props
Document
Action
Group
Document
Actions
Resolver
Document
Actions
Version
Type
Document
Availability
Document
Badges
Resolver
Document
Field
Document
Field
Action
Node
Document
Field
Actions
Resolver
Document
Field
Action
Status
Document
Field
Action
Tone
Document
Group
Event
Document
Inspector
Component
Document
Inspectors
Resolver
Document
Language
Filter
Component
Document
Language
Filter
Resolver
Document
Remote
Mutation
Version
Event
Document
Revision
Document
Value
Permission
Document
Variant
Type
Document
Version
Event
Duplicate
Keys
Error
Email
Input
Props
Field
Definition
Field
Group
Definition
Field
Name
Field
Props
Field
Rules
Fieldset
Fieldset
Definition
Fieldset
Members
Fieldset
Render
Members
Callback
File
Input
Props
Formattable
Measurement
Unit
Form
Builder
Custom
Markers
Component
Form
Builder
Input
Component
Map
Form
Builder
Markers
Component
Form
Insert
Patch
Position
Form
Patch
Form
PatchJSONValue
Form
Patch
Origin
General
Document
List
Layout
Key
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
Input
Props
Image
Metadata
Type
Implicit
Locale
Resource
Bundle
Incompatible
Type
Error
Index
Tuple
Initial
Value
Msg
Initial
Value
Property
Initial
Value
Resolver
Inline
Field
Definition
Inline
Preview
Props
Input
Props
Intrinsic
Array
Of
Base
Intrinsic
Array
Of
Definition
Intrinsic
Base
Intrinsic
Type
Name
Invalidation
Channel
Event
Invalid
Item
Type
Error
Item
Props
Keyed
Segment
Locale
Nested
Resource
Locale
Resource
Key
Locales
Bundles
Option
Locales
Option
Login
Component
Props
Login
Method
Map
Document
Markdown
Config
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
Media
Preview
Props
Missing
Keys
Error
Mixed
Array
Error
Mutation
Result
Narrow
Preview
New
Document
Creation
Context
New
Document
Options
Resolver
Number
Form
Node
Object
Field
Type
Object
Item
Object
Member
Object
Render
Members
Callback
Observe
For
Preview
Fn
Pair
Parsed
Time
Ref
Partial
Context
Patch
Arg
Patch
Msg
Path
Path
Segment
Perspective
Stack
Plugin
Plugin
Factory
Portable
Text
Block
Portable
Text
Child
Portable
Text
Preview
Layout
Key
Previewable
Previewable
Type
Preview
Component
Preview
Layout
Key
Preview
Path
Primitive
Form
Node
Primitive
Input
Props
Project
Grants
Query
Params
Reference
Filter
Options
Reference
Filter
Resolver
Reference
Filter
Search
Options
Reference
Input
Props
Reference
Options
Reference
To
Reference
Value
Release
Actions
Context
Release
Actions
Resolver
Release
Id
Remote
Snapshot
Event
Remote
Snapshot
Version
Event
Render
Annotation
Callback
Render
Array
Of
Objects
Item
Callback
Render
Array
Of
Primitives
Item
Callback
Render
Block
Actions
Callback
Render
Block
Callback
Render
Custom
Markers
Render
Field
Callback
Render
Input
Callback
Render
Item
Callback
Render
Preview
Callback
Resolved
Uploader
Roving
Focus
Navigation
Type
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
Selection
State
Single
Workspace
Slugifier
Fn
Slug
Input
Props
Slug
Is
Unique
Validator
Slug
Parent
Slug
Source
Fn
Sort
Ordering
Static
Locale
Resource
Bundle
Status
Button
Props
Strict
Definition
String
Form
Node
Studio
Locale
Resource
Keys
Studio
Theme
Color
Scheme
Key
Swatch
Name
System
Bundle
Tags
Array
Input
Props
Target
Perspective
Telephone
Input
Props
Template
Array
Field
Definition
Template
Parameter
Template
Resolver
Text
Input
Props
Timeline
Controller
Options
Translate
Component
Map
Type
Annotation
Mismatch
Error
Undeclared
Members
Error
Unit
Formatter
Uploader
Uploader
Resolver
Upload
Options
Upload
Progress
Event
Url
Input
Props
Use
Date
Time
Format
Options
Use
Number
Format
Options
User
List
With
Permissions
Hook
Value
Use
Translation
Response
Use
Unit
Formatter
Options
Validation
Builder
Validation
Locale
Resource
Keys
Valueless
Search
Operator
Params
With
Version
Variables
ALL_
FIELDS_
GROUP
Avatar
Skeleton
Comments
Enabled
Provider
Comments
Intent
Provider
Comments
List
Comments
Provider
Copy
Paste
Provider
DECISION_
PARAMETERS_
SCHEMA
DEFAULT_
ANNOTATIONS
MEDIA_
LIBRARY_
ASSET_
ASPECT_
TYPE_
NAME
Object
Input
SANITY_
VERSION
Schedule
Action
Scheduled
Badge
search
Strategies
Status
Button
system
Bundles
Tool
Link
Transform
Patches
Functions
Addon
Dataset
Provider
Array
Of
Object
Options
Input
Array
Of
Objects
Functions
Array
Of
Objects
Input
Array
Of
Objects
Item
Array
Of
Options
Input
Array
Of
Primitive
Options
Input
Array
Of
Primitives
Functions
Array
Of
Primitives
Item
Block
Image
Preview
Block
Preview
Boolean
Input
build
Legacy
Theme
Circular
Progress
Comment
Delete
Dialog
Comments
Authoring
Path
Provider
Compact
Preview
create
Config
create
Plugin
create
Sanity
Media
Library
File
Source
create
Sanity
Media
Library
Image
Source
create
Schema
Cross
Dataset
Reference
Input
Date
Input
Date
Time
Input
dec
Default
Preview
define
Array
Member
define
Asset
Aspect
define
Config
define
Document
Inspector
define
Field
define
Locale
define
Locale
Resource
Bundle
define
Plugin
define
Search
Filter
define
Search
Filter
Operators
define
Search
Operator
define
Type
Detail
Preview
diff
Match
Patch
document
Id
Equals
Edit
Portal
Email
Input
Enhanced
Object
Dialog
File
Input
Form
Builder
Form
Provider
get
Document
Is
In
Perspective
get
Document
Variant
Type
Hotkeys
Image
Input
inc
Inline
Preview
insert
Intent
Button
is
Array
Of
Blocks
Input
Props
is
Array
Of
Objects
Input
Props
is
Array
Of
Primitives
Input
Props
is
Boolean
Input
Props
is
Create
Document
Version
Event
is
Create
Live
Document
Event
is
Cross
Dataset
Reference
is
Delete
Document
Group
Event
is
Delete
Document
Version
Event
is
Document
Schema
Type
is
Edit
Document
Version
Event
is
Global
Document
Reference
is
Image
is
Keyed
Object
is
Number
Input
Props
is
Object
Input
Props
is
Object
Item
Props
is
Portable
Text
List
Block
is
Portable
Text
Span
is
Portable
Text
Text
Block
is
Publish
Document
Version
Event
is
Sanity
Defined
Action
is
Sanity
Document
is
Schedule
Document
Version
Event
is
Slug
is
String
Input
Props
is
Typed
Object
is
Unpublish
Document
Event
is
Unschedule
Document
Version
Event
is
Update
Live
Document
Event
Linear
Progress
Media
Preview
Number
Input
Portable
Text
Input
Reference
Input
remove
Undefined
Locale
Resources
Select
Input
set
set
If
Missing
Slug
Input
String
Input
Studio
Studio
Layout
Studio
Logo
Studio
Navbar
Studio
Provider
Studio
Tool
Menu
Tags
Array
Input
Telephone
Input
Template
Preview
Text
Input
Translate
Universal
Array
Input
unset
Url
Input
use
Addon
Dataset
use
Canvas
Companion
Doc
use
Client
use
Color
Scheme
Set
Value
use
Color
Scheme
Value
use
Comments
use
Comments
Enabled
use
Copy
Paste
use
Current
Locale
use
Current
User
use
Dataset
use
Date
Time
Format
use
Dialog
Stack
use
Did
Update
use
Document
Preview
Store
use
Document
Store
use
Document
Versions
use
Document
Version
Type
Sorted
List
use
Formatted
Duration
use
Form
Builder
use
Form
Value
use
Get
Default
Perspective
use
Get
Form
Value
use
Grants
Store
use
History
Store
use
List
Format
use
Number
Format
use
Only
Has
Versions
use
Perspective
use
Presence
Store
use
Project
Id
use
Project
Store
User
Avatar
use
Referring
Documents
user
Has
Role
use
Roving
Focus
use
Schema
use
Templates
use
Tools
use
Translation
use
Unit
Formatter
use
User
List
With
Permissions
use
User
Store
use
Workspace
use
Workspace
Schema
Id
validate
Document
References
Block
Editor
DEFAULT_
DECORATORS
Sanity Library Reference Docs
Loading...