@progress/kendo-angular-spreadsheet 19.1.2-develop.4 → 19.1.2-develop.5

package/esm2022/spreadsheet.component.mjs

@@ -72,6 +72,14 @@ import * as i6 from "@progress/kendo-angular-dialog";
 import * as i7 from "@progress/kendo-angular-popup";
 /**
  * Represents the [Kendo UI Spreadsheet component for Angular]({% slug overview_spreadsheet %}).
+ *
+ * @example
+ * ```html
+ * <kendo-spreadsheet [sheets]="sheets"></kendo-spreadsheet>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link CustomMessagesComponent}
  */
 export class SpreadsheetComponent {
     ngZone;
@@ -134,7 +142,7 @@ export class SpreadsheetComponent {
         return this._activeSheet || this.spreadsheetService.spreadsheet?.activeSheet()?.name();
     }
     /**
-     * An array which defines the document sheets and their content.
+     * An array of `SheetDescriptor` objects that describe the sheets in the Spreadsheet.
      */
     set sheets(value) {
         const items = value.map((item, index, items) => ({
@@ -217,18 +225,18 @@ export class SpreadsheetComponent {
     /**
      * Fired when the end user clicks the Export to Excel toolbar button.
      * The event is preventable and exposes the `Workbook` object, a `preventDefault` method
-     * (if invoked, the generated file will not be saved), and the SpreadsheetWidget instance.
+     * (if invoked, the generated file will not be saved), and the `SpreadsheetWidget` instance.
      */
     excelExport = new EventEmitter();
     /**
      * Fired when the end user clicks the Open toolbar button.
      * The event is preventable and exposes the selected `File` or `Blob`, a `preventDefault` method
-     * (if invoked, the selected file will not be loaded), and the SpreadsheetWidget instance.
+     * (if invoked, the selected file will not be loaded), and the `SpreadsheetWidget` instance.
      */
     excelImport = new EventEmitter();
     /**
      * Fired when the active sheet is about to change.
-     * The event exposes the new active `Sheet` and the SpreadsheetWidget instance.
+     * The event exposes the new active `Sheet` and the `SpreadsheetWidget` instance.
      */
     activeSheetChange = new EventEmitter();
     formulaFxIcon = formulaFxIcon;

package/esm2022/spreadsheet.module.mjs

@@ -43,8 +43,17 @@ import * as i31 from "./tools/align/horizontal-align-tool.directive";
 import * as i32 from "./tools/align/vertical-align-tool.directive";
 // IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Spreadsheet component.
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Spreadsheet component.
+ *
+ * @example
+ * ```typescript
+ * import { SpreadsheetModule } from '@progress/kendo-angular-spreadsheet';
+ *
+ * @NgModule({
+ *   imports: [SpreadsheetModule]
+ * })
+ * export class AppModule {}
+ * ```
  */
 export class SpreadsheetModule {
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: SpreadsheetModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });

package/esm2022/tools/colorpicker/spreadsheet-backcolor.component.mjs

@@ -19,7 +19,10 @@ import * as i3 from "../../common/spreadsheet.service";
 import * as i4 from "../tools.service";
 import * as i5 from "@progress/kendo-angular-toolbar";
 /**
- * A component which changes the background color of the text ([more information](ToDo).
+ * A component which configures an existing `ColorPickerComponent` as a Spreadsheet tool to change the background color.
+ *
+ * The component associates a `kendo-colorpicker` with a Spreadsheet command that changes the background color of a content block and
+ * automatically defines the options of the color picker and sets its values. [See example](slug:toolbar_tools_spreadsheet#home-menu-item-tools).
  * @hidden
  */
 export class SpreadsheetBackColorComponent extends SpreadsheetDropDownToolBase {

package/esm2022/tools/colorpicker/spreadsheet-forecolor.component.mjs

@@ -19,7 +19,10 @@ import * as i3 from "../../common/spreadsheet.service";
 import * as i4 from "../tools.service";
 import * as i5 from "@progress/kendo-angular-toolbar";
 /**
- * A component which changes the color of the text ([more information](ToDo).
+ * A component which configures an existing `ColorPickerComponent` as a Spreadsheet tool to change the text color.
+ *
+ * The component associates a `kendo-colorpicker` with a Spreadsheet command that changes the foreground color of a content block and
+ * automatically defines the options of the color picker and sets its values. [See example](slug:toolbar_tools_spreadsheet#home-menu-item-tools).
  * @hidden
  */
 export class SpreadsheetForeColorComponent extends SpreadsheetDropDownToolBase {

package/esm2022/tools/font-family/spreadsheet-fontfamily-tool.component.mjs

@@ -19,10 +19,9 @@ import * as i3 from "../../common/spreadsheet.service";
 import * as i4 from "../tools.service";
 import * as i5 from "@progress/kendo-angular-toolbar";
 /**
- * A component which configures an existing `DropDownListComponent` as a Spreadsheet tool
- * ([see example](ToDo).
+ * A component which configures an existing `DropDownListComponent` as a Spreadsheet tool.
  * The component associates a `kendo-toolbar-dropdownlist` with a Spreadsheet command that changes the font family of a content block and
- * automatically defines the options of the drop-down list and sets its values ([see example](ToDo).
+ * automatically defines the options of the drop-down list and sets its values. [See example](slug:toolbar_tools_spreadsheet#home-menu-item-tools).
  *
  * @hidden
  */

package/esm2022/tools/font-size/spreadsheet-fontsize-tool.component.mjs

@@ -19,10 +19,9 @@ import * as i3 from "../../common/spreadsheet.service";
 import * as i4 from "../tools.service";
 import * as i5 from "@progress/kendo-angular-toolbar";
 /**
- * A component which configures an existing `DropDownListComponent` as a Spreadsheet tool
- * ([see example](ToDo).
+ * A component which configures an existing `DropDownListComponent` as a Spreadsheet tool.
  * The component associates a `kendo-toolbar-dropdownlist` with a Spreadsheet command that changes the font size of a content block and
- * automatically defines the options of the drop-down list and sets its values ([see example](ToDo).
+ * automatically defines the options of the drop-down list and sets its values. [See example](slug:toolbar_tools_spreadsheet#home-menu-item-tools).
  *
  * @hidden
  */

package/esm2022/utils.mjs

@@ -27,7 +27,7 @@ export const mapToSheetDescriptor = (sheetsArray) => {
 /**
  * @hidden
  */
-export const replaceMessagePlaceholder = (message, name, value) => message.replace(new RegExp(`\{\\s*${name}\\s*\}`, 'g'), value);
+export const replaceMessagePlaceholder = (message, name, value) => message.replace(new RegExp(`{\\s*${name}\\s*}`, 'g'), value);
 /**
  * @hidden
  */