/
editor.ts
442 lines (389 loc) · 10.2 KB
/
editor.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
import {
ArraySchemaType,
BlockDecoratorDefinition,
BlockListDefinition,
BlockSchemaType,
BlockStyleDefinition,
ObjectSchemaType,
Path,
PortableTextBlock,
PortableTextChild,
PortableTextListBlock,
PortableTextObject,
PortableTextSpan,
PortableTextTextBlock,
SpanSchemaType,
} from '@sanity/types'
import {Subject, Observable} from 'rxjs'
import {Descendant, Node as SlateNode, Operation as SlateOperation} from 'slate'
import {ReactEditor} from '@sanity/slate-react'
import type {Patch} from '../types/patch'
import {PortableTextEditor} from '../editor/PortableTextEditor'
/** @beta */
export interface EditableAPIDeleteOptions {
mode?: 'blocks' | 'children' | 'selected'
}
/** @beta */
export interface EditableAPI {
activeAnnotations: () => PortableTextObject[]
addAnnotation: (
type: ObjectSchemaType,
value?: {[prop: string]: unknown}
) => {spanPath: Path; markDefPath: Path} | undefined
blur: () => void
delete: (selection: EditorSelection, options?: EditableAPIDeleteOptions) => void
findByPath: (path: Path) => [PortableTextBlock | PortableTextChild | undefined, Path | undefined]
findDOMNode: (element: PortableTextBlock | PortableTextChild) => Node | undefined
focus: () => void
focusBlock: () => PortableTextBlock | undefined
focusChild: () => PortableTextChild | undefined
getSelection: () => EditorSelection
getValue: () => PortableTextBlock[] | undefined
hasBlockStyle: (style: string) => boolean
hasListStyle: (listStyle: string) => boolean
insertBlock: (type: BlockSchemaType | ObjectSchemaType, value?: {[prop: string]: unknown}) => Path
insertChild: (type: SpanSchemaType | ObjectSchemaType, value?: {[prop: string]: unknown}) => Path
isCollapsedSelection: () => boolean
isExpandedSelection: () => boolean
isMarkActive: (mark: string) => boolean
isVoid: (element: PortableTextBlock | PortableTextChild) => boolean
marks: () => string[]
redo: () => void
removeAnnotation: (type: ObjectSchemaType) => void
select: (selection: EditorSelection) => void
toggleBlockStyle: (blockStyle: string) => void
toggleList: (listStyle: string) => void
toggleMark: (mark: string) => void
undo: () => void
}
/** @internal */
export type EditorNode = SlateNode & {
_key: string
_type: string
}
/** @internal */
export type HistoryItem = {
operations: SlateOperation[]
timestamp: Date
}
/** @internal */
export interface History {
redos: HistoryItem[]
undos: HistoryItem[]
}
/** @beta */
export type EditorSelectionPoint = {path: Path; offset: number}
/** @beta */
export type EditorSelection = {anchor: EditorSelectionPoint; focus: EditorSelectionPoint} | null
/** @internal */
export interface PortableTextSlateEditor extends ReactEditor {
_key: 'editor'
_type: 'editor'
destroy: () => void
createPlaceholderBlock: () => Descendant
editable: EditableAPI
history: History
insertPortableTextData: (data: DataTransfer) => boolean
insertTextOrHTMLData: (data: DataTransfer) => boolean
isTextBlock: (value: unknown) => value is PortableTextTextBlock
isTextSpan: (value: unknown) => value is PortableTextSpan
isListBlock: (value: unknown) => value is PortableTextListBlock
readOnly: boolean
maxBlocks: number | undefined
/**
* Increments selected list items levels, or decrements them if `reverse` is true.
*
* @param reverse - if true, decrement instead of incrementing
* @returns True if anything was incremented in the selection
*/
pteIncrementBlockLevels: (reverse?: boolean) => boolean
/**
* Toggle selected blocks as listItem
*
* @param listStyle - Style of list item to toggle on/off
*/
pteToggleListItem: (listStyle: string) => void
/**
* Set selected block as listItem
*
* @param listStyle - Style of list item to set
*/
pteSetListItem: (listStyle: string) => void
/**
* Unset selected block as listItem
*
* @param listStyle - Style of list item to unset
*/
pteUnsetListItem: (listStyle: string) => void
/**
* Ends a list
*
* @returns True if a list was ended in the selection
*/
pteEndList: () => boolean
/**
* Toggle marks in the selection
*
* @param mark - Mark to toggle on/off
*/
pteToggleMark: (mark: string) => void
/**
* Test if a mark is active in the current selection
*
* @param mark - Mark to check whether or not is active
*/
pteIsMarkActive: (mark: string) => boolean
/**
* Toggle the selected block style
*
* @param style - The style name
*
*/
pteToggleBlockStyle: (style: string) => void
/**
* Test if the current selection has a certain block style
*
* @param style - The style name
*
*/
pteHasBlockStyle: (style: string) => boolean
/**
* Test if the current selection has a certain list style
*
* @param listStyle - Style name to check whether or not the selection has
*
*/
pteHasListStyle: (style: string) => boolean
/**
* Try to expand the current selection to a word
*/
pteExpandToWord: () => void
/**
* Use hotkeys
*/
pteWithHotKeys: (event: React.KeyboardEvent<HTMLDivElement>) => void
/**
* Undo
*/
undo: () => void
/**
* Redo
*/
redo: () => void
}
/** @beta */
export type MutationChange = {
type: 'mutation'
patches: Patch[]
}
/** @beta */
export type PatchChange = {
type: 'patch'
patch: Patch
}
/** @beta */
export type ValueChange = {
type: 'value'
value: PortableTextBlock[] | undefined
}
/** @beta */
export type SelectionChange = {
type: 'selection'
selection: EditorSelection
}
/** @beta */
export type FocusChange = {
type: 'focus'
}
/** @beta */
export type UnsetChange = {
type: 'unset'
previousValue: PortableTextBlock[]
}
/** @beta */
export type BlurChange = {
type: 'blur'
}
/** @beta */
export type LoadingChange = {
type: 'loading'
isLoading: boolean
}
/** @beta */
export type ReadyChange = {
type: 'ready'
}
/** @beta */
export type ErrorChange = {
type: 'error'
name: string // short computer readable name
level: 'warning' | 'error'
description: string
data?: unknown
}
/** @beta */
export type InvalidValueResolution = {
patches: Patch[]
description: string
action: string
item: PortableTextBlock[] | PortableTextBlock | PortableTextChild | undefined
}
/** @beta */
export type InvalidValue = {
type: 'invalidValue'
resolution: InvalidValueResolution | null
value: PortableTextBlock[]
}
/** @beta */
export type UndoChange = {
type: 'undo'
patches: Patch[]
timestamp: Date
}
/** @beta */
export type RedoChange = {
type: 'redo'
patches: Patch[]
timestamp: Date
}
/** @beta */
export type EditorChange =
| BlurChange
| ErrorChange
| FocusChange
| InvalidValue
| LoadingChange
| MutationChange
| PatchChange
| ReadyChange
| RedoChange
| SelectionChange
| UndoChange
| UnsetChange
| ValueChange
export type EditorChanges = Subject<EditorChange>
/** @beta */
export type OnPasteResult =
| {
insert?: PortableTextBlock[]
path?: Path
}
| undefined
export type OnPasteResultOrPromise = OnPasteResult | Promise<OnPasteResult>
/** @beta */
export type OnPasteFn = (arg0: {
event: React.ClipboardEvent
path: Path
types: PortableTextMemberTypes
value: PortableTextBlock[] | undefined
}) => OnPasteResultOrPromise
/** @beta */
export type OnBeforeInputFn = (event: Event) => void
/** @beta */
export type OnCopyFn = (
event: React.ClipboardEvent<HTMLDivElement | HTMLSpanElement>
) => undefined | unknown
/** @beta */
export type PatchObservable = Observable<{
patches: Patch[]
snapshot: PortableTextBlock[] | undefined
}>
/** @beta */
export interface BlockRenderProps {
children: React.ReactElement
editorElementRef: React.RefObject<HTMLElement>
focused: boolean
level?: number
listItem?: string
path: Path
selected: boolean
style?: string
type: ObjectSchemaType
value: PortableTextBlock
}
/** @beta */
export interface BlockChildRenderProps {
annotations: PortableTextObject[]
children: React.ReactElement
editorElementRef: React.RefObject<HTMLElement>
focused: boolean
path: Path
selected: boolean
type: ObjectSchemaType
value: PortableTextChild
}
/** @beta */
export interface BlockAnnotationRenderProps {
block: PortableTextBlock
children: React.ReactElement
editorElementRef: React.RefObject<HTMLElement>
focused: boolean
path: Path
selected: boolean
type: ObjectSchemaType
value: PortableTextObject
}
/** @beta */
export interface BlockDecoratorRenderProps {
children: React.ReactElement
editorElementRef: React.RefObject<HTMLElement>
focused: boolean
path: Path
selected: boolean
type: BlockDecoratorDefinition
value: string
}
/** @beta */
export interface BlockListItemRenderProps {
block: PortableTextTextBlock
children: React.ReactElement
editorElementRef: React.RefObject<HTMLElement>
focused: boolean
level: number
nextItem?: string
path: Path
previousItem?: string
selected: boolean
type: BlockListDefinition
value: string
}
/** @beta */
export type RenderBlockFunction = (props: BlockRenderProps) => JSX.Element
/** @beta */
export type RenderChildFunction = (props: BlockChildRenderProps) => JSX.Element
/** @beta */
export type RenderAnnotationFunction = (props: BlockAnnotationRenderProps) => JSX.Element
/** @beta */
export type RenderStyleFunction = (props: BlockStyleRenderProps) => JSX.Element
/** @beta */
export interface BlockStyleRenderProps {
block: PortableTextTextBlock
children: React.ReactElement
editorElementRef: React.RefObject<HTMLElement>
focused: boolean
path: Path
selected: boolean
type: BlockStyleDefinition
value: string
}
/** @beta */
export type RenderListItemFunction = (props: BlockListItemRenderProps) => JSX.Element
/** @beta */
export type RenderDecoratorFunction = (props: BlockDecoratorRenderProps) => JSX.Element
/** @beta */
export type ScrollSelectionIntoViewFunction = (
editor: PortableTextEditor,
domRange: globalThis.Range
) => void
/** @internal */
export type PortableTextMemberTypes = {
annotations: ObjectSchemaType[]
block: ObjectSchemaType
blockObjects: ObjectSchemaType[]
decorators: BlockDecoratorDefinition[]
inlineObjects: ObjectSchemaType[]
portableText: ArraySchemaType<PortableTextBlock>
span: ObjectSchemaType
styles: BlockStyleDefinition[]
lists: BlockListDefinition[]
}