Sanity Library Reference Docs
    Preparing search 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
    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
    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
    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