sanity
Version:
Sanity is a real-time content infrastructure with a scalable, hosted backend featuring a Graph Oriented Query Language (GROQ), asset pipelines and fast edge caches
105 lines (101 loc) • 3.19 kB
text/typescript
import {
type ObjectSchemaType,
type Path,
type SanityDocument,
type SanityDocumentLike,
type ValidationMarker,
} from '@sanity/types'
import {
type DocumentActionComponent,
type DocumentBadgeComponent,
type DocumentFieldAction,
type DocumentFormNode,
type DocumentInspector,
type DocumentLanguageFilterComponent,
type EditStateFor,
type PatchEvent,
type PermissionCheckResult,
type ReleaseId,
type StateTree,
type TimelineStore,
} from 'sanity'
import {type View} from '../../structureBuilder'
import {type PaneMenuItem, type PaneMenuItemGroup} from '../../types'
/** @internal */
export interface DocumentPaneContextValue {
actions: DocumentActionComponent[] | null
activeViewId: string | null
badges: DocumentBadgeComponent[] | null
changesOpen: boolean
closeInspector: (inspectorName?: string) => void
collapsedFieldSets: StateTree<boolean> | undefined
collapsedPaths: StateTree<boolean> | undefined
compareValue: Partial<SanityDocument> | null
connectionState: 'connecting' | 'reconnecting' | 'connected'
displayed: Partial<SanityDocument> | null
documentId: string
documentIdRaw: string
documentType: string
editState: EditStateFor | null
fieldActions: DocumentFieldAction[]
focusPath: Path
index: number
inspectOpen: boolean
inspector: DocumentInspector | null
inspectors: DocumentInspector[]
menuItemGroups: PaneMenuItemGroup[]
onBlur: (blurredPath: Path) => void
onChange: (event: PatchEvent) => void
onFocus: (pathOrEvent: Path) => void
onHistoryClose: () => void
onHistoryOpen: () => void
onInspectClose: () => void
onMenuAction: (item: PaneMenuItem) => void
onPaneClose: () => void
onPaneSplit?: () => void
onPathOpen: (path: Path) => void
onSetActiveFieldGroup: (path: Path, groupName: string) => void
onSetCollapsedPath: (path: Path, expanded: boolean) => void
onSetCollapsedFieldSet: (path: Path, expanded: boolean) => void
openInspector: (inspectorName: string, paneParams?: Record<string, string>) => void
openPath: Path
paneKey: string
previewUrl?: string | null
ready: boolean
schemaType: ObjectSchemaType
/**
* @deprecated not used anymore
* */
setTimelineMode?: undefined
/**
* @deprecated not used anymore
* */
timelineMode?: undefined
setTimelineRange(since: string | null, rev: string | null): void
setIsDeleting: (state: boolean) => void
timelineError: Error | null
/**
* Soon to be deprecated with the upcoming `releases` changes.
*/
timelineStore?: TimelineStore
title: string | null
validation: ValidationMarker[]
value: SanityDocumentLike
views: View[]
formState: DocumentFormNode | null
/**
* TODO: COREL - Remove this after updating sanity-assist to use <PerspectiveProvider>
*
* @deprecated use `usePerspective()` instead
*/
selectedReleaseId: ReleaseId | undefined
permissions?: PermissionCheckResult | null
isDeleting: boolean
isDeleted: boolean
isPermissionsLoading: boolean
isInitialValueLoading?: boolean
unstable_languageFilter: DocumentLanguageFilterComponent[]
// History specific values
revisionId: string | null
lastNonDeletedRevId: string | null
}