-
Notifications
You must be signed in to change notification settings - Fork 159
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Content Model Cache improvement 1: Create ContentModelCachePlugin (#2066
) * Content Model Customization refactor * fix build * improve * Content Model Customization refactor 2: Add default config * fix build * Content Model: Persist cache 1 * fix build * improve * Content Model: Cache 2 * Fix test * Fix build * improve * Improve * improve * Improve * fix test * Improve
- Loading branch information
1 parent
7bf0557
commit 51eb85c
Showing
33 changed files
with
1,023 additions
and
801 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
121 changes: 121 additions & 0 deletions
121
...nt-model/roosterjs-content-model-editor/lib/editor/corePlugins/ContentModelCachePlugin.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| import { ContentModelCachePluginState } from '../../publicTypes/pluginState/ContentModelCachePluginState'; | ||
| import { IContentModelEditor } from '../../publicTypes/IContentModelEditor'; | ||
| import { | ||
| IEditor, | ||
| Keys, | ||
| PluginEvent, | ||
| PluginEventType, | ||
| PluginWithState, | ||
| SelectionRangeEx, | ||
| } from 'roosterjs-editor-types'; | ||
|
|
||
| /** | ||
| * ContentModel cache plugin manages cached Content Model, and refresh the cache when necessary | ||
| */ | ||
| export default class ContentModelCachePlugin | ||
| implements PluginWithState<ContentModelCachePluginState> { | ||
| private editor: IContentModelEditor | null = null; | ||
|
|
||
| /** | ||
| * Construct a new instance of ContentModelEditPlugin class | ||
| * @param state State of this plugin | ||
| */ | ||
| constructor(private state: ContentModelCachePluginState) { | ||
| // TODO: Remove tempState parameter once we have standalone Content Model editor | ||
| } | ||
|
|
||
| /** | ||
| * Get name of this plugin | ||
| */ | ||
| getName() { | ||
| return 'ContentModelCache'; | ||
| } | ||
|
|
||
| /** | ||
| * The first method that editor will call to a plugin when editor is initializing. | ||
| * It will pass in the editor instance, plugin should take this chance to save the | ||
| * editor reference so that it can call to any editor method or format API later. | ||
| * @param editor The editor object | ||
| */ | ||
| initialize(editor: IEditor) { | ||
| // TODO: Later we may need a different interface for Content Model editor plugin | ||
| this.editor = editor as IContentModelEditor; | ||
| this.editor.getDocument().addEventListener('selectionchange', this.onNativeSelectionChange); | ||
| } | ||
|
|
||
| /** | ||
| * The last method that editor will call to a plugin before it is disposed. | ||
| * Plugin can take this chance to clear the reference to editor. After this method is | ||
| * called, plugin should not call to any editor method since it will result in error. | ||
| */ | ||
| dispose() { | ||
| if (this.editor) { | ||
| this.editor | ||
| .getDocument() | ||
| .removeEventListener('selectionchange', this.onNativeSelectionChange); | ||
| this.editor = null; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get plugin state object | ||
| */ | ||
| getState(): ContentModelCachePluginState { | ||
| return this.state; | ||
| } | ||
|
|
||
| /** | ||
| * Core method for a plugin. Once an event happens in editor, editor will call this | ||
| * method of each plugin to handle the event as long as the event is not handled | ||
| * exclusively by another plugin. | ||
| * @param event The event to handle: | ||
| */ | ||
| onPluginEvent(event: PluginEvent) { | ||
| if (!this.editor) { | ||
| return; | ||
| } | ||
|
|
||
| switch (event.eventType) { | ||
| case PluginEventType.KeyDown: | ||
| switch (event.rawEvent.which) { | ||
| case Keys.ENTER: | ||
| // ENTER key will create new paragraph, so need to update cache to reflect this change | ||
| // TODO: Handle ENTER key to better reuse content model | ||
| this.editor.invalidateCache(); | ||
|
|
||
| break; | ||
| } | ||
| break; | ||
|
|
||
| case PluginEventType.Input: | ||
| case PluginEventType.SelectionChanged: | ||
| this.reconcileSelection(this.editor); | ||
| break; | ||
|
|
||
| case PluginEventType.ContentChanged: | ||
| this.editor.invalidateCache(); | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| private onNativeSelectionChange = () => { | ||
| if (this.editor?.hasFocus()) { | ||
| this.reconcileSelection(this.editor); | ||
| } | ||
| }; | ||
|
|
||
| private reconcileSelection(editor: IContentModelEditor, newRangeEx?: SelectionRangeEx) { | ||
| // TODO: Really do reconcile selection | ||
| editor.invalidateCache(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| * Create a new instance of ContentModelCachePlugin class. | ||
| * This is mostly for unit test | ||
| * @param state State of this plugin | ||
| */ | ||
| export function createContentModelCachePlugin(state: ContentModelCachePluginState) { | ||
| return new ContentModelCachePlugin(state); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.