@nasser-sw/fabric 7.0.1-beta11 → 7.0.1-beta13

package/dist/src/shapes/IText/ITextBehavior.mjs

@@ -7,35 +7,35 @@ import { reNewline, MODIFIED, LEFT, RIGHT } from '../../constants.mjs';
 import { enterTextOverlayEdit } from '../../text/overlayEditor.mjs';
 import { extractLinesFromDOM, storeBrowserLines } from '../../text/browserLines.mjs';
 
-/**
- *  extend this regex to support non english languages
- *
- *  - ` `      Matches a SPACE character (char code 32).
- *  - `\n`     Matches a LINE FEED character (char code 10).
- *  - `.`     Matches a "." character (char code 46).
- *  - `,`      Matches a "," character (char code 44).
- *  - `;`      Matches a ";" character (char code 59).
- *  - `!`      Matches a "!" character (char code 33).
- *  - `\?`     Matches a "?" character (char code 63).
- *  - `\-`     Matches a "-" character (char code 45).
+/**
+ *  extend this regex to support non english languages
+ *
+ *  - ` `      Matches a SPACE character (char code 32).
+ *  - `\n`     Matches a LINE FEED character (char code 10).
+ *  - `.`     Matches a "." character (char code 46).
+ *  - `,`      Matches a "," character (char code 44).
+ *  - `;`      Matches a ";" character (char code 59).
+ *  - `!`      Matches a "!" character (char code 33).
+ *  - `\?`     Matches a "?" character (char code 63).
+ *  - `\-`     Matches a "-" character (char code 45).
  */
 // eslint-disable-next-line no-useless-escape
 const reNonWord = /[ \n\.,;!\?\-]/;
 class ITextBehavior extends FabricText {
   constructor() {
     super(...arguments);
-    /**
-     * Helps determining when the text is in composition, so that the cursor
-     * rendering is altered.
+    /**
+     * Helps determining when the text is in composition, so that the cursor
+     * rendering is altered.
      */
     _defineProperty(this, "_currentCursorOpacity", 1);
   }
-  /**
-   * Keeps track if the IText object was selected before the actual click.
-   * This because we want to delay enter editing by a click.
+  /**
+   * Keeps track if the IText object was selected before the actual click.
+   * This because we want to delay enter editing by a click.
    */
-  /**
-   * Initializes all the interactive behavior of IText
+  /**
+   * Initializes all the interactive behavior of IText
    */
   initBehavior() {
     this._tick = this._tick.bind(this);
@@ -48,8 +48,8 @@ class ITextBehavior extends FabricText {
     return super.onDeselect(options);
   }
 
-  /**
-   * @private
+  /**
+   * @private
    */
   _animateCursor(_ref) {
     let {
@@ -74,8 +74,8 @@ class ITextBehavior extends FabricText {
     });
   }
 
-  /**
-   * changes the cursor from visible to invisible
+  /**
+   * changes the cursor from visible to invisible
    */
   _tick(delay) {
     this._currentTickState = this._animateCursor({
@@ -86,8 +86,8 @@ class ITextBehavior extends FabricText {
     });
   }
 
-  /**
-   * Changes the cursor from invisible to visible
+  /**
+   * Changes the cursor from invisible to visible
    */
   _onTickComplete() {
     var _this$_currentTickCom;
@@ -99,16 +99,16 @@ class ITextBehavior extends FabricText {
     });
   }
 
-  /**
-   * Initializes delayed cursor
+  /**
+   * Initializes delayed cursor
    */
   initDelayedCursor(restart) {
     this.abortCursorAnimation();
     this._tick(restart ? 0 : this.cursorDelay);
   }
 
-  /**
-   * Aborts cursor animation, clears all timeouts and clear textarea context if necessary
+  /**
+   * Aborts cursor animation, clears all timeouts and clear textarea context if necessary
    */
   abortCursorAnimation() {
     let shouldClear = false;
@@ -126,9 +126,9 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * Restart tue cursor animation if either is in complete state ( between animations )
-   * or if it never started before
+  /**
+   * Restart tue cursor animation if either is in complete state ( between animations )
+   * or if it never started before
    */
   restartCursorIfNeeded() {
     if ([this._currentTickState, this._currentTickCompleteState].some(cursorAnimation => !cursorAnimation || cursorAnimation.isDone())) {
@@ -136,8 +136,8 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * Selects entire text
+  /**
+   * Selects entire text
    */
   selectAll() {
     this.selectionStart = 0;
@@ -147,26 +147,26 @@ class ITextBehavior extends FabricText {
     return this;
   }
 
-  /**
-   * Selects entire text and updates the visual state
+  /**
+   * Selects entire text and updates the visual state
    */
   cmdAll() {
     this.selectAll();
     this.renderCursorOrSelection();
   }
 
-  /**
-   * Returns selected text
-   * @return {String}
+  /**
+   * Returns selected text
+   * @return {String}
    */
   getSelectedText() {
     return this._text.slice(this.selectionStart, this.selectionEnd).join('');
   }
 
-  /**
-   * Find new selection index representing start of current word according to current selection index
-   * @param {Number} startFrom Current selection index
-   * @return {Number} New selection index
+  /**
+   * Find new selection index representing start of current word according to current selection index
+   * @param {Number} startFrom Current selection index
+   * @return {Number} New selection index
    */
   findWordBoundaryLeft(startFrom) {
     let offset = 0,
@@ -186,10 +186,10 @@ class ITextBehavior extends FabricText {
     return startFrom - offset;
   }
 
-  /**
-   * Find new selection index representing end of current word according to current selection index
-   * @param {Number} startFrom Current selection index
-   * @return {Number} New selection index
+  /**
+   * Find new selection index representing end of current word according to current selection index
+   * @param {Number} startFrom Current selection index
+   * @return {Number} New selection index
    */
   findWordBoundaryRight(startFrom) {
     let offset = 0,
@@ -209,10 +209,10 @@ class ITextBehavior extends FabricText {
     return startFrom + offset;
   }
 
-  /**
-   * Find new selection index representing start of current line according to current selection index
-   * @param {Number} startFrom Current selection index
-   * @return {Number} New selection index
+  /**
+   * Find new selection index representing start of current line according to current selection index
+   * @param {Number} startFrom Current selection index
+   * @return {Number} New selection index
    */
   findLineBoundaryLeft(startFrom) {
     let offset = 0,
@@ -224,10 +224,10 @@ class ITextBehavior extends FabricText {
     return startFrom - offset;
   }
 
-  /**
-   * Find new selection index representing end of current line according to current selection index
-   * @param {Number} startFrom Current selection index
-   * @return {Number} New selection index
+  /**
+   * Find new selection index representing end of current line according to current selection index
+   * @param {Number} startFrom Current selection index
+   * @return {Number} New selection index
    */
   findLineBoundaryRight(startFrom) {
     let offset = 0,
@@ -239,11 +239,11 @@ class ITextBehavior extends FabricText {
     return startFrom + offset;
   }
 
-  /**
-   * Finds index corresponding to beginning or end of a word
-   * @param {Number} selectionStart Index of a character
-   * @param {Number} direction 1 or -1
-   * @return {Number} Index of the beginning or end of a word
+  /**
+   * Finds index corresponding to beginning or end of a word
+   * @param {Number} selectionStart Index of a character
+   * @param {Number} direction 1 or -1
+   * @return {Number} Index of the beginning or end of a word
    */
   searchWordBoundary(selectionStart, direction) {
     const text = this._text;
@@ -261,9 +261,9 @@ class ITextBehavior extends FabricText {
     return index;
   }
 
-  /**
-   * Selects the word that contains the char at index selectionStart
-   * @param {Number} selectionStart Index of a character
+  /**
+   * Selects the word that contains the char at index selectionStart
+   * @param {Number} selectionStart Index of a character
    */
   selectWord(selectionStart) {
     selectionStart = selectionStart !== null && selectionStart !== void 0 ? selectionStart : this.selectionStart;
@@ -279,9 +279,9 @@ class ITextBehavior extends FabricText {
     this.renderCursorOrSelection();
   }
 
-  /**
-   * Selects the line that contains selectionStart
-   * @param {Number} selectionStart Index of a character
+  /**
+   * Selects the line that contains selectionStart
+   * @param {Number} selectionStart Index of a character
    */
   selectLine(selectionStart) {
     selectionStart = selectionStart !== null && selectionStart !== void 0 ? selectionStart : this.selectionStart;
@@ -293,8 +293,8 @@ class ITextBehavior extends FabricText {
     this._updateTextarea();
   }
 
-  /**
-   * Enters editing state
+  /**
+   * Enters editing state
    */
   enterEditing(e) {
     if (this.isEditing || !this.editable) {
@@ -314,8 +314,8 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * runs the actual logic that enter from editing state, see {@link enterEditing}
+  /**
+   * runs the actual logic that enter from editing state, see {@link enterEditing}
    */
   enterEditingImpl() {
     if (this.canvas) {
@@ -339,8 +339,8 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * Enter overlay editing mode using DOM textarea overlay
+  /**
+   * Enter overlay editing mode using DOM textarea overlay
    */
   enterOverlayEditing() {
     this._saveEditingProps();
@@ -361,8 +361,8 @@ class ITextBehavior extends FabricText {
     });
   }
 
-  /**
-   * Commit overlay editing changes
+  /**
+   * Commit overlay editing changes
    */
   commitOverlayEdit(text) {
     const overlayEditor = this.__overlayEditor;
@@ -386,8 +386,8 @@ class ITextBehavior extends FabricText {
     this.canvas && this.canvas.requestRenderAll();
   }
 
-  /**
-   * Cancel overlay editing without changes
+  /**
+   * Cancel overlay editing without changes
    */
   cancelOverlayEdit() {
     // Restore original text
@@ -395,8 +395,8 @@ class ITextBehavior extends FabricText {
     this.exitEditing();
   }
 
-  /**
-   * called by {@link Canvas#textEditingManager}
+  /**
+   * called by {@link Canvas#textEditingManager}
    */
   updateSelectionOnMouseMove(e) {
     if (this.getActiveControl()) {
@@ -424,8 +424,8 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * @private
+  /**
+   * @private
    */
   _setEditingProps() {
     this.hoverCursor = 'text';
@@ -437,8 +437,8 @@ class ITextBehavior extends FabricText {
     this.lockMovementX = this.lockMovementY = true;
   }
 
-  /**
-   * convert from textarea to grapheme indexes
+  /**
+   * convert from textarea to grapheme indexes
    */
   fromStringToGraphemeSelection(start, end, text) {
     const smallerTextStart = text.slice(0, start),
@@ -457,8 +457,8 @@ class ITextBehavior extends FabricText {
     };
   }
 
-  /**
-   * convert from fabric to textarea values
+  /**
+   * convert from fabric to textarea values
    */
   fromGraphemeToStringSelection(start, end, graphemes) {
     const smallerTextStart = graphemes.slice(0, start),
@@ -477,8 +477,8 @@ class ITextBehavior extends FabricText {
     };
   }
 
-  /**
-   * @private
+  /**
+   * @private
    */
   _updateTextarea() {
     console.log('🔤 _updateTextarea called with fabric text:', this.text);
@@ -503,8 +503,8 @@ class ITextBehavior extends FabricText {
     this.updateTextareaPosition();
   }
 
-  /**
-   * @private
+  /**
+   * @private
    */
   updateFromTextArea() {
     if (!this.hiddenTextarea) {
@@ -524,8 +524,8 @@ class ITextBehavior extends FabricText {
     this.updateTextareaPosition();
   }
 
-  /**
-   * @private
+  /**
+   * @private
    */
   updateTextareaPosition() {
     if (this.selectionStart === this.selectionEnd) {
@@ -535,9 +535,9 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * @private
-   * @return {Object} style contains style for hiddenTextarea
+  /**
+   * @private
+   * @return {Object} style contains style for hiddenTextarea
    */
   _calcTextareaPosition() {
     if (!this.canvas) {
@@ -584,8 +584,8 @@ class ITextBehavior extends FabricText {
     };
   }
 
-  /**
-   * @private
+  /**
+   * @private
    */
   _saveEditingProps() {
     this._savedProps = {
@@ -602,8 +602,8 @@ class ITextBehavior extends FabricText {
     };
   }
 
-  /**
-   * @private
+  /**
+   * @private
    */
   _restoreEditingProps() {
     if (!this._savedProps) {
@@ -623,9 +623,9 @@ class ITextBehavior extends FabricText {
     delete this._savedProps;
   }
 
-  /**
-   * runs the actual logic that exits from editing state, see {@link exitEditing}
-   * But it does not fire events
+  /**
+   * runs the actual logic that exits from editing state, see {@link exitEditing}
+   * But it does not fire events
    */
   exitEditingImpl() {
     const hiddenTextarea = this.hiddenTextarea;
@@ -646,8 +646,8 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * Exits from editing state and fires relevant events
+  /**
+   * Exits from editing state and fires relevant events
    */
   exitEditing() {
     const isTextChanged = this._textBeforeEdit !== this.text;
@@ -666,8 +666,8 @@ class ITextBehavior extends FabricText {
     return this;
   }
 
-  /**
-   * @private
+  /**
+   * @private
    */
   _removeExtraneousStyles() {
     for (const prop in this.styles) {
@@ -677,10 +677,10 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * remove and reflow a style block from start to end.
-   * @param {Number} start linear start position for removal (included in removal)
-   * @param {Number} end linear end position for removal ( excluded from removal )
+  /**
+   * remove and reflow a style block from start to end.
+   * @param {Number} start linear start position for removal (included in removal)
+   * @param {Number} end linear end position for removal ( excluded from removal )
    */
   removeStyleFromTo(start, end) {
     const {
@@ -733,10 +733,10 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * Shifts line styles up or down
-   * @param {Number} lineIndex Index of a line
-   * @param {Number} offset Can any number?
+  /**
+   * Shifts line styles up or down
+   * @param {Number} lineIndex Index of a line
+   * @param {Number} offset Can any number?
    */
   shiftLineStyles(lineIndex, offset) {
     const clonedStyles = Object.assign({}, this.styles);
@@ -751,15 +751,15 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * Handle insertion of more consecutive style lines for when one or more
-   * newlines gets added to the text. Since current style needs to be shifted
-   * first we shift the current style of the number lines needed, then we add
-   * new lines from the last to the first.
-   * @param {Number} lineIndex Index of a line
-   * @param {Number} charIndex Index of a char
-   * @param {Number} qty number of lines to add
-   * @param {Array} copiedStyle Array of objects styles
+  /**
+   * Handle insertion of more consecutive style lines for when one or more
+   * newlines gets added to the text. Since current style needs to be shifted
+   * first we shift the current style of the number lines needed, then we add
+   * new lines from the last to the first.
+   * @param {Number} lineIndex Index of a line
+   * @param {Number} charIndex Index of a char
+   * @param {Number} qty number of lines to add
+   * @param {Array} copiedStyle Array of objects styles
    */
   insertNewlineStyleObject(lineIndex, charIndex, qty, copiedStyle) {
     const newLineStyles = {};
@@ -819,12 +819,12 @@ class ITextBehavior extends FabricText {
     this._forceClearCache = true;
   }
 
-  /**
-   * Inserts style object for a given line/char index
-   * @param {Number} lineIndex Index of a line
-   * @param {Number} charIndex Index of a char
-   * @param {Number} quantity number Style object to insert, if given
-   * @param {Array} copiedStyle array of style objects
+  /**
+   * Inserts style object for a given line/char index
+   * @param {Number} lineIndex Index of a line
+   * @param {Number} charIndex Index of a char
+   * @param {Number} quantity number Style object to insert, if given
+   * @param {Array} copiedStyle array of style objects
    */
   insertCharStyleObject(lineIndex, charIndex, quantity, copiedStyle) {
     if (!this.styles) {
@@ -873,11 +873,11 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * Inserts style object(s)
-   * @param {Array} insertedText Characters at the location where style is inserted
-   * @param {Number} start cursor index for inserting style
-   * @param {Array} [copiedStyle] array of style objects to insert.
+  /**
+   * Inserts style object(s)
+   * @param {Array} insertedText Characters at the location where style is inserted
+   * @param {Number} start cursor index for inserting style
+   * @param {Array} [copiedStyle] array of style objects to insert.
    */
   insertNewStyleBlock(insertedText, start, copiedStyle) {
     const cursorLoc = this.get2DCursorLocation(start, true),
@@ -918,12 +918,12 @@ class ITextBehavior extends FabricText {
     }
   }
 
-  /**
-   * Removes characters from start/end
-   * start/end ar per grapheme position in _text array.
-   *
-   * @param {Number} start
-   * @param {Number} end default to start + 1
+  /**
+   * Removes characters from start/end
+   * start/end ar per grapheme position in _text array.
+   *
+   * @param {Number} start
+   * @param {Number} end default to start + 1
    */
   removeChars(start) {
     let end = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : start + 1;
@@ -936,17 +936,17 @@ class ITextBehavior extends FabricText {
     this._removeExtraneousStyles();
   }
 
-  /**
-   * insert characters at start position, before start position.
-   * start  equal 1 it means the text get inserted between actual grapheme 0 and 1
-   * if style array is provided, it must be as the same length of text in graphemes
-   * if end is provided and is bigger than start, old text is replaced.
-   * start/end ar per grapheme position in _text array.
-   *
-   * @param {String} text text to insert
-   * @param {Array} style array of style objects
-   * @param {Number} start
-   * @param {Number} end default to start + 1
+  /**
+   * insert characters at start position, before start position.
+   * start  equal 1 it means the text get inserted between actual grapheme 0 and 1
+   * if style array is provided, it must be as the same length of text in graphemes
+   * if end is provided and is bigger than start, old text is replaced.
+   * start/end ar per grapheme position in _text array.
+   *
+   * @param {String} text text to insert
+   * @param {Array} style array of style objects
+   * @param {Number} start
+   * @param {Number} end default to start + 1
    */
   insertChars(text, style, start) {
     let end = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : start;
@@ -963,9 +963,9 @@ class ITextBehavior extends FabricText {
     this._removeExtraneousStyles();
   }
 
-  /**
-   * Set the selectionStart and selectionEnd according to the new position of cursor
-   * mimic the key - mouse navigation when shift is pressed.
+  /**
+   * Set the selectionStart and selectionEnd according to the new position of cursor
+   * mimic the key - mouse navigation when shift is pressed.
    */
   setSelectionStartEndWithShift(start, end, newSelection) {
     if (newSelection <= start) {