lakelib 0.3.0 → 0.3.1

package/lib/editor.d.ts

@@ -41,23 +41,23 @@ export declare class Editor {
     private unsavedInputCount;
     private state;
     private unmountPluginMap;
-    static version: string;
-    static box: BoxManager;
-    static plugin: Plugin;
-    root: Nodes;
-    toolbar: Toolbar | undefined;
-    config: Config;
-    containerWrapper: Nodes;
-    container: Nodes;
-    overlayContainer: Nodes;
+    private readonly containerWrapper;
+    static readonly version: string;
+    static readonly box: BoxManager;
+    static readonly plugin: Plugin;
+    readonly root: Nodes;
+    readonly toolbar: Toolbar | undefined;
+    readonly config: Config;
+    readonly container: Nodes;
+    readonly overlayContainer: Nodes;
+    readonly event: EventEmitter;
+    readonly selection: Selection;
+    readonly command: Command;
+    readonly history: History;
+    readonly keystroke: Keystroke;
+    readonly box: BoxManager;
+    readonly readonly: boolean;
     isComposing: boolean;
-    readonly: boolean;
-    event: EventEmitter;
-    selection: Selection;
-    command: Command;
-    history: History;
-    keystroke: Keystroke;
-    box: BoxManager;
     popup: any;
     constructor(config: EditorConfig);
     private copyListener;
@@ -75,16 +75,16 @@ export declare class Editor {
     private bindInputEvents;
     private removeBoxGarbage;
     private bindHistoryEvents;
-    get hasFocus(): boolean;
     get locale(): TranslationFunctions;
-    fixContent(): boolean;
     setPluginConfig(name: string, config: {
         [key: string]: any;
     }): void;
+    fixContent(): boolean;
     renderBoxes(): void;
+    scrollToCursor(): void;
+    hasFocus(): boolean;
     focus(): void;
     blur(): void;
-    scrollToCaret(): void;
     setValue(value: string): void;
     getValue(): string;
     render(): void;

package/lib/lake.js

@@ -1674,8 +1674,8 @@ class Range {
     }
     // Relocates the start and end points of the range for <br /> element.
     // In composition mode (e.g., when a user starts entering a Chinese character using a Pinyin IME),
-    // uncompleted text is inserted if the caret is positioned behind a <br> tag.
-    // To fix this bug, the caret needs to be moved to the front of the <br> tag.
+    // uncompleted text is inserted if the cursor is positioned behind a <br> tag.
+    // To fix this bug, the cursor needs to be moved to the front of the <br> tag.
     adjustBr() {
         if (!this.isCollapsed) {
             return;
@@ -5833,7 +5833,7 @@ function removeBox(range) {
     return box;
 }
 
-var version = "0.3.0";
+var version = "0.3.1";
 
 // Converts the custom HTML tags to the special tags that can not be parsed by browser.
 function denormalizeValue(value) {
@@ -7007,18 +7007,26 @@ const defaultConfig = {
 };
 class Editor {
     constructor(config) {
+        // A string that has not yet been saved to the history.
         this.unsavedInputData = '';
+        // The number of input event calls before saving to the history.
         this.unsavedInputCount = 0;
+        // The state of the current selection.
         this.state = {
             activeItems: [],
             disabledNameMap: new Map(),
             selectedNameMap: new Map(),
             selectedValuesMap: new Map(),
         };
+        // The functions for unmounting plugins.
         this.unmountPluginMap = new Map();
-        this.isComposing = false;
+        // Managing events.
         this.event = new EventEmitter();
+        // Managing the box components.
         this.box = Editor.box;
+        // Indicating whether a user is entering a character using a text composition system such as an Input Method Editor (IME).
+        this.isComposing = false;
+        // A pop-up component which is currently displayed, such as LinkPopup, MentionMenu, and SlashMenu.
         this.popup = null;
         this.copyListener = event => {
             const range = this.selection.getCurrentRange();
@@ -7310,7 +7318,7 @@ class Editor {
             }
             this.emitStateChangeEvent();
             this.togglePlaceholderClass(value);
-            this.scrollToCaret();
+            this.scrollToCursor();
             this.event.emit('change', value);
         };
         this.history.event.on('undo', value => {
@@ -7332,19 +7340,22 @@ class Editor {
             }
         });
     }
-    // Returns a boolean value indicating whether the editor is focused.
-    get hasFocus() {
-        const activeElement = document.activeElement;
-        if (!activeElement) {
-            return false;
-        }
-        return query(activeElement).closest('.lake-container').get(0) === this.container.get(0);
-    }
     // Returns translation functions for the specified language.
     get locale() {
         return i18nObject(this.config.lang);
     }
-    // Fixes wrong content, especially empty tag.
+    // Sets the default config for the specified plugin.
+    setPluginConfig(name, config) {
+        if (typeof this.config[name] !== 'object') {
+            this.config[name] = {};
+        }
+        for (const key of Object.keys(config)) {
+            if (this.config[name][key] === undefined) {
+                this.config[name][key] = config[key];
+            }
+        }
+    }
+    // Fixes incorrect content, such as adding paragraphs for void elements or removing empty tags.
     fixContent() {
         const range = this.selection.range;
         const cellNode = range.commonAncestor.closest('td');
@@ -7379,17 +7390,6 @@ class Editor {
         range.adjustBr();
         return changed;
     }
-    // Sets default config for a plugin.
-    setPluginConfig(name, config) {
-        if (typeof this.config[name] !== 'object') {
-            this.config[name] = {};
-        }
-        for (const key of Object.keys(config)) {
-            if (this.config[name][key] === undefined) {
-                this.config[name][key] = config[key];
-            }
-        }
-    }
     // Renders all boxes that haven't been rendered yet.
     renderBoxes() {
         this.removeBoxGarbage();
@@ -7404,34 +7404,22 @@ class Editor {
             box.render();
         });
     }
-    // Sets focus on the editor.
-    focus() {
-        const range = this.selection.range;
-        if (this.container.contains(range.commonAncestor) && range.isBox) {
-            return;
-        }
-        this.container.focus();
-    }
-    // Removes focus from the editor.
-    blur() {
-        this.container.blur();
-    }
-    // Scrolls to the caret or the range of the selection.
-    scrollToCaret() {
+    // Scrolls to the cursor.
+    scrollToCursor() {
         const range = this.selection.range;
         if (range.isBox) {
             return;
         }
-        // Creates an artificial caret that is the same size as the caret at the current caret position.
+        // Creates an artificial cursor that is the same size as the cursor at the current cursor position.
         const rangeRect = range.getRect();
         if (rangeRect.x === 0 || rangeRect.y === 0) {
             return;
         }
         const containerRect = this.container.get(0).getBoundingClientRect();
-        const artificialCaret = query('<div class="lake-artificial-caret" />');
+        const artificialCursor = query('<div class="lake-artificial-cursor" />');
         const left = rangeRect.x - containerRect.x;
         const top = rangeRect.y - containerRect.y;
-        artificialCaret.css({
+        artificialCursor.css({
             position: 'absolute',
             top: `${top}px`,
             left: `${left}px`,
@@ -7440,14 +7428,34 @@ class Editor {
             // background: 'red',
             'z-index': '-1',
         });
-        this.overlayContainer.find('.lake-artificial-caret').remove();
-        this.overlayContainer.append(artificialCaret);
-        scrollToNode(artificialCaret, {
+        this.overlayContainer.find('.lake-artificial-cursor').remove();
+        this.overlayContainer.append(artificialCursor);
+        scrollToNode(artificialCursor, {
             behavior: 'instant',
             block: 'nearest',
             inline: 'nearest',
         });
-        artificialCaret.remove();
+        artificialCursor.remove();
+    }
+    // Checks whether the editor has focus.
+    hasFocus() {
+        const activeElement = document.activeElement;
+        if (!activeElement) {
+            return false;
+        }
+        return query(activeElement).closest('.lake-container').get(0) === this.container.get(0);
+    }
+    // Sets focus on the editor.
+    focus() {
+        const range = this.selection.range;
+        if (this.container.contains(range.commonAncestor) && range.isBox) {
+            return;
+        }
+        this.container.focus();
+    }
+    // Removes focus from the editor.
+    blur() {
+        this.container.blur();
     }
     // Sets the specified content to the editor.
     setValue(value) {
@@ -7467,7 +7475,7 @@ class Editor {
         value = denormalizeValue(value);
         return value;
     }
-    // Renders an editor area and sets default content to it.
+    // Renders an editing area and sets default content to it.
     render() {
         const value = normalizeValue(this.config.value);
         const htmlParser = new HTMLParser(value);
@@ -7534,8 +7542,11 @@ class Editor {
         }
     }
 }
+// the current version of Lake.
 Editor.version = version;
+// Managing the box components.
 Editor.box = new BoxManager();
+// Managing the plugins.
 Editor.plugin = new Plugin();
 
 var copy = (editor) => {
@@ -12627,7 +12638,7 @@ var escapeKey = (editor) => {
             selection.sync();
             return;
         }
-        if (editor.hasFocus) {
+        if (editor.hasFocus()) {
             event.preventDefault();
             editor.blur();
         }