@leapfrog/interactive-canvas 2.0.16 → 2.0.17-beta-1

package/dist/mutator/mutable-text-style.interface.d.ts

@@ -1,163 +1,163 @@
-import { Observable } from "rxjs";
-import { IFont, TextAlignment } from "..";
-import { IMutableText } from "./mutable-text.interface";
-/**
- * Canvas object with customizable text styling
- */
-export interface IMutableTextStyle extends IMutableText {
-    /**
-     * Get the current text selection.
-     */
-    getTextSelection(): ITextSelection;
-    /**
-     * Get an observable for the current {@link #getTextSelection text selection}.
-     */
-    getTextSelection$(): Observable<ITextSelection>;
-    /**
-     * Set the text alignment.
-     * @param alignment New value.
-     */
-    setTextAlign(alignment: TextAlignment): void;
-    /**
-     * Set the character spacing.
-     * @param spacing New value.
-     */
-    setCharSpacing(spacing: number): void;
-    /**
-     * Set the line height.
-     * @param height New value.
-     */
-    setLineHeight(height: number): void;
-    /**
-     * Set the bold state of the current selection.
-     * @param bold Bold state.
-     */
-    setBold(bold?: boolean): void;
-    /**
-     * Set a specified region to bold.
-     * @param start region start index.
-     * @param end region end index.
-     * @param bold whether to set bold or not.
-     */
-    setBoldRegion(start: number, end: number, bold?: boolean): void;
-    /**
-     * Set the italic state of the current selection.
-     * @param italic Italic state.
-     */
-    setItalic(italic?: boolean): void;
-    /**
-     * Set a specified region to italic.
-     * @param start region start index.
-     * @param end region end index.
-     * @param italic whether to set italic or not.
-     */
-    setItalicRegion(start: number, end: number, italic?: boolean): void;
-    /**
-     * Set the strikethrough state of the current selection.
-     * @param strikethrough Strikethrough state.
-     */
-    setStrikethrough(strikethrough?: boolean): void;
-    /**
-     * Set the underline state of the current selection.
-     * @param underline Underline state.
-     */
-    setUnderline(underline?: boolean): void;
-    /**
-     * Set the font.
-     * @param font New value.
-     */
-    setFont(font: IFont): void;
-    /**
-     * Set the font size.
-     * @param fontSize New value.
-     */
-    setFontSize(fontSize: number): void;
-    /**
-     * Set the text background color.
-     * @param color New value.
-     */
-    setTextBackgroundColor(color: string | null): void;
-}
-export interface ITextSelection {
-    /**
-     * Index of selection start in characters.
-     */
-    readonly start: number;
-    /**
-     * Index of selection end in characters.
-     */
-    readonly end: number;
-    /**
-     * Selection length in characters.
-     */
-    readonly length: number;
-    /**
-     * Selection start line index.
-     */
-    readonly lineIndex: number;
-    /**
-     * Selection start character index (from start of current line).
-     */
-    readonly charIndex: number;
-    /**
-     * Current font.
-     */
-    readonly font: IFont;
-    /**
-     * Font size.
-     */
-    readonly fontSize: number;
-    /**
-     * Font weight.
-     */
-    readonly fontWeight: number;
-    /**
-     * Current text alignment.
-     */
-    readonly textAlign: TextAlignment;
-    /**
-     * Current character spacing.
-     */
-    readonly charSpacing: number;
-    /**
-     * Current line height.
-     */
-    readonly lineHeight: number;
-    /**
-     * True if the current selection is bold.
-     */
-    readonly bold: boolean;
-    /**
-     * True if the current selection is italic.
-     */
-    readonly italic: boolean;
-    /**
-     * Whether the text has an underline.
-     */
-    readonly underline: boolean;
-    /**
-     * Whether the text has a strikethrough.
-     */
-    readonly strikethrough: boolean;
-    /**
-     * Whether the text has an overline.
-     */
-    readonly overline: boolean;
-    /**
-     * Fill color.
-     */
-    readonly fill: string;
-    /**
-     * Stroke color.
-     */
-    readonly stroke: string;
-    /**
-     * Stroke width.
-     */
-    readonly strokeWidth: number;
-    /**
-     * Background color.
-     */
-    readonly textBackgroundColor: string;
-}
-export declare function isMutableTextStyle(object: any): object is IMutableText;
+import { Observable } from "rxjs";
+import { IFont, TextAlignment } from "..";
+import { IMutableText } from "./mutable-text.interface";
+/**
+ * Canvas object with customizable text styling
+ */
+export interface IMutableTextStyle extends IMutableText {
+    /**
+     * Get the current text selection.
+     */
+    getTextSelection(): ITextSelection;
+    /**
+     * Get an observable for the current {@link #getTextSelection text selection}.
+     */
+    getTextSelection$(): Observable<ITextSelection>;
+    /**
+     * Set the text alignment.
+     * @param alignment New value.
+     */
+    setTextAlign(alignment: TextAlignment): void;
+    /**
+     * Set the character spacing.
+     * @param spacing New value.
+     */
+    setCharSpacing(spacing: number): void;
+    /**
+     * Set the line height.
+     * @param height New value.
+     */
+    setLineHeight(height: number): void;
+    /**
+     * Set the bold state of the current selection.
+     * @param bold Bold state.
+     */
+    setBold(bold?: boolean): void;
+    /**
+     * Set a specified region to bold.
+     * @param start region start index.
+     * @param end region end index.
+     * @param bold whether to set bold or not.
+     */
+    setBoldRegion(start: number, end: number, bold?: boolean): void;
+    /**
+     * Set the italic state of the current selection.
+     * @param italic Italic state.
+     */
+    setItalic(italic?: boolean): void;
+    /**
+     * Set a specified region to italic.
+     * @param start region start index.
+     * @param end region end index.
+     * @param italic whether to set italic or not.
+     */
+    setItalicRegion(start: number, end: number, italic?: boolean): void;
+    /**
+     * Set the strikethrough state of the current selection.
+     * @param strikethrough Strikethrough state.
+     */
+    setStrikethrough(strikethrough?: boolean): void;
+    /**
+     * Set the underline state of the current selection.
+     * @param underline Underline state.
+     */
+    setUnderline(underline?: boolean): void;
+    /**
+     * Set the font.
+     * @param font New value.
+     */
+    setFont(font: IFont): void;
+    /**
+     * Set the font size.
+     * @param fontSize New value.
+     */
+    setFontSize(fontSize: number): void;
+    /**
+     * Set the text background color.
+     * @param color New value.
+     */
+    setTextBackgroundColor(color: string | null): void;
+}
+export interface ITextSelection {
+    /**
+     * Index of selection start in characters.
+     */
+    readonly start: number;
+    /**
+     * Index of selection end in characters.
+     */
+    readonly end: number;
+    /**
+     * Selection length in characters.
+     */
+    readonly length: number;
+    /**
+     * Selection start line index.
+     */
+    readonly lineIndex: number;
+    /**
+     * Selection start character index (from start of current line).
+     */
+    readonly charIndex: number;
+    /**
+     * Current font.
+     */
+    readonly font: IFont;
+    /**
+     * Font size.
+     */
+    readonly fontSize: number;
+    /**
+     * Font weight.
+     */
+    readonly fontWeight: number;
+    /**
+     * Current text alignment.
+     */
+    readonly textAlign: TextAlignment;
+    /**
+     * Current character spacing.
+     */
+    readonly charSpacing: number;
+    /**
+     * Current line height.
+     */
+    readonly lineHeight: number;
+    /**
+     * True if the current selection is bold.
+     */
+    readonly bold: boolean;
+    /**
+     * True if the current selection is italic.
+     */
+    readonly italic: boolean;
+    /**
+     * Whether the text has an underline.
+     */
+    readonly underline: boolean;
+    /**
+     * Whether the text has a strikethrough.
+     */
+    readonly strikethrough: boolean;
+    /**
+     * Whether the text has an overline.
+     */
+    readonly overline: boolean;
+    /**
+     * Fill color.
+     */
+    readonly fill: string;
+    /**
+     * Stroke color.
+     */
+    readonly stroke: string;
+    /**
+     * Stroke width.
+     */
+    readonly strokeWidth: number;
+    /**
+     * Background color.
+     */
+    readonly textBackgroundColor: string;
+}
+export declare function isMutableTextStyle(object: any): object is IMutableText;

package/dist/mutator/mutable-text.interface.d.ts

@@ -1,80 +1,80 @@
-import { Observable } from "rxjs";
-import { ICanvasObject } from "..";
-/**
- * Because of the way styles are handled in fabric, stored as a separate list of character pointers and not inline as per HTML, modifying the text directly is dangerous - it will cause the
- * location of the styles to become out of sync with the actual text if the length changes.
- * Text modification should be performed by inserting the selection cursor at a given position and modifying the selection... this lets the canvas track changes and update the styles accordingly.
- * It's pretty crap, honestly but text support is explicitly a second-class citizen in fabric, as the author has stated text support is out-of-scope for the library:
- * https://github.com/fabricjs/fabric.js/issues/3443#issuecomment-262263542
- */
-export interface IMutableText extends ICanvasObject {
-    getText(): string;
-    getText$(): Observable<string>;
-    /**
-     * Generally, don't use this. It will not modify the style locations, and if the text length changes, it will cause the
-     * styles to slide out of place.
-     * Use {@link IMutableText#replaceText} instead, where feasible.
-     * @param text New text.
-     * @see {@link IMutableText#replaceText}
-     */
-    setText(text: string): void;
-    /**
-     * Replace a text fragment in the field. Honors existing styling as much as possible.
-     * @param target Existing text fragment.
-     * @param replacement Replacement fragment.
-     */
-    replaceText(target: string, replacement: string): void;
-    /**
-     * Taken from the fabric JSDOC:
-     * 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 text text to insert
-     * @param style array of style objects
-     * @param start
-     * @param end default to start + 1
-     */
-    insertText(text: string, style?: any[], start?: number, end?: number): void;
-    /**
-     * {@link #insertText} but at the current cursor location.
-     * @param text
-     * @param style
-     */
-    insertTextAtSelection(text: string, style?: any[]): void;
-    /**
-     * Is the text bulleted?
-     */
-    isBulleted(): boolean;
-    /**
-     * Enable bullet points.
-     */
-    enableBullets(): void;
-    /**
-     * Disable bullet points.
-     */
-    disableBullets(): void;
-    /**
-     * Is the text an ordered list?
-     */
-    isOrderedList(): boolean;
-    /**
-     * Enable ordered list markers.
-     */
-    enableOrderedList(): void;
-    /**
-     * Disable ordered list markers.
-     */
-    disableOrderedList(): void;
-    /**
-     * @param start The start value for the ordered list.
-     */
-    setOrderedListStart(start: number): void;
-    /**
-     * Get the start value for the ordered list.
-     */
-    getOrderedListStart(): number;
-}
-export declare function isMutableText(object: any): object is IMutableText;
+import { Observable } from "rxjs";
+import { ICanvasObject } from "..";
+/**
+ * Because of the way styles are handled in fabric, stored as a separate list of character pointers and not inline as per HTML, modifying the text directly is dangerous - it will cause the
+ * location of the styles to become out of sync with the actual text if the length changes.
+ * Text modification should be performed by inserting the selection cursor at a given position and modifying the selection... this lets the canvas track changes and update the styles accordingly.
+ * It's pretty crap, honestly but text support is explicitly a second-class citizen in fabric, as the author has stated text support is out-of-scope for the library:
+ * https://github.com/fabricjs/fabric.js/issues/3443#issuecomment-262263542
+ */
+export interface IMutableText extends ICanvasObject {
+    getText(): string;
+    getText$(): Observable<string>;
+    /**
+     * Generally, don't use this. It will not modify the style locations, and if the text length changes, it will cause the
+     * styles to slide out of place.
+     * Use {@link IMutableText#replaceText} instead, where feasible.
+     * @param text New text.
+     * @see {@link IMutableText#replaceText}
+     */
+    setText(text: string): void;
+    /**
+     * Replace a text fragment in the field. Honors existing styling as much as possible.
+     * @param target Existing text fragment.
+     * @param replacement Replacement fragment.
+     */
+    replaceText(target: string, replacement: string): void;
+    /**
+     * Taken from the fabric JSDOC:
+     * 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 text text to insert
+     * @param style array of style objects
+     * @param start
+     * @param end default to start + 1
+     */
+    insertText(text: string, style?: any[], start?: number, end?: number): void;
+    /**
+     * {@link #insertText} but at the current cursor location.
+     * @param text
+     * @param style
+     */
+    insertTextAtSelection(text: string, style?: any[]): void;
+    /**
+     * Is the text bulleted?
+     */
+    isBulleted(): boolean;
+    /**
+     * Enable bullet points.
+     */
+    enableBullets(): void;
+    /**
+     * Disable bullet points.
+     */
+    disableBullets(): void;
+    /**
+     * Is the text an ordered list?
+     */
+    isOrderedList(): boolean;
+    /**
+     * Enable ordered list markers.
+     */
+    enableOrderedList(): void;
+    /**
+     * Disable ordered list markers.
+     */
+    disableOrderedList(): void;
+    /**
+     * @param start The start value for the ordered list.
+     */
+    setOrderedListStart(start: number): void;
+    /**
+     * Get the start value for the ordered list.
+     */
+    getOrderedListStart(): number;
+}
+export declare function isMutableText(object: any): object is IMutableText;