forked from TypeCellOS/BlockNote
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBlockNoteEditor.ts
More file actions
1526 lines (1367 loc) · 47.9 KB
/
Copy pathBlockNoteEditor.ts
File metadata and controls
1526 lines (1367 loc) · 47.9 KB
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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {
AnyExtension,
EditorOptions,
Extension,
getSchema,
isNodeSelection,
Mark,
posToDOMRect,
Node as TipTapNode,
} from "@tiptap/core";
import { Node, Schema } from "prosemirror-model";
// import "./blocknote.css";
import * as Y from "yjs";
import { insertBlocks } from "../api/blockManipulation/commands/insertBlocks/insertBlocks.js";
import {
moveBlocksDown,
moveBlocksUp,
} from "../api/blockManipulation/commands/moveBlocks/moveBlocks.js";
import {
canNestBlock,
canUnnestBlock,
nestBlock,
unnestBlock,
} from "../api/blockManipulation/commands/nestBlock/nestBlock.js";
import { removeBlocks } from "../api/blockManipulation/commands/removeBlocks/removeBlocks.js";
import { replaceBlocks } from "../api/blockManipulation/commands/replaceBlocks/replaceBlocks.js";
import { updateBlock } from "../api/blockManipulation/commands/updateBlock/updateBlock.js";
import {
getBlock,
getNextBlock,
getParentBlock,
getPrevBlock,
} from "../api/blockManipulation/getBlock/getBlock.js";
import { insertContentAt } from "../api/blockManipulation/insertContentAt.js";
import {
getSelection,
setSelection,
} from "../api/blockManipulation/selections/selection.js";
import {
getTextCursorPosition,
setTextCursorPosition,
} from "../api/blockManipulation/selections/textCursorPosition/textCursorPosition.js";
import { createExternalHTMLExporter } from "../api/exporters/html/externalHTMLExporter.js";
import { blocksToMarkdown } from "../api/exporters/markdown/markdownExporter.js";
import { HTMLToBlocks } from "../api/parsers/html/parseHTML.js";
import {
markdownToBlocks,
markdownToHTML,
} from "../api/parsers/markdown/parseMarkdown.js";
import {
Block,
DefaultBlockSchema,
DefaultInlineContentSchema,
DefaultStyleSchema,
PartialBlock,
} from "../blocks/defaultBlocks.js";
import type { CommentsPlugin } from "../extensions/Comments/CommentsPlugin.js";
import { FilePanelProsemirrorPlugin } from "../extensions/FilePanel/FilePanelPlugin.js";
import { FormattingToolbarProsemirrorPlugin } from "../extensions/FormattingToolbar/FormattingToolbarPlugin.js";
import { LinkToolbarProsemirrorPlugin } from "../extensions/LinkToolbar/LinkToolbarPlugin.js";
import { ShowSelectionPlugin } from "../extensions/ShowSelection/ShowSelectionPlugin.js";
import { SideMenuProsemirrorPlugin } from "../extensions/SideMenu/SideMenuPlugin.js";
import { SuggestionMenuProseMirrorPlugin } from "../extensions/SuggestionMenu/SuggestionPlugin.js";
import { TableHandlesProsemirrorPlugin } from "../extensions/TableHandles/TableHandlesPlugin.js";
import { UniqueID } from "../extensions/UniqueID/UniqueID.js";
import {
BlockIdentifier,
BlockNoteDOMAttributes,
BlockSchema,
BlockSpecs,
InlineContentSchema,
InlineContentSpecs,
PartialInlineContent,
Styles,
StyleSchema,
StyleSpecs,
} from "../schema/index.js";
import { mergeCSSClasses } from "../util/browser.js";
import { NoInfer, UnreachableCaseError } from "../util/typescript.js";
import { getBlockNoteExtensions } from "./BlockNoteExtensions.js";
import { TextCursorPosition } from "./cursorPositionTypes.js";
import { Selection } from "./selectionTypes.js";
import { transformPasted } from "./transformPasted.js";
import { checkDefaultBlockTypeInSchema } from "../blocks/defaultBlockTypeGuards.js";
import { BlockNoteSchema } from "./BlockNoteSchema.js";
import {
BlockNoteTipTapEditor,
BlockNoteTipTapEditorOptions,
} from "./BlockNoteTipTapEditor.js";
import { Dictionary } from "../i18n/dictionary.js";
import { en } from "../i18n/locales/index.js";
import { Plugin, TextSelection, Transaction } from "@tiptap/pm/state";
import { dropCursor } from "prosemirror-dropcursor";
import { EditorView } from "prosemirror-view";
import { ySyncPluginKey } from "y-prosemirror";
import { createInternalHTMLSerializer } from "../api/exporters/html/internalHTMLSerializer.js";
import { inlineContentToNodes } from "../api/nodeConversions/blockToNode.js";
import { nodeToBlock } from "../api/nodeConversions/nodeToBlock.js";
import type { ThreadStore, User } from "../comments/index.js";
import "../style.css";
import { EventEmitter } from "../util/EventEmitter.js";
import { CodeBlockOptions } from "../blocks/CodeBlockContent/CodeBlockContent.js";
import { nestedListsToBlockNoteStructure } from "../api/parsers/html/util/nestedLists.js";
export type BlockNoteExtensionFactory = (
editor: BlockNoteEditor<any, any, any>
) => BlockNoteExtension;
export type BlockNoteExtension =
| AnyExtension
| {
plugin: Plugin;
};
export type BlockNoteEditorOptions<
BSchema extends BlockSchema,
ISchema extends InlineContentSchema,
SSchema extends StyleSchema
> = {
/**
* Whether changes to blocks (like indentation, creating lists, changing headings) should be animated or not. Defaults to `true`.
*
* @default true
*/
animations?: boolean;
/**
* When enabled, allows for collaboration between multiple users.
*/
collaboration: {
/**
* The Yjs XML fragment that's used for collaboration.
*/
fragment: Y.XmlFragment;
/**
* The user info for the current user that's shown to other collaborators.
*/
user: {
name: string;
color: string;
};
/**
* A Yjs provider (used for awareness / cursor information)
*/
provider: any;
/**
* Optional function to customize how cursors of users are rendered
*/
renderCursor?: (user: any) => HTMLElement;
/**
* Optional flag to set when the user label should be shown with the default
* collaboration cursor. Setting to "always" will always show the label,
* while "activity" will only show the label when the user moves the cursor
* or types. Defaults to "activity".
*/
showCursorLabels?: "always" | "activity";
};
/**
* Options for code blocks.
*/
codeBlock?: CodeBlockOptions;
comments: {
threadStore: ThreadStore;
};
/**
* Use default BlockNote font and reset the styles of <p> <li> <h1> elements etc., that are used in BlockNote.
*
* @default true
*/
defaultStyles: boolean;
/**
* A dictionary object containing translations for the editor.
*/
dictionary?: Dictionary & Record<string, any>;
/**
* Disable internal extensions (based on keys / extension name)
*/
disableExtensions: string[];
/**
* An object containing attributes that should be added to HTML elements of the editor.
*
* @example { editor: { class: "my-editor-class" } }
*/
domAttributes: Partial<BlockNoteDOMAttributes>;
dropCursor?: (opts: {
editor: BlockNoteEditor<
NoInfer<BSchema>,
NoInfer<ISchema>,
NoInfer<SSchema>
>;
color?: string | false;
width?: number;
class?: string;
}) => Plugin;
/**
* The content that should be in the editor when it's created, represented as an array of partial block objects.
*/
initialContent: PartialBlock<
NoInfer<BSchema>,
NoInfer<ISchema>,
NoInfer<SSchema>
>[];
/**
* @deprecated, provide placeholders via dictionary instead
*/
placeholders: Record<
string | "default" | "emptyDocument",
string | undefined
>;
/**
* Custom paste handler that can be used to override the default paste behavior.
* @returns The function should return `true` if the paste event was handled, otherwise it should return `false` if it should be canceled or `undefined` if it should be handled by another handler.
*
* @example
* ```ts
* pasteHandler: ({ defaultPasteHandler }) => {
* return defaultPasteHandler({ pasteBehavior: "prefer-html" });
* }
* ```
*/
pasteHandler?: (context: {
event: ClipboardEvent;
editor: BlockNoteEditor<BSchema, ISchema, SSchema>;
/**
* The default paste handler
* @param context The context object
* @returns Whether the paste event was handled or not
*/
defaultPasteHandler: (context?: {
/**
* Whether to prioritize Markdown content in `text/plain` over `text/html` when pasting from the clipboard.
* @default true
*/
prioritizeMarkdownOverHTML?: boolean;
/**
* Whether to parse `text/plain` content from the clipboard as Markdown content.
* @default true
*/
plainTextAsMarkdown?: boolean;
}) => boolean | undefined;
}) => boolean | undefined;
/**
* Resolve a URL of a file block to one that can be displayed or downloaded. This can be used for creating authenticated URL or
* implementing custom protocols / schemes
* @returns The URL that's
*/
resolveFileUrl: (url: string) => Promise<string>;
resolveUsers: (userIds: string[]) => Promise<User[]>;
schema: BlockNoteSchema<BSchema, ISchema, SSchema>;
/**
* A flag indicating whether to set an HTML ID for every block
*
* When set to `true`, on each block an id attribute will be set with the block id
* Otherwise, the HTML ID attribute will not be set.
*
* (note that the id is always set on the `data-id` attribute)
*/
setIdAttribute?: boolean;
/**
* The detection mode for showing the side menu - "viewport" always shows the
* side menu for the block next to the mouse cursor, while "editor" only shows
* it when hovering the editor or the side menu itself.
*
* @default "viewport"
*/
sideMenuDetection: "viewport" | "editor";
/**
Select desired behavior when pressing `Tab` (or `Shift-Tab`). Specifically,
what should happen when a user has selected multiple blocks while a toolbar
is open:
- `"prefer-navigate-ui"`: Change focus to the toolbar. The user needs to
first press `Escape` to close the toolbar, and can then indent multiple
blocks. Better for keyboard accessibility.
- `"prefer-indent"`: Regardless of whether toolbars are open, indent the
selection of blocks. In this case, it's not possible to navigate toolbars
with the keyboard.
@default "prefer-navigate-ui"
*/
tabBehavior: "prefer-navigate-ui" | "prefer-indent";
/**
* Allows enabling / disabling features of tables.
*/
tables?: {
/**
* Whether to allow splitting and merging cells within a table.
*
* @default false
*/
splitCells?: boolean;
/**
* Whether to allow changing the background color of cells.
*
* @default false
*/
cellBackgroundColor?: boolean;
/**
* Whether to allow changing the text color of cells.
*
* @default false
*/
cellTextColor?: boolean;
/**
* Whether to allow changing cells into headers.
*
* @default false
*/
headers?: boolean;
};
trailingBlock?: boolean;
/**
* The `uploadFile` method is what the editor uses when files need to be uploaded (for example when selecting an image to upload).
* This method should set when creating the editor as this is application-specific.
*
* `undefined` means the application doesn't support file uploads.
*
* @param file The file that should be uploaded.
* @returns The URL of the uploaded file OR an object containing props that should be set on the file block (such as an id)
*/
uploadFile: (
file: File,
blockId?: string
) => Promise<string | Record<string, any>>;
/**
* additional tiptap options, undocumented
*/
_tiptapOptions: Partial<EditorOptions>;
/**
* (experimental) add extra prosemirror plugins or tiptap extensions to the editor
*/
_extensions: Record<string, BlockNoteExtension | BlockNoteExtensionFactory>;
/**
* Boolean indicating whether the editor is in headless mode.
* Headless mode means we can use features like importing / exporting blocks,
* but there's no underlying editor (UI) instantiated.
*
* You probably don't need to set this manually, but use the `server-util` package instead that uses this option internally
*/
_headless: boolean;
};
const blockNoteTipTapOptions = {
enableInputRules: true,
enablePasteRules: true,
enableCoreExtensions: false,
};
export class BlockNoteEditor<
BSchema extends BlockSchema = DefaultBlockSchema,
ISchema extends InlineContentSchema = DefaultInlineContentSchema,
SSchema extends StyleSchema = DefaultStyleSchema
> extends EventEmitter<{
create: void;
}> {
/**
* The underlying prosemirror schema
*/
public readonly pmSchema: Schema;
/**
* extensions that are added to the editor, can be tiptap extensions or prosemirror plugins
*/
public readonly extensions: Record<string, BlockNoteExtension> = {};
/**
* Boolean indicating whether the editor is in headless mode.
* Headless mode means we can use features like importing / exporting blocks,
* but there's no underlying editor (UI) instantiated.
*
* You probably don't need to set this manually, but use the `server-util` package instead that uses this option internally
*/
public readonly headless: boolean = false;
public readonly _tiptapEditor:
| Omit<BlockNoteTipTapEditor, "view"> & {
view: EditorView | undefined;
contentComponent: any;
} = undefined as any; // TODO: Type should actually reflect that it can be `undefined` in headless mode
/**
* Used by React to store a reference to an `ElementRenderer` helper utility to make sure we can render React elements
* in the correct context (used by `ReactRenderUtil`)
*/
public elementRenderer: ((node: any, container: HTMLElement) => void) | null =
null;
/**
* Cache of all blocks. This makes sure we don't have to "recompute" blocks if underlying Prosemirror Nodes haven't changed.
* This is especially useful when we want to keep track of the same block across multiple operations,
* with this cache, blocks stay the same object reference (referential equality with ===).
*/
public blockCache = new WeakMap<Node, Block<any, any, any>>();
/**
* The dictionary contains translations for the editor.
*/
public readonly dictionary: Dictionary & Record<string, any>;
/**
* The schema of the editor. The schema defines which Blocks, InlineContent, and Styles are available in the editor.
*/
public readonly schema: BlockNoteSchema<BSchema, ISchema, SSchema>;
public readonly blockImplementations: BlockSpecs;
public readonly inlineContentImplementations: InlineContentSpecs;
public readonly styleImplementations: StyleSpecs;
public readonly formattingToolbar: FormattingToolbarProsemirrorPlugin;
public readonly linkToolbar: LinkToolbarProsemirrorPlugin<
BSchema,
ISchema,
SSchema
>;
public readonly sideMenu: SideMenuProsemirrorPlugin<
BSchema,
ISchema,
SSchema
>;
public readonly suggestionMenus: SuggestionMenuProseMirrorPlugin<
BSchema,
ISchema,
SSchema
>;
public readonly filePanel?: FilePanelProsemirrorPlugin<ISchema, SSchema>;
public readonly tableHandles?: TableHandlesProsemirrorPlugin<
ISchema,
SSchema
>;
public readonly comments?: CommentsPlugin;
private readonly showSelectionPlugin: ShowSelectionPlugin;
/**
* The `uploadFile` method is what the editor uses when files need to be uploaded (for example when selecting an image to upload).
* This method should set when creating the editor as this is application-specific.
*
* `undefined` means the application doesn't support file uploads.
*
* @param file The file that should be uploaded.
* @returns The URL of the uploaded file OR an object containing props that should be set on the file block (such as an id)
*/
public readonly uploadFile:
| ((file: File, blockId?: string) => Promise<string | Record<string, any>>)
| undefined;
private onUploadStartCallbacks: ((blockId?: string) => void)[] = [];
private onUploadEndCallbacks: ((blockId?: string) => void)[] = [];
public readonly resolveFileUrl?: (url: string) => Promise<string>;
public readonly resolveUsers?: (userIds: string[]) => Promise<User[]>;
/**
* Editor settings
*/
public readonly settings: {
tables: {
splitCells: boolean;
cellBackgroundColor: boolean;
cellTextColor: boolean;
headers: boolean;
};
codeBlock: CodeBlockOptions;
};
public static create<
BSchema extends BlockSchema = DefaultBlockSchema,
ISchema extends InlineContentSchema = DefaultInlineContentSchema,
SSchema extends StyleSchema = DefaultStyleSchema
>(options: Partial<BlockNoteEditorOptions<BSchema, ISchema, SSchema>> = {}) {
return new BlockNoteEditor<BSchema, ISchema, SSchema>(options);
}
protected constructor(
protected readonly options: Partial<BlockNoteEditorOptions<any, any, any>>
) {
super();
const anyOpts = options as any;
if (anyOpts.onEditorContentChange) {
throw new Error(
"onEditorContentChange initialization option is deprecated, use <BlockNoteView onChange={...} />, the useEditorChange(...) hook, or editor.onChange(...)"
);
}
if (anyOpts.onTextCursorPositionChange) {
throw new Error(
"onTextCursorPositionChange initialization option is deprecated, use <BlockNoteView onSelectionChange={...} />, the useEditorSelectionChange(...) hook, or editor.onSelectionChange(...)"
);
}
if (anyOpts.onEditorReady) {
throw new Error(
"onEditorReady is deprecated. Editor is immediately ready for use after creation."
);
}
if (anyOpts.editable) {
throw new Error(
"editable initialization option is deprecated, use <BlockNoteView editable={true/false} />, or alternatively editor.isEditable = true/false"
);
}
this.dictionary = options.dictionary || en;
this.settings = {
tables: {
splitCells: options?.tables?.splitCells ?? false,
cellBackgroundColor: options?.tables?.cellBackgroundColor ?? false,
cellTextColor: options?.tables?.cellTextColor ?? false,
headers: options?.tables?.headers ?? false,
},
codeBlock: {
indentLineWithTab: options?.codeBlock?.indentLineWithTab ?? true,
defaultLanguage: options?.codeBlock?.defaultLanguage ?? "text",
supportedLanguages: options?.codeBlock?.supportedLanguages ?? {},
createHighlighter: options?.codeBlock?.createHighlighter ?? undefined,
},
};
// apply defaults
const newOptions = {
defaultStyles: true,
schema: options.schema || BlockNoteSchema.create(),
_headless: false,
...options,
placeholders: {
...this.dictionary.placeholders,
...options.placeholders,
},
};
if (newOptions.comments && !newOptions.resolveUsers) {
throw new Error("resolveUsers is required when using comments");
}
this.resolveUsers = newOptions.resolveUsers;
// @ts-ignore
this.schema = newOptions.schema;
this.blockImplementations = newOptions.schema.blockSpecs;
this.inlineContentImplementations = newOptions.schema.inlineContentSpecs;
this.styleImplementations = newOptions.schema.styleSpecs;
this.extensions = getBlockNoteExtensions({
editor: this,
domAttributes: newOptions.domAttributes || {},
blockSpecs: this.schema.blockSpecs,
styleSpecs: this.schema.styleSpecs,
inlineContentSpecs: this.schema.inlineContentSpecs,
collaboration: newOptions.collaboration,
trailingBlock: newOptions.trailingBlock,
disableExtensions: newOptions.disableExtensions,
setIdAttribute: newOptions.setIdAttribute,
animations: newOptions.animations ?? true,
tableHandles: checkDefaultBlockTypeInSchema("table", this),
dropCursor: this.options.dropCursor ?? dropCursor,
placeholders: newOptions.placeholders,
tabBehavior: newOptions.tabBehavior,
sideMenuDetection: newOptions.sideMenuDetection || "viewport",
comments: newOptions.comments,
pasteHandler: newOptions.pasteHandler,
});
// add extensions from _tiptapOptions
(newOptions._tiptapOptions?.extensions || []).forEach((ext) => {
this.extensions[ext.name] = ext;
});
// add extensions from options
Object.entries(newOptions._extensions || {}).forEach(([key, ext]) => {
if (typeof ext === "function") {
// factory
ext = ext(this);
}
this.extensions[key] = ext;
});
this.formattingToolbar = this.extensions["formattingToolbar"] as any;
this.linkToolbar = this.extensions["linkToolbar"] as any;
this.sideMenu = this.extensions["sideMenu"] as any;
this.suggestionMenus = this.extensions["suggestionMenus"] as any;
this.filePanel = this.extensions["filePanel"] as any;
this.tableHandles = this.extensions["tableHandles"] as any;
this.comments = this.extensions["comments"] as any;
this.showSelectionPlugin = this.extensions["showSelection"] as any;
if (newOptions.uploadFile) {
const uploadFile = newOptions.uploadFile;
this.uploadFile = async (file, block) => {
this.onUploadStartCallbacks.forEach((callback) =>
callback.apply(this, [block])
);
try {
return await uploadFile(file, block);
} finally {
this.onUploadEndCallbacks.forEach((callback) =>
callback.apply(this, [block])
);
}
};
}
this.resolveFileUrl = newOptions.resolveFileUrl;
this.headless = newOptions._headless;
const collaborationEnabled =
"collaboration" in this.extensions ||
"liveblocksExtension" in this.extensions;
if (collaborationEnabled && newOptions.initialContent) {
// eslint-disable-next-line no-console
console.warn(
"When using Collaboration, initialContent might cause conflicts, because changes should come from the collaboration provider"
);
}
const initialContent =
newOptions.initialContent ||
(collaborationEnabled
? [
{
type: "paragraph",
id: "initialBlockId",
},
]
: [
{
type: "paragraph",
id: UniqueID.options.generateID(),
},
]);
if (!Array.isArray(initialContent) || initialContent.length === 0) {
throw new Error(
"initialContent must be a non-empty array of blocks, received: " +
initialContent
);
}
const tiptapExtensions = [
...Object.entries(this.extensions).map(([key, ext]) => {
if (
ext instanceof Extension ||
ext instanceof TipTapNode ||
ext instanceof Mark
) {
// tiptap extension
return ext;
}
if (!ext.plugin) {
throw new Error(
"Extension should either be a TipTap extension or a ProseMirror plugin in a plugin property"
);
}
// "blocknote" extensions (prosemirror plugins)
return Extension.create({
name: key,
addProseMirrorPlugins: () => [ext.plugin],
});
}),
];
const tiptapOptions: BlockNoteTipTapEditorOptions = {
...blockNoteTipTapOptions,
...newOptions._tiptapOptions,
content: initialContent,
extensions: tiptapExtensions,
editorProps: {
...newOptions._tiptapOptions?.editorProps,
attributes: {
// As of TipTap v2.5.0 the tabIndex is removed when the editor is not
// editable, so you can't focus it. We want to revert this as we have
// UI behaviour that relies on it.
tabIndex: "0",
...newOptions._tiptapOptions?.editorProps?.attributes,
...newOptions.domAttributes?.editor,
class: mergeCSSClasses(
"bn-editor",
newOptions.defaultStyles ? "bn-default-styles" : "",
newOptions.domAttributes?.editor?.class || ""
),
},
transformPasted,
},
};
if (!this.headless) {
this._tiptapEditor = BlockNoteTipTapEditor.create(
tiptapOptions,
this.schema.styleSchema
) as BlockNoteTipTapEditor & {
view: any;
contentComponent: any;
};
this.pmSchema = this._tiptapEditor.schema;
} else {
// In headless mode, we don't instantiate an underlying TipTap editor,
// but we still need the schema
this.pmSchema = getSchema(tiptapOptions.extensions!);
}
this.emit("create");
}
dispatch = (tr: Transaction) => {
this._tiptapEditor.dispatch(tr);
};
/**
* Mount the editor to a parent DOM element. Call mount(undefined) to clean up
*
* @warning Not needed to call manually when using React, use BlockNoteView to take care of mounting
*/
public mount = (
parentElement?: HTMLElement | null,
contentComponent?: any
) => {
this._tiptapEditor.mount(this, parentElement, contentComponent);
};
/**
* Get the underlying prosemirror view
*/
public get prosemirrorView() {
return this._tiptapEditor.view;
}
/**
* Get the underlying prosemirror state
*/
public get prosemirrorState() {
return this._tiptapEditor.state;
}
public get domElement() {
return this.prosemirrorView?.dom as HTMLDivElement | undefined;
}
public isFocused() {
return this.prosemirrorView?.hasFocus() || false;
}
public focus() {
this.prosemirrorView?.focus();
}
public onUploadStart(callback: (blockId?: string) => void) {
this.onUploadStartCallbacks.push(callback);
return () => {
const index = this.onUploadStartCallbacks.indexOf(callback);
if (index > -1) {
this.onUploadStartCallbacks.splice(index, 1);
}
};
}
public onUploadEnd(callback: (blockId?: string) => void) {
this.onUploadEndCallbacks.push(callback);
return () => {
const index = this.onUploadEndCallbacks.indexOf(callback);
if (index > -1) {
this.onUploadEndCallbacks.splice(index, 1);
}
};
}
/**
* @deprecated, use `editor.document` instead
*/
public get topLevelBlocks(): Block<BSchema, ISchema, SSchema>[] {
return this.document;
}
/**
* Gets a snapshot of all top-level (non-nested) blocks in the editor.
* @returns A snapshot of all top-level (non-nested) blocks in the editor.
*/
public get document(): Block<BSchema, ISchema, SSchema>[] {
const blocks: Block<BSchema, ISchema, SSchema>[] = [];
this.prosemirrorState.doc.firstChild!.descendants((node) => {
blocks.push(
nodeToBlock(
node,
this.schema.blockSchema,
this.schema.inlineContentSchema,
this.schema.styleSchema,
this.blockCache
)
);
return false;
});
return blocks;
}
/**
* Gets a snapshot of an existing block from the editor.
* @param blockIdentifier The identifier of an existing block that should be
* retrieved.
* @returns The block that matches the identifier, or `undefined` if no
* matching block was found.
*/
public getBlock(
blockIdentifier: BlockIdentifier
): Block<BSchema, ISchema, SSchema> | undefined {
return getBlock(this, blockIdentifier);
}
/**
* Gets a snapshot of the previous sibling of an existing block from the
* editor.
* @param blockIdentifier The identifier of an existing block for which the
* previous sibling should be retrieved.
* @returns The previous sibling of the block that matches the identifier.
* `undefined` if no matching block was found, or it's the first child/block
* in the document.
*/
public getPrevBlock(
blockIdentifier: BlockIdentifier
): Block<BSchema, ISchema, SSchema> | undefined {
return getPrevBlock(this, blockIdentifier);
}
/**
* Gets a snapshot of the next sibling of an existing block from the editor.
* @param blockIdentifier The identifier of an existing block for which the
* next sibling should be retrieved.
* @returns The next sibling of the block that matches the identifier.
* `undefined` if no matching block was found, or it's the last child/block in
* the document.
*/
public getNextBlock(
blockIdentifier: BlockIdentifier
): Block<BSchema, ISchema, SSchema> | undefined {
return getNextBlock(this, blockIdentifier);
}
/**
* Gets a snapshot of the parent of an existing block from the editor.
* @param blockIdentifier The identifier of an existing block for which the
* parent should be retrieved.
* @returns The parent of the block that matches the identifier. `undefined`
* if no matching block was found, or the block isn't nested.
*/
public getParentBlock(
blockIdentifier: BlockIdentifier
): Block<BSchema, ISchema, SSchema> | undefined {
return getParentBlock(this, blockIdentifier);
}
/**
* Traverses all blocks in the editor depth-first, and executes a callback for each.
* @param callback The callback to execute for each block. Returning `false` stops the traversal.
* @param reverse Whether the blocks should be traversed in reverse order.
*/
public forEachBlock(
callback: (block: Block<BSchema, ISchema, SSchema>) => boolean,
reverse = false
): void {
const blocks = this.document.slice();
if (reverse) {
blocks.reverse();
}
function traverseBlockArray(
blockArray: Block<BSchema, ISchema, SSchema>[]
): boolean {
for (const block of blockArray) {
if (callback(block) === false) {
return false;
}
const children = reverse
? block.children.slice().reverse()
: block.children;
if (!traverseBlockArray(children)) {
return false;
}
}
return true;
}
traverseBlockArray(blocks);
}
/**
* Executes a callback whenever the editor's contents change.
* @param callback The callback to execute.
*
* @deprecated use `onChange` instead
*/
public onEditorContentChange(callback: () => void) {
this._tiptapEditor.on("update", callback);
}
/**
* Executes a callback whenever the editor's selection changes.
* @param callback The callback to execute.
*
* @deprecated use `onSelectionChange` instead
*/
public onEditorSelectionChange(callback: () => void) {
this._tiptapEditor.on("selectionUpdate", callback);
}
/**
* Gets a snapshot of the current text cursor position.
* @returns A snapshot of the current text cursor position.
*/
public getTextCursorPosition(): TextCursorPosition<
BSchema,
ISchema,
SSchema
> {
return getTextCursorPosition(this);
}
/**
* Sets the text cursor position to the start or end of an existing block. Throws an error if the target block could
* not be found.
* @param targetBlock The identifier of an existing block that the text cursor should be moved to.
* @param placement Whether the text cursor should be placed at the start or end of the block.
*/
public setTextCursorPosition(
targetBlock: BlockIdentifier,
placement: "start" | "end" = "start"
) {
setTextCursorPosition(this, targetBlock, placement);
}
/**
* Gets a snapshot of the current selection.
*/
public getSelection(): Selection<BSchema, ISchema, SSchema> | undefined {
return getSelection(this);
}
public setSelection(startBlock: BlockIdentifier, endBlock: BlockIdentifier) {
setSelection(this, startBlock, endBlock);
}
/**
* Checks if the editor is currently editable, or if it's locked.
* @returns True if the editor is editable, false otherwise.
*/
public get isEditable(): boolean {
if (!this._tiptapEditor) {
if (!this.headless) {
throw new Error("no editor, but also not headless?");
}
return false;
}
return this._tiptapEditor.isEditable === undefined
? true
: this._tiptapEditor.isEditable;
}
/**
* Makes the editor editable or locks it, depending on the argument passed.
* @param editable True to make the editor editable, or false to lock it.
*/
public set isEditable(editable: boolean) {
if (!this._tiptapEditor) {
if (!this.headless) {
throw new Error("no editor, but also not headless?");
}
// not relevant on headless
return;
}