Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 3x 3x 3x 3x 3x 3x 3x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | import { BridgePlugin } from '../corePlugins/BridgePlugin'; import { buildRangeEx } from './utils/buildRangeEx'; import { insertNode } from './utils/insertNode'; import { getObjectKeys, isBold, retrieveModelFormatState, transformColor, } from 'roosterjs-content-model-dom'; import type { EditorAdapterCore } from '../corePlugins/BridgePlugin'; import { newEventToOldEvent, oldEventToNewEvent, OldEventTypeToNewEventType, } from './utils/eventConverter'; import { createModelFromHtml, exportContent, redo, Editor, undo, paste, } from 'roosterjs-content-model-core'; import { ChangeSource, ColorTransformDirection, ContentPosition, GetContentMode, PluginEventType, QueryScope, RegionType, } from 'roosterjs-editor-types'; import type { BlockElement, ClipboardData, ContentChangedData, ContentChangedEvent, DOMEventHandler, DefaultFormat, EditorUndoState, ExperimentalFeatures, GenericContentEditFeature, IContentTraverser, IPositionContentSearcher, InsertOption, NodePosition, PendableFormatState, PluginEvent, PluginEventData, PluginEventFromType, PositionType, Region, SelectionPath, SelectionRangeEx, SizeTransformer, StyleBasedFormatState, TableSelection, DOMEventHandlerObject, DarkColorHandler, IEditor as ILegacyEditor, } from 'roosterjs-editor-types'; import { convertDomSelectionToRangeEx, convertRangeExToDomSelection, } from './utils/selectionConverter'; import type { CompatibleChangeSource, CompatibleColorTransformDirection, CompatibleContentPosition, CompatibleExperimentalFeatures, CompatibleGetContentMode, CompatiblePluginEventType, CompatibleQueryScope, CompatibleRegionType, } from 'roosterjs-editor-types/lib/compatibleTypes'; import { ContentTraverser, Position, PositionContentSearcher, cacheGetEventData, collapseNodes, contains, deleteSelectedContent, getBlockElementAtNode, getRegionsFromRange, getSelectionPath, isNodeEmpty, isPositionAtBeginningOf, queryElements, toArray, wrap, } from 'roosterjs-editor-dom'; import type { EditorAdapterOptions } from '../publicTypes/EditorAdapterOptions'; import type { ContentModelFormatState, DOMEventRecord, ExportContentMode, IEditor, EditorOptions, } from 'roosterjs-content-model-types'; const GetContentModeMap: Record<GetContentMode, ExportContentMode> = { [GetContentMode.CleanHTML]: 'HTML', [GetContentMode.PlainText]: 'PlainText', [GetContentMode.PlainTextFast]: 'PlainTextFast', [GetContentMode.RawHTMLOnly]: 'HTML', [GetContentMode.RawHTMLWithSelection]: 'HTML', }; /** * Editor for Content Model. */ export class EditorAdapter extends Editor implements ILegacyEditor { private contentModelEditorCore: EditorAdapterCore | undefined; /** * Creates an instance of Editor * @param contentDiv The DIV HTML element which will be the container element of editor * @param options An optional options object to customize the editor */ constructor(contentDiv: HTMLDivElement, options: EditorAdapterOptions = {}) { const bridgePlugin = new BridgePlugin( core => { this.contentModelEditorCore = core; return this; }, options.legacyPlugins, options.experimentalFeatures ); const plugins = [bridgePlugin, ...(options.plugins ?? [])]; const initContent = options.initialContent ?? contentDiv.innerHTML; const initialModel = initContent && !options.initialModel ? createModelFromHtml( initContent, options.defaultDomToModelOptions, options.trustedHTMLHandler, options.defaultSegmentFormat ) : options.initialModel; const standaloneEditorOptions: EditorOptions = { ...options, plugins, initialModel, }; super(contentDiv, standaloneEditorOptions); } /** * Dispose this editor, dispose all plugins and custom data */ dispose(): void { super.dispose(); const core = this.contentModelEditorCore; Eif (core) { getObjectKeys(core.customData).forEach(key => { const data = core.customData[key]; if (data && data.disposer) { data.disposer(data.value); } delete core.customData[key]; }); this.contentModelEditorCore = undefined; } } /** * Get whether this editor is disposed * @returns True if editor is disposed, otherwise false */ isDisposed(): boolean { return super.isDisposed() || !this.contentModelEditorCore; } /** * Insert node into editor * @param node The node to insert * @param option Insert options. Default value is: * position: ContentPosition.SelectionStart * updateCursor: true * replaceSelection: true * insertOnNewLine: false * @returns true if node is inserted. Otherwise false */ insertNode(node: Node, option?: InsertOption): boolean { if (node) { option = option || { position: ContentPosition.SelectionStart, insertOnNewLine: false, updateCursor: true, replaceSelection: true, insertToRegionRoot: false, }; const { physicalRoot } = this.getCore(); if (option.updateCursor) { this.focus(); } if (option.position == ContentPosition.Outside) { physicalRoot.parentNode?.insertBefore(node, physicalRoot.nextSibling); } else { if (this.isDarkMode()) { transformColor( node, true /*includeSelf*/, 'lightToDark', this.getColorManager() ); } const selection = insertNode(physicalRoot, this.getDOMSelection(), node, option); if (selection && option.updateCursor) { this.setDOMSelection(selection); } } return true; } else { return false; } } /** * Delete a node from editor content * @param node The node to delete * @returns true if node is deleted. Otherwise false */ deleteNode(node: Node): boolean { // Only remove the node when it falls within editor if (node && this.contains(node) && node.parentNode) { node.parentNode.removeChild(node); return true; } return false; } /** * Replace a node in editor content with another node * @param existingNode The existing node to be replaced * @param toNode node to replace to * @param transformColorForDarkMode (optional) Whether to transform new node to dark mode. Default is false * @returns true if node is replaced. Otherwise false */ replaceNode(existingNode: Node, toNode: Node, transformColorForDarkMode?: boolean): boolean { const core = this.getCore(); // Only replace the node when it falls within editor if (this.contains(existingNode) && toNode) { if (core.lifecycle.isDarkMode && transformColorForDarkMode) { this.transformToDarkColor(toNode, ColorTransformDirection.LightToDark); } existingNode.parentNode?.replaceChild(toNode, existingNode); return true; } return false; } /** * Get BlockElement at given node * @param node The node to create InlineElement * @returns The BlockElement result */ getBlockElementAtNode(node: Node): BlockElement | null { return getBlockElementAtNode(this.getCore().logicalRoot, node); } contains(arg: Node | Range | null): boolean { if (!arg) { return false; } return contains(this.getCore().logicalRoot, <Node>arg); } queryElements( selector: string, scopeOrCallback: | QueryScope | CompatibleQueryScope | ((node: Node) => any) = QueryScope.Body, callback?: (node: Node) => any ) { const core = this.getCore(); const result: HTMLElement[] = []; const scope = scopeOrCallback instanceof Function ? QueryScope.Body : scopeOrCallback; callback = scopeOrCallback instanceof Function ? scopeOrCallback : callback; const selectionEx = scope == QueryScope.Body ? null : this.getSelectionRangeEx(); if (selectionEx) { selectionEx.ranges.forEach(range => { result.push(...queryElements(core.logicalRoot, selector, callback, scope, range)); }); } else { return queryElements( core.logicalRoot, selector, callback, scope, undefined /* range */ ); } return result; } /** * Collapse nodes within the given start and end nodes to their common ancestor node, * split parent nodes if necessary * @param start The start node * @param end The end node * @param canSplitParent True to allow split parent node there are nodes before start or after end under the same parent * and the returned nodes will be all nodes from start through end after splitting * False to disallow split parent * @returns When canSplitParent is true, returns all node from start through end after splitting, * otherwise just return start and end */ collapseNodes(start: Node, end: Node, canSplitParent: boolean): Node[] { return collapseNodes(this.getCore().physicalRoot, start, end, canSplitParent); } //#endregion //#region Content API /** * Check whether the editor contains any visible content * @param trim Whether trim the content string before check. Default is false * @returns True if there's no visible content, otherwise false */ isEmpty(trim?: boolean): boolean { return isNodeEmpty(this.getCore().physicalRoot, trim); } /** * Get current editor content as HTML string * @param mode specify what kind of HTML content to retrieve * @returns HTML string representing current editor content */ getContent(mode: GetContentMode | CompatibleGetContentMode = GetContentMode.CleanHTML): string { const exportMode = GetContentModeMap[mode] ?? 'HTML'; switch (exportMode) { case 'HTML': return exportContent( this, 'HTML', this.getCore().environment.modelToDomSettings.customized ); case 'PlainText': return exportContent(this, 'PlainText'); case 'PlainTextFast': return exportContent(this, 'PlainTextFast'); } } /** * Set HTML content to this editor. All existing content will be replaced. A ContentChanged event will be triggered * @param content HTML content to set in * @param triggerContentChangedEvent True to trigger a ContentChanged event. Default value is true */ setContent(content: string, triggerContentChangedEvent: boolean = true) { const core = this.getCore(); const { physicalRoot, api, trustedHTMLHandler, lifecycle, darkColorHandler } = core; api.triggerEvent( core, { eventType: 'beforeSetContent', newContent: content, }, true /*broadcast*/ ); const newModel = createModelFromHtml( content, core.environment.domToModelSettings.customized, trustedHTMLHandler, core.format.defaultFormat ); api.setContentModel(core, newModel); if (triggerContentChangedEvent) { api.triggerEvent( core, { eventType: 'contentChanged', source: ChangeSource.SetContent, }, false /*broadcast*/ ); } else if (lifecycle.isDarkMode) { transformColor(physicalRoot, false /*includeSelf*/, 'lightToDark', darkColorHandler); } } /** * Insert HTML content into editor * @param HTML content to insert * @param option Insert options. Default value is: * position: ContentPosition.SelectionStart * updateCursor: true * replaceSelection: true * insertOnNewLine: false */ insertContent(content: string, option?: InsertOption) { if (content) { const doc = this.getDocument(); const body = this.getCore().domCreator.htmlToDOM(content)?.body; let allNodes = body?.childNodes ? toArray(body.childNodes) : []; // If it is to insert on new line, and there are more than one node in the collection, wrap all nodes with // a parent DIV before calling insertNode on each top level sub node. Otherwise, every sub node may get wrapped // separately to show up on its own line if (option && option.insertOnNewLine && allNodes.length > 1) { allNodes = [wrap(allNodes)]; } const fragment = doc.createDocumentFragment(); allNodes.forEach(node => fragment.appendChild(node)); this.insertNode(fragment, option); } } /** * Delete selected content */ deleteSelectedContent(): NodePosition | null { const range = this.getSelectionRange(); if (range && !range.collapsed) { return deleteSelectedContent(this.getCore().physicalRoot, range); } return null; } /** * Paste into editor using a clipboardData object * @param clipboardData Clipboard data retrieved from clipboard * @param pasteAsText Force pasting as plain text. Default value is false * @param applyCurrentStyle True if apply format of current selection to the pasted content, * false to keep original format. Default value is false. When pasteAsText is true, this parameter is ignored * @param pasteAsImage: When set to true, if the clipboardData contains a imageDataUri will paste the image to the editor */ paste( clipboardData: ClipboardData, pasteAsText: boolean = false, applyCurrentFormat: boolean = false, pasteAsImage: boolean = false ) { paste( this, clipboardData, pasteAsText ? 'asPlainText' : applyCurrentFormat ? 'mergeFormat' : pasteAsImage ? 'asImage' : 'normal' ); } //#endregion //#region Focus and Selection /** * Get current selection range from Editor. * It does a live pull on the selection, if nothing retrieved, return whatever we have in cache. * @param tryGetFromCache Set to true to retrieve the selection range from cache if editor doesn't own the focus now. * Default value is true * @returns current selection range, or null if editor never got focus before */ getSelectionRange(tryGetFromCache: boolean = true): Range | null { const selection = this.getDOMSelection(); return selection?.type == 'range' ? selection.range : null; } /** * Get current selection range from Editor. * It does a live pull on the selection, if nothing retrieved, return whatever we have in cache. * @param tryGetFromCache Set to true to retrieve the selection range from cache if editor doesn't own the focus now. * Default value is true * @returns current selection range, or null if editor never got focus before */ getSelectionRangeEx(): SelectionRangeEx { const selection = this.getDOMSelection(); return convertDomSelectionToRangeEx(selection); } /** * Get current selection in a serializable format * It does a live pull on the selection, if nothing retrieved, return whatever we have in cache. * @returns current selection path, or null if editor never got focus before */ getSelectionPath(): SelectionPath | null { const range = this.getSelectionRange(); return range && getSelectionPath(this.getCore().physicalRoot, range); } select( arg1: Range | SelectionRangeEx | NodePosition | Node | SelectionPath | null, arg2?: NodePosition | number | PositionType | TableSelection | null, arg3?: Node, arg4?: number | PositionType ): boolean { const core = this.getCore(); const rangeEx = buildRangeEx(core.physicalRoot, arg1, arg2, arg3, arg4); const selection = convertRangeExToDomSelection(rangeEx); this.setDOMSelection(selection); return true; } /** * Get current focused position. Return null if editor doesn't have focus at this time. */ getFocusedPosition(): NodePosition | null { const sel = this.getDocument().defaultView?.getSelection(); if (sel?.focusNode && this.contains(sel.focusNode)) { return new Position(sel.focusNode, sel.focusOffset); } const range = this.getSelectionRange(); if (range) { return Position.getStart(range); } return null; } /** * Get an HTML element from current cursor position. * When expectedTags is not specified, return value is the current node (if it is HTML element) * or its parent node (if current node is a Text node). * When expectedTags is specified, return value is the first ancestor of current node which has * one of the expected tags. * If no element found within editor by the given tag, return null. * @param selector Optional, an HTML selector to find HTML element with. * @param startFrom Start search from this node. If not specified, start from current focused position * @param event Optional, if specified, editor will try to get cached result from the event object first. * If it is not cached before, query from DOM and cache the result into the event object */ getElementAtCursor( selector?: string, startFrom?: Node, event?: PluginEvent ): HTMLElement | null { event = startFrom ? undefined : event; // Only use cache when startFrom is not specified, for different start position can have different result return ( cacheGetEventData(event ?? null, 'GET_ELEMENT_AT_CURSOR_' + selector, () => { if (!startFrom) { const position = this.getFocusedPosition(); startFrom = position?.node; } return ( startFrom && this.getDOMHelper().findClosestElementAncestor(startFrom, selector) ); }) ?? null ); } /** * Check if this position is at beginning of the editor. * This will return true if all nodes between the beginning of target node and the position are empty. * @param position The position to check * @returns True if position is at beginning of the editor, otherwise false */ isPositionAtBeginning(position: NodePosition): boolean { return isPositionAtBeginningOf(position, this.getCore().logicalRoot); } /** * Get impacted regions from selection */ getSelectedRegions(type: RegionType | CompatibleRegionType = RegionType.Table): Region[] { const selection = this.getSelectionRangeEx(); const result: Region[] = []; const logicalRoot = this.getCore().logicalRoot; selection.ranges.forEach(range => { result.push(...(range ? getRegionsFromRange(logicalRoot, range, type) : [])); }); return result.filter((value, index, self) => { return self.indexOf(value) === index; }); } //#endregion //#region EVENT API addDomEventHandler( nameOrMap: string | Record<string, DOMEventHandler>, handler?: DOMEventHandler ): () => void { const eventsMap = typeof nameOrMap == 'string' ? { [nameOrMap]: handler! } : nameOrMap; const eventsMapResult: Record<string, DOMEventRecord> = {}; getObjectKeys(eventsMap).forEach(key => { const handlerObj = eventsMap[key]; let result: DOMEventRecord = { pluginEventType: null, beforeDispatch: null, }; if (typeof handlerObj === 'number') { result.pluginEventType = OldEventTypeToNewEventType[handlerObj as PluginEventType]; } else if (typeof handlerObj === 'function') { result.beforeDispatch = handlerObj; } else if (typeof handlerObj === 'object') { const record = handlerObj as DOMEventHandlerObject; result = { beforeDispatch: record.beforeDispatch, pluginEventType: typeof record.pluginEventType == 'number' ? OldEventTypeToNewEventType[record.pluginEventType] : undefined, }; } eventsMapResult[key] = result; }); return this.attachDomEvent(eventsMapResult); } /** * Trigger an event to be dispatched to all plugins * @param eventType Type of the event * @param data data of the event with given type, this is the rest part of PluginEvent with the given type * @param broadcast indicates if the event needs to be dispatched to all plugins * True means to all, false means to allow exclusive handling from one plugin unless no one wants that * @returns the event object which is really passed into plugins. Some plugin may modify the event object so * the result of this function provides a chance to read the modified result */ public triggerPluginEvent<T extends PluginEventType | CompatiblePluginEventType>( eventType: T, data: PluginEventData<T>, broadcast: boolean = false ): PluginEventFromType<T> { const oldEvent = { eventType, ...data, } as PluginEvent; const newEvent = oldEventToNewEvent(oldEvent); const core = this.getCore(); if (newEvent) { core.api.triggerEvent(core, newEvent, broadcast); return (newEventToOldEvent(newEvent, oldEvent) ?? oldEvent) as PluginEventFromType<T>; } else { return oldEvent as PluginEventFromType<T>; } } /** * Trigger a ContentChangedEvent * @param source Source of this event, by default is 'SetContent' * @param data additional data for this event */ triggerContentChangedEvent( source: ChangeSource | CompatibleChangeSource | string = ChangeSource.SetContent, data?: any ) { this.triggerPluginEvent(PluginEventType.ContentChanged, { source, data, }); } //#endregion //#region Undo API /** * Undo last edit operation */ undo() { undo(this); } /** * Redo next edit operation */ redo() { redo(this); } /** * Add undo snapshot, and execute a format callback function, then add another undo snapshot, then trigger * ContentChangedEvent with given change source. * If this function is called nested, undo snapshot will only be added in the outside one * @param callback The callback function to perform formatting, returns a data object which will be used as * the data field in ContentChangedEvent if changeSource is not null. * @param changeSource The change source to use when fire ContentChangedEvent. When the value is not null, * a ContentChangedEvent will be fired with change source equal to this value * @param canUndoByBackspace True if this action can be undone when user press Backspace key (aka Auto Complete). */ addUndoSnapshot( callback?: (start: NodePosition | null, end: NodePosition | null) => any, changeSource?: ChangeSource | CompatibleChangeSource | string, canUndoByBackspace?: boolean, additionalData?: ContentChangedData ) { const core = this.getCore(); const undoState = core.undo; const isNested = undoState.isNested; let data: any; if (!isNested) { undoState.isNested = true; // When there is getEntityState, it means this is triggered by an entity change. // So if HTML content is not changed (hasNewContent is false), no need to add another snapshot before change if ( core.undo.snapshotsManager.hasNewContent || !additionalData?.getEntityState || !callback ) { core.api.addUndoSnapshot( core, !!canUndoByBackspace, additionalData?.getEntityState?.() ); } } try { if (callback) { const selection = core.api.getDOMSelection(core); const range = selection?.type == 'range' ? selection.range : null; data = callback( range && Position.getStart(range).normalize(), range && Position.getEnd(range).normalize() ); if (!isNested) { const entityStates = additionalData?.getEntityState?.(); core.api.addUndoSnapshot(core, false /*isAutoCompleteSnapshot*/, entityStates); } } } finally { if (!isNested) { undoState.isNested = false; } } if (callback && changeSource) { const event: ContentChangedEvent = { eventType: PluginEventType.ContentChanged, source: changeSource, data: data, additionalData, }; this.triggerPluginEvent(PluginEventType.ContentChanged, event, true /*broadcast*/); } if (canUndoByBackspace) { const selection = core.api.getDOMSelection(core); if (selection?.type == 'range') { core.undo.snapshotsManager.hasNewContent = false; core.undo.autoCompleteInsertPoint = { node: selection.range.startContainer, offset: selection.range.startOffset, }; } } } /** * Whether there is an available undo/redo snapshot */ getUndoState(): EditorUndoState { const { snapshotsManager } = this.getCore().undo; return { canUndo: snapshotsManager.hasNewContent || snapshotsManager.canMove(-1 /*previousSnapshot*/), canRedo: snapshotsManager.canMove(1 /*nextSnapshot*/), }; } //#endregion //#region Misc /** * Get custom data related to this editor * @param key Key of the custom data * @param getter Getter function. If custom data for the given key doesn't exist, * call this function to get one and store it if it is specified. Otherwise return undefined * @param disposer An optional disposer function to dispose this custom data when * dispose editor. */ getCustomData<T>(key: string, getter?: () => T, disposer?: (value: T) => void): T { const core = this.getContentModelEditorCore(); return (core.customData[key] = core.customData[key] || { value: getter ? getter() : undefined, disposer, }).value as T; } /** * Get default format of this editor * @returns Default format object of this editor */ getDefaultFormat(): DefaultFormat { const format = this.getCore().format.defaultFormat; return { bold: isBold(format.fontWeight), italic: format.italic, underline: format.underline, fontFamily: format.fontFamily, fontSize: format.fontSize, textColor: format.textColor, backgroundColor: format.backgroundColor, }; } /** * Get a content traverser for the whole editor * @param startNode The node to start from. If not passed, it will start from the beginning of the body */ getBodyTraverser(startNode?: Node): IContentTraverser { return ContentTraverser.createBodyTraverser(this.getCore().logicalRoot, startNode); } /** * Get a content traverser for current selection * @returns A content traverser, or null if editor never got focus before */ getSelectionTraverser(range?: Range): IContentTraverser | null { range = range ?? this.getSelectionRange() ?? undefined; return range ? ContentTraverser.createSelectionTraverser(this.getCore().logicalRoot, range) : null; } /** * Get a content traverser for current block element start from specified position * @param startFrom Start position of the traverser. Default value is ContentPosition.SelectionStart * @returns A content traverser, or null if editor never got focus before */ getBlockTraverser( startFrom: ContentPosition | CompatibleContentPosition = ContentPosition.SelectionStart ): IContentTraverser | null { const range = this.getSelectionRange(); return range ? ContentTraverser.createBlockTraverser(this.getCore().logicalRoot, range, startFrom) : null; } /** * Get a text traverser of current selection * @param event Optional, if specified, editor will try to get cached result from the event object first. * If it is not cached before, query from DOM and cache the result into the event object * @returns A content traverser, or null if editor never got focus before */ getContentSearcherOfCursor(event?: PluginEvent): IPositionContentSearcher | null { return cacheGetEventData(event ?? null, 'ContentSearcher', () => { const range = this.getSelectionRange(); return ( range && new PositionContentSearcher(this.getCore().logicalRoot, Position.getStart(range)) ); }); } /** * Run a callback function asynchronously * @param callback The callback function to run * @returns a function to cancel this async run */ runAsync(callback: (editor: ILegacyEditor & IEditor) => void) { const win = this.getCore().physicalRoot.ownerDocument.defaultView || window; const handle = win.requestAnimationFrame(() => { if (!this.isDisposed() && callback) { callback(this); } }); return () => { win.cancelAnimationFrame(handle); }; } /** * Set DOM attribute of editor content DIV * @param name Name of the attribute * @param value Value of the attribute */ setEditorDomAttribute(name: string, value: string | null) { this.getDOMHelper().setDomAttribute(name, value); } /** * Get DOM attribute of editor content DIV, null if there is no such attribute. * @param name Name of the attribute */ getEditorDomAttribute(name: string): string | null { return this.getDOMHelper().getDomAttribute(name); } /** * @deprecated Use getVisibleViewport() instead. * * Get current relative distance from top-left corner of the given element to top-left corner of editor content DIV. * @param element The element to calculate from. If the given element is not in editor, return value will be null * @param addScroll When pass true, The return value will also add scrollLeft and scrollTop if any. So the value * may be different than what user is seeing from the view. When pass false, scroll position will be ignored. * @returns An [x, y] array which contains the left and top distances, or null if the given element is not in editor. */ getRelativeDistanceToEditor(element: HTMLElement, addScroll?: boolean): number[] | null { if (this.contains(element)) { const physicalRoot = this.getCore().physicalRoot; const editorRect = physicalRoot.getBoundingClientRect(); const elementRect = element.getBoundingClientRect(); if (editorRect && elementRect) { let x = elementRect.left - editorRect?.left; let y = elementRect.top - editorRect?.top; if (addScroll) { x += physicalRoot.scrollLeft; y += physicalRoot.scrollTop; } return [x, y]; } } return null; } /** * Add a Content Edit feature. * @param feature The feature to add */ addContentEditFeature(feature: GenericContentEditFeature<PluginEvent>) { const core = this.getContentModelEditorCore(); feature?.keys.forEach(key => { const array = core.edit.features[key] || []; array.push(feature); core.edit.features[key] = array; }); } /** * Remove a Content Edit feature. * @param feature The feature to remove */ removeContentEditFeature(feature: GenericContentEditFeature<PluginEvent>) { const core = this.getContentModelEditorCore(); feature?.keys.forEach(key => { const featureSet = core.edit.features[key]; const index = featureSet?.indexOf(feature) ?? -1; if (index >= 0) { core.edit.features[key].splice(index, 1); if (core.edit.features[key].length < 1) { delete core.edit.features[key]; } } }); } /** * @deprecated * Get style based format state from current selection, including font name/size and colors */ getStyleBasedFormatState(): StyleBasedFormatState { const format = this.retrieveFormatState(); return { backgroundColor: format.backgroundColor, direction: format.direction, fontName: format.fontName, fontSize: format.fontSize, fontWeight: format.fontWeight, lineHeight: format.lineHeight, marginBottom: format.marginBottom, marginTop: format.marginTop, textAlign: format.textAlign, textColor: format.textColor, }; } /** * @deprecated * Get the pendable format such as underline and bold * @returns The pending format state */ getPendableFormatState(): PendableFormatState { const format = this.retrieveFormatState(); return { isBold: format.isBold, isItalic: format.isItalic, isStrikeThrough: format.isStrikeThrough, isSubscript: format.isSubscript, isSuperscript: format.isSubscript, isUnderline: format.isUnderline, }; } /** * @deprecated * Ensure user will type into a container element rather than into the editor content DIV directly * @param position The position that user is about to type to * @param keyboardEvent Optional keyboard event object */ ensureTypeInContainer(position: NodePosition, keyboardEvent?: KeyboardEvent) { // No OP } //#endregion //#region Dark mode APIs /** * Transform the given node and all its child nodes to dark mode color if editor is in dark mode * @param node The node to transform * @param direction The transform direction. @default ColorTransformDirection.LightToDark */ transformToDarkColor( node: Node, direction: | ColorTransformDirection | CompatibleColorTransformDirection = ColorTransformDirection.LightToDark ) { const core = this.getCore(); if (core.lifecycle.isDarkMode) { transformColor( node, true /*includeSelf*/, direction == ColorTransformDirection.DarkToLight ? 'darkToLight' : 'lightToDark', core.darkColorHandler ); } } /** * Check if the given experimental feature is enabled * @param feature The feature to check */ isFeatureEnabled(feature: ExperimentalFeatures | CompatibleExperimentalFeatures): boolean { return ( this.getContentModelEditorCore().experimentalFeatures.indexOf( feature as ExperimentalFeatures ) >= 0 ); } /** * Get current zoom scale, default value is 1 * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale * to let editor behave correctly especially for those mouse drag/drop behaviors * @returns current zoom scale number */ getZoomScale(): number { return this.getDOMHelper().calculateZoomScale(); } /** * Set current zoom scale, default value is 1 * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale * to let editor behave correctly especially for those mouse drag/drop behaviors * @param scale The new scale number to set. It should be positive number and no greater than 10, otherwise it will be ignored. */ setZoomScale(scale: number): void { if (scale > 0 && scale <= 10) { this.triggerEvent( 'zoomChanged', { newZoomScale: scale, }, true /*broadcast*/ ); } } /** * @deprecated Use getZoomScale() instead */ getSizeTransformer(): SizeTransformer { return this.getContentModelEditorCore().sizeTransformer; } /** * Get a darkColorHandler object for this editor. */ getDarkColorHandler(): DarkColorHandler { const core = this.getContentModelEditorCore(); return core.darkColorHandler; } /** * Check if editor is in IME input sequence * @returns True if editor is in IME input sequence, otherwise false */ isInIME(): boolean { return this.getCore().domEvent.isInIME; } private retrieveFormatState(): ContentModelFormatState { const pendingFormat = this.getPendingFormat(); const result: ContentModelFormatState = {}; this.formatContentModel(model => { retrieveModelFormatState(model, pendingFormat, result); return false; }); return result; } /** * @returns the current EditorAdapterCore object * @throws a standard Error if there's no core object */ private getContentModelEditorCore(): EditorAdapterCore { if (!this.contentModelEditorCore) { throw new Error('Editor is already disposed'); } return this.contentModelEditorCore; } } |