@progress/kendo-angular-editor 19.1.2-develop.2 → 19.1.2-develop.3

package/esm2022/tools/link/editor-insert-file-button.directive.mjs

@@ -14,9 +14,8 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **Insert File** tool
- * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
+ * Configures a ToolBarButtonComponent as an Editor **Insert File** tool ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
+ * The directive sets the SVG icon and `click` event handlers for the button.
  *
  * @example
  * ```html

package/esm2022/tools/link/editor-unlink-button.directive.mjs

@@ -14,10 +14,9 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **Unlink** tool
- * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `disabled` state of the button according to the cursor position in the editing area.
+ * Configures a ToolBarButtonComponent as an Editor **Unlink** tool ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
+ * The directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `disabled` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/list/editor-insert-ordered-list-button.directive.mjs

@@ -14,10 +14,9 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **InsertOrderedList** tool
- * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `selected` state of the button according to the cursor position in the editing area.
+ * Configures a ToolBarButtonComponent as an Editor **InsertOrderedList** tool ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
+ * The directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `selected` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/list/editor-insert-unordered-list-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **InsertUnorderedList** tool
+ * Configures a ToolBarButtonComponent as an Editor **InsertUnorderedList** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `selected` state of the button according to the cursor position in the editing area.
+ * This directive sets the SVG icon and `click` event handlers for the button.
+ * It also updates the `selected` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/print/editor-print-button.directive.mjs

@@ -15,11 +15,11 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **Print** tool
+ * Configures a ToolBarButtonComponent as an Editor **Print** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
+ * This directive sets the SVG icon and `click` event handlers for the button.
  *
- * > The Editor Print tool is supported in the default [`iframe`](slug:api_editor_editorcomponent#iframe) mode only.
+ * The Editor Print tool works only in the default [`iframe`](slug:api_editor_editorcomponent#iframe) mode.
  *
  * @example
  * ```html

package/esm2022/tools/select-all/select-all-button.directive.mjs

@@ -14,9 +14,9 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **SelectAll** tool
+ * Configures a ToolBarButtonComponent as an Editor **SelectAll** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
+ * This directive sets the SVG icon and `click` event handlers for the button.
  *
  * @example
  * ```html

package/esm2022/tools/source/editor-view-source-button.directive.mjs

@@ -14,9 +14,9 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **ViewSource** tool
+ * Configures a ToolBarButtonComponent as an Editor **ViewSource** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
+ * The directive sets the SVG icon and `click` event handlers for the button.
  *
  * @example
  * ```html

package/esm2022/tools/tables/editor-add-column-after-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **AddColumnAfter** tool
+ * Configures a ToolBarButtonComponent as an Editor **AddColumnAfter** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `disabled` state of the button according to the cursor position in the editing area.
+ * The directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `disabled` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/tables/editor-add-column-before-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **AddColumnBefore** tool
+ * Configures a ToolBarButtonComponent as an Editor **AddColumnBefore** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `disabled` state of the button according to the cursor position in the editing area.
+ * The directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `disabled` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/tables/editor-add-row-after-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **AddRowAfter** tool
+ * Configures a ToolBarButtonComponent as an Editor **AddRowAfter** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `disabled` state of the button according to the cursor position in the editing area.
+ * The directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `disabled` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/tables/editor-add-row-before-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **AddRowBefore** tool
+ * Configures a ToolBarButtonComponent as an Editor **AddRowBefore** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `disabled` state of the button according to the cursor position in the editing area.
+ * The directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `disabled` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/tables/editor-delete-column-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **DeleteColumn** tool
+ * Configures a ToolBarButtonComponent as an Editor **DeleteColumn** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `disabled` state of the button according to the cursor position in the editing area.
+ * The directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `disabled` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/tables/editor-delete-row-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **DeleteRow** tool
+ * Configures a ToolBarButtonComponent as an Editor **DeleteRow** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `disabled` state of the button according to the cursor position in the editing area.
+ * The directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `disabled` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/tables/editor-delete-table-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **DeleteTable** tool
+ * Configures a ToolBarButtonComponent as an Editor **DeleteTable** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `disabled` state of the button according to the cursor position in the editing area.
+ * The directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `disabled` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/tables/editor-insert-table-button.component.mjs

@@ -26,7 +26,9 @@ import * as i4 from "../../common/provider.service";
 const popupWrapperWidth = '190px';
 const popupWrapperHeight = '164px'; // Set to '192px' when TableWizard button is added;
 /**
- * A toolbar component which allows the user to create and insert a table in the Editor's content.
+ * Represents toolbar component which allows creating and insertig a table in the Editor's content.
+ *
+ * Use this toolbar component to let users create and insert a table in the Editor's content.
  *
  * @example
  * ```html

package/esm2022/tools/tables/editor-merge-cells-button.directive.mjs

@@ -16,13 +16,13 @@ import * as i4 from "../tools.service";
 /**
  * @hidden
  *
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor MergeCells tool
+ * Configures an existing ToolBarButtonComponent as an Editor **MergeCells** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the `icon` and `click` event handlers of the button.
- * In addition, the directive updates the `disabled` state of the button according to the cursor position in the editing area.
+ * The directive predefines the `icon` and `click` event handlers of the button.
+ * It also updates the `disabled` state of the button based on the cursor position in the editing area.
  *
  * @example
- * ```ts-no-run
+ * ```html
  * <kendo-toolbar-button kendoEditorMergeCellsButton></kendo-toolbar-button>
  * ```
  */

package/esm2022/tools/tables/editor-split-cell-button.directive.mjs

@@ -16,13 +16,13 @@ import * as i4 from "../tools.service";
 /**
  * @hidden
  *
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor SplitCell tool
+ * Configures an existing ToolBarButtonComponent as an Editor SplitCell tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the `icon` and `click` event handlers of the button.
- * In addition, the directive updates the `disabled` state of the button according to the cursor position in the editing area.
+ * The directive predefines the `icon` and `click` event handlers of the button.
+ * It also updates the `disabled` state of the button based on the cursor position in the editing area.
  *
  * @example
- * ```ts-no-run
+ * ```html
  * <kendo-toolbar-button kendoEditorSplitCellButton></kendo-toolbar-button>
  * ```
  */

package/esm2022/tools/typographical-emphasis/editor-bold-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **Bold** tool
+ * Configures a ToolBarButtonComponent as an Editor **Bold** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `selected` state of the button according to the cursor position in the editing area.
+ * This directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `selected` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/typographical-emphasis/editor-italic-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **Italic** tool
+ * Configures a ToolBarButtonComponent as an Editor **Italic** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `selected` state of the button according to the cursor position in the editing area.
+ * This directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `selected` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/typographical-emphasis/editor-strikethrough-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **Strikethrough** tool
+ * Configures a ToolBarButtonComponent as an Editor **Strikethrough** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `selected` state of the button according to the cursor position in the editing area.
+ * This directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `selected` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/typographical-emphasis/editor-subscript-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **Subscript** tool
+ * Configures a ToolBarButtonComponent as an Editor **Subscript** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `selected` state of the button according to the cursor position in the editing area.
+ * This directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `selected` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/typographical-emphasis/editor-superscript-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **Superscript** tool
+ * Configures a ToolBarButtonComponent as an Editor **Superscript** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `selected` state of the button according to the cursor position in the editing area.
+ * This directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `selected` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/tools/typographical-emphasis/editor-underline-button.directive.mjs

@@ -14,10 +14,10 @@ import * as i2 from "../../localization/editor-localization.service";
 import * as i3 from "../../common/provider.service";
 import * as i4 from "../tools.service";
 /**
- * A directive which configures an existing `ToolBarButtonComponent` as an Editor **Underline** tool
+ * Configures a ToolBarButtonComponent as an Editor **Underline** tool
  * ([see example]({% slug toolbartools_editor %}#toc-built-in-tools)).
- * The directive will predefine the SVG icon and `click` event handlers of the button.
- * In addition, the directive updates the `selected` state of the button according to the cursor position in the editing area.
+ * This directive sets the SVG icon and `click` event handlers for the button.
+ * The directive also updates the `selected` state of the button based on the cursor position in the editing area.
  *
  * @example
  * ```html

package/esm2022/util.mjs

@@ -104,20 +104,21 @@ export const conditionallyExecute = (fn) => (condition) => (param) => (condition
 export const pipe = (...fns) => x => fns.reduce((y, f) => f(y), x);
 // This re-declaration is necessary for proper API generation
 /**
- * A method for extracting the text from the current editor state's selection ([see example]({% slug plugins_editor %}#toc-popup-tools)).
+ * Extracts the text from the current editor state's selection ([see example]({% slug plugins_editor %}#toc-popup-tools)).
  *
+ * @example
  * ```ts
- * import {getSelectionText} from '@progress/kendo-angular-editor';
+ * import { getSelectionText } from '@progress/kendo-angular-editor';
  *
  * export class AppComponent {
  *     @ViewChild('editor') public editor;
- *     public onClick(){
- *         const selection = getSelectionText(this.editor.view.state)
+ *     public onClick() {
+ *         const selection = getSelectionText(this.editor.view.state);
  *     }
  * }
  * ```
- * @param state
- * @returns the selection text.
+ * @param state The current `EditorState`.
+ * @returns The selected text.
  */
 export const getSelectionText = (state) => commonGetSelectionText(state);
 /**