Sanity Library Reference Docs
Preparing search index...
Sanity Library Reference Docs
Hierarchy Summary
ActionComponent
DocumentActionComponent
DuplicateDocumentActionComponent
AgentActionTarget
GenerateTarget
TransformTarget
TranslateTarget
AgentActionTarget
GenerateTarget
TransformTarget
TranslateTarget
AutonomyAnswer
StageAutonomy
WorkflowAutonomy
BaseActionDescription
GroupableActionDescription
DocumentActionDescription
BaseEvent
CreateDocumentVersionEvent
CreateLiveDocumentEvent
DeleteDocumentGroupEvent
DeleteDocumentVersionEvent
EditDocumentVersionEvent
HistoryClearedEvent
PublishDocumentVersionEvent
ScheduleDocumentVersionEvent
UnpublishDocumentEvent
UnscheduleDocumentVersionEvent
UpdateLiveDocumentEvent
BaseFieldProps
ArrayFieldProps
ArrayOfPrimitivesFieldProps
BooleanFieldProps
NumberFieldProps
ObjectFieldProps
StringFieldProps
BaseInputProps
ArrayOfObjectsInputProps
PortableTextInputProps
ArrayOfPrimitivesInputProps
BooleanInputProps
NumberInputProps
ObjectInputProps
StringInputProps
BaseOptions
CopyOptions
PasteOptions
BaseSchemaDefinition
ArrayDefinition
BlockDefinition
BooleanDefinition
CrossDatasetReferenceDefinition
DateDefinition
DatetimeDefinition
EmailDefinition
GeopointDefinition
NumberDefinition
ObjectDefinition
BlockAnnotationDefinition
ReferenceDefinition
SlugDefinition
StringDefinition
TextDefinition
UrlDefinition
GlobalDocumentReferenceDefinition
TypeAliasDefinition
BaseSchemaType
ArraySchemaType
BooleanSchemaType
NumberSchemaType
ObjectSchemaType
SlugSchemaType
StringSchemaType
TextSchemaType
BaseSchemaTypeOptions
ArrayOptions
BlockOptions
BooleanOptions
DateOptions
DatetimeOptions
DocumentOptions
EmailOptions
NumberOptions
ObjectOptions
FileOptions
ImageOptions
GeopointOptions
VideoOptions
ReferenceBaseOptions
SlugOptions
StringOptions
TextOptions
UrlOptions
BaseView
ComponentView
FormView
BlueprintBaseFunctionResource
BlueprintDocumentFunctionResource
BlueprintMediaLibraryAssetFunctionResource
BlueprintSyncTagInvalidateFunctionResource
BlueprintPubSubFunctionResource
BlueprintCrossStackReferenceConfig
BlueprintCrossStackReferenceResourceConfig
BlueprintFunctionBaseResourceEvent
BlueprintDocumentFunctionResourceEvent
BlueprintMediaLibraryFunctionResourceEvent
BlueprintOwnershipAttachAction
BlueprintProjectOwnershipAttachAction
BlueprintResource
BlueprintCorsOriginResource
BlueprintRobotTokenResource
BlueprintRoleResource
BlueprintProjectRoleResource
BlueprintDocumentWebhookResource
BlueprintResourceLifecycle
BlueprintProjectResourceLifecycle
BlueprintRoleConfig
BlueprintRoleResource
BuildableGenericList
PartialDocumentList
BuildableList
ClientConfig
InitializedClientConfig
InitializedClientStegaConfig
ClientStegaConfig
ClientConfig
InitializedClientConfig
CommentBaseCreatePayload
CommentFieldCreatePayload
CommentTaskCreatePayload
ConfigContext
DocumentFieldActionsResolverContext
DocumentActionsContext
DocumentBadgesContext
DocumentInspectorContext
DocumentLanguageFilterContext
NewDocumentOptionsContext
ResolveProductionUrlContext
DefaultDocumentNodeContext
StructureResolverContext
ContentSourceMapDocumentBase
ContentSourceMapDocument
ContentSourceMapRemoteDocument
ContentSourceMapDocumentBase
ContentSourceMapDocument
ContentSourceMapRemoteDocument
CrossDatasetReferenceValue
WeakCrossDatasetReferenceValue
DashboardTopics
Topics
DashboardTopics
Topics
DashboardUrl
UrlBuilder
CanvasUrl
CoreApplicationUrl
MediaLibraryUrl
StudioIntentUrl
StudioWorkspaceUrl
StudioUrl
EditStateFor
DocumentActionProps
DuplicateActionProps
DocumentBadgeProps
EngineScopeArgs
CreateEngineArgs
EnumListProps
NumberOptions
StringOptions
ExecutionScopedEventData
WorkflowActionFiredData
WorkflowAdminOverrideData
WorkflowDefinitionDeletedData
WorkflowDefinitionDeployedData
WorkflowEffectCompletedData
WorkflowEffectsDrainedData
WorkflowEffectStateReportedData
WorkflowFieldEditedData
WorkflowInstanceStartedData
WorkflowInstanceTickedData
WorkflowStageTransitionedData
FileValue
ImageValue
FormPatchBase
FormDecPatch
FormDiffMatchPatch
FormIncPatch
FormInsertPatch
FormSetIfMissingPatch
FormSetPatch
FormUnsetPatch
GlobalDocumentReference
ReleaseRef
GlobalDocumentReferenceValue
WeakGlobalDocumentReferenceValue
HookCollectionActionHook
DocumentBadgeComponent
InspectorTab
StructureDocumentPaneParams
CombinedSearchParams
PresentationParams
InstanceRefArgs
ChildrenArgs
DrainEffectsArgs
FindPendingEffectsArgs
QueryInScopeArgs
ListItem
DocumentListItem
ListItemInput
DocumentListItemInput
LoadBlueprintFileOptions
ReadBlueprintOptions
ReadStackOptions
LoadedBlueprintFile
BlueprintInfo
StackInfo
Locale
LocaleDefinition
MessageBus
MessageBusConnection
MessageBusHost
MessageBus
MessageBusConnection
MessageBusHost
MessageBusAbortOptions
MessageBusEmitOptions
MessageBusQueryOptions
MessageBusAbortOptions
MessageBusEmitOptions
MessageBusQueryOptions
Msg
OverlayMsgElement
MutationGuardBody
MutationGuardDoc
CompileGuardsArgs
MutationGuardDoc
MutationGuardDoc
MutationGuardDoc
NavigateBaseOptions
NavigateOptions
NavigateOptionsWithState
NodeChronologyProps
NodeDiffProps
BaseFormNode
ArrayOfObjectsFormNode
ArrayOfPrimitivesFormNode
ObjectArrayFormNode
ObjectFormNode
BaseItemProps
ObjectItemProps
PrimitiveItemProps
ObservableSanityClient
ObservableSanityStegaClient
OperationArgs
DedupableOperationArgs
AbortInstanceArgs
CompleteEffectArgs
CommitEffectOpsArgs
EditFieldArgs
FireActionArgs
ResetActivityArgs
SetStageArgs
OverlayComponentResolverContext
OverlayComponentProps
OverlayPluginDefinitionBase
OverlayPluginExclusiveDefinition
OverlayPluginHudDefinition
ParsedGdr
SubscriptionDocument
PerspectiveHandle
DatasetHandle
RemoveCommentOptions
SetCommentStatusOptions
UpdateCommentOptions
DocumentTypeHandle
DocumentHandle
CreateCommentOptions
ReplyToCommentOptions
CommentsOptions
ResolveCommentsOptions
DeleteDocumentAction
DiscardDocumentAction
EditDocumentAction
PublishDocumentAction
UnpublishDocumentAction
DocumentOptions
FavoriteDocumentContext
DocumentHandle
UsePresenceForDocumentOptions
UseReportPresenceOptions
useDocumentPreviewOptions
useDocumentProjectionOptions
CreateDocumentAction
DocumentTypeHandle
ReleaseHandle
ArchiveReleaseAction
CreateReleaseAction
DeleteReleaseAction
EditReleaseAction
PublishReleaseAction
ScheduleReleaseAction
UnarchiveReleaseAction
UnscheduleReleaseAction
SanityConfig
QueryOptions
ResourceHandle
DocumentsOptions
SanityConfig
PresencePerspectiveOptions
DocumentPresenceOptions
ReportPresenceOptions
PluginOptions
SourceOptions
WorkspaceOptions
PortableTextTextBlock
PortableTextListBlock
PresentationSearchParams
CombinedSearchParams
PresentationStateParams
PresentationParams
PreviewProps
PreviewHeaderProps
ProjectHandle
DatasetHandle
ProjectOptions
GetUserOptions
ResolveUserOptions
GetUsersOptions
ResolveUsersOptions
ProjectUserProfileClient
StudioUserClient
QueryArgs
QueryInScopeArgs
RemoteModuleRef
ApplicationConfig
RemoteModuleRef
ApplicationConfig
RequestOptions
ResponseQueryOptions
FilteredResponseQueryOptions
UnfilteredResponseQueryOptions
UnfilteredResponseWithoutQuery
RequestOptions
ResponseQueryOptions
FilteredResponseQueryOptions
UnfilteredResponseQueryOptions
UnfilteredResponseWithoutQuery
RequirementDescriptor
StartRequirementEvaluation
RouterNode
Router
RuleDef
ArrayRule
BlockRule
BooleanRule
DateRule
DatetimeRule
DocumentRule
EmailRule
FileRule
GeopointRule
ImageRule
NumberRule
ObjectRule
ReferenceRule
SlugRule
StringRule
TextRule
UrlRule
VideoRule
SanityClient
SanityStegaClient
SanityDocument
WorkflowInstance
SanityDocument
SystemVariant
Asset
FileAsset
ImageAsset
SanityDocumentLike
MediaLibraryAssetAspectDocument
SearchConfiguration
ArrayOptions
SlugOptions
StringOptions
SearchOperatorBase
SearchOperatorBuilder
ValuelessSearchOperatorBuilder
Serializable
ComponentBuilder
DocumentBuilder
GenericListBuilder
DocumentListBuilder
DocumentTypeListBuilder
ListBuilder
GenericViewBuilder
ComponentViewBuilder
FormViewBuilder
InitialValueTemplateItemBuilder
ListItemBuilder
DocumentListItemBuilder
MenuItemBuilder
MenuItemGroupBuilder
SerializeOptions
ListItemSerializeOptions
Source
StructureContext
StructureNode
Component
ComponentInput
BaseGenericList
GenericList
DocumentList
List
GenericListInput
DocumentListInput
ListInput
DocumentNode
EditorNode
StudioProps
StudioProviderProps
Template
ResolvedTemplate
TemplateItem
InitialValueTemplateItem
User
UserWithPermission
ValidationContext
SlugValidationContext
VideoPlaybackInfoItemPublic
VideoPlaybackInfoItemSigned
VideoPlaybackInfoItemPublic
VideoPlaybackInfoItemSigned
VideoRenditionInfoPublic
VideoRenditionInfoSigned
VideoRenditionInfoPublic
VideoRenditionInfoSigned
VideoSubtitleInfoPublic
VideoSubtitleInfoSigned
VideoSubtitleInfoPublic
VideoSubtitleInfoSigned
WorkflowError
EffectCommitQueueOverflowError
MissingHandlerError
ContractViolationError
DefinitionInUseError
DefinitionNotFoundError
EffectNotFoundError
InstanceNotFoundError
SpawnContractsInvalidError
UnknownProjectRolesError
WorkflowOperationError
ModelVersionAheadError
ReaderModelAcknowledgementError
PersistedDocShapeError
FieldValueShapeError
RefResourceUndeclaredError
ActionParamsInvalidError
CascadeLimitError
ConcurrentCascadeError
ConcurrentCommitEffectOpsError
ConcurrentCompleteEffectError
ConcurrentEditFieldError
ConcurrentFireActionError
EffectOpsInvalidError
EffectOutputsInvalidError
InitialFieldsInvalidError
PartialGuardDeployError
RequiredFieldNotProvidedError
StaleEffectClaimError
StartNotPrimedError
StartNotSettledError
WorkflowStateDivergedError
MutationGuardDeniedError
AbortDeniedError
ActionDisabledError
EditFieldDeniedError
StartNotAllowedError
WorkflowsResourceLifecycle
NormalizedWorkflowsResourceLifecycle
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Sanity Library Reference Docs
Loading...