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

package/esm2022/editing/add-command-tool.directive.mjs

@@ -14,21 +14,19 @@ import * as i2 from "@progress/kendo-angular-toolbar";
 import * as i3 from "../common/provider.service";
 /**
  * Represents the command for adding a new item to the Grid.
- * You can apply this directive to any `kendo-toolbar-button` element inside a
- * ToolbarComponent used in the Grid.
- *
- * When the user clicks the toolbar button that is associated with the directive, , the
- * [add]({% slug api_grid_gridcomponent %}#toc-add) event is triggered
- * ([see example]({% slug basics_editing_grid %})).
+ * You can apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent used in the Grid.
+ * When you click the toolbar button associated with the directive, the [`add`]({% slug api_grid_gridcomponent %}#toc-add) event triggers ([see example]({% slug basics_editing_grid %})).
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-grid>
  *      <kendo-toolbar>
  *         <kendo-toolbar-button text="Add new" kendoGridAddTool></kendo-toolbar-button>
  *      </kendo-toolbar>
  * </kendo-grid>
  * ```
+ * @remarks
+ * Applied to: {@link ToolBarButtonComponent}.
  */
 export class AddCommandToolbarDirective extends ToolbarEditingToolBase {
     editService;

package/esm2022/editing/add-command.directive.mjs

@@ -12,19 +12,14 @@ import * as i0 from "@angular/core";
 import * as i1 from "./edit.service";
 import * as i2 from "../common/provider.service";
 /**
- * Represents the command for adding a new item to the Grid. You can apply this directive to any
+ * Represents the command for adding a new item to the Grid. Apply this directive to any
  * `button` element inside a [ToolbarTemplate]({% slug api_grid_commandcolumncomponent %}).
- * When an associated button with the directive is clicked, the
- * [add]({% slug api_grid_gridcomponent %}#toc-add) event is triggered
+ * When you click the button with this directive, the [`add`]({% slug api_grid_gridcomponent %}#toc-add) event is triggered
  * ([see example]({% slug basics_editing_grid %})).
  *
  * @example
  * ```html
- * <kendo-grid>
- *    <ng-template kendoGridToolbarTemplate>
- *       <button kendoGridAddCommand>Add new</button>
- *    </ng-template>
- * </kendo-grid>
+ * <button kendoGridAddCommand>Add new item</button>
  * ```
  */
 export class AddCommandDirective extends Button {

package/esm2022/editing/cancel-command-tool.directive.mjs

@@ -16,20 +16,20 @@ import * as i3 from "../selection/selection.service";
 import * as i4 from "../common/provider.service";
 /**
  * Represents the `cancel` command in the Grid.
- * You can apply this directive to any `kendo-toolbar-button` element inside a
- * ToolbarComponent used in the Grid.
+ * Apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent in the Grid.
  *
- * When the user clicks the toolbar button that is associated with the directive, the
- * [cancel]({% slug api_grid_gridcomponent %}#toc-cancel) event is triggered.
+ * When you click the toolbar button with this directive, the [`cancel`]({% slug api_grid_gridcomponent %}#toc-cancel) event triggers.
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-grid>
  *      <kendo-toolbar>
  *         <kendo-toolbar-button text="Cancel" kendoGridCancelTool></kendo-toolbar-button>
  *      </kendo-toolbar>
  * </kendo-grid>
  * ```
+ * @remarks
+ * Applied to: {@link ToolBarButtonComponent}.
  */
 export class CancelCommandToolbarDirective extends ToolbarEditingToolBase {
     editService;

package/esm2022/editing/cancel-command.directive.mjs

@@ -13,14 +13,15 @@ import * as i0 from "@angular/core";
 import * as i1 from "./edit.service";
 import * as i2 from "../common/provider.service";
 /**
- * Represents the `cancel` command of the Grid. You can apply this directive to any `button`
+ * Represents the `cancel` command of the Grid. Apply this directive to any `button`
  * element inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %})
  * ([see example](slug:editing_directives_grid#toc-command-column-directives)).
- * When an associated button with the directive is clicked, the
- * [cancel]({% slug api_grid_gridcomponent %}#toc-cancel) event
- * is triggered. When the row is not in the edit mode, the button with the `kendoGridCancelCommand` is automatically hidden.
  *
- * You can control the content of the button based on the state of the row.
+ * When a button with this directive is clicked, the
+ * [`cancel`]({% slug api_grid_gridcomponent %}#toc-cancel) event
+ * is triggered. If the row is not in edit mode, the button is automatically hidden.
+ *
+ * You can customize the button content based on the row's state.
  *
  * @example
  * ```html

package/esm2022/editing/cell-close-event.mjs

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from '../common/preventable-event';
 /**
- * Arguments for the `cellClose` event.
+ * Arguments for the [`cellClose`](slug:api_grid_gridcomponent#toc-cellclose) event.
  */
 export class CellCloseEvent extends PreventableEvent {
     isNew;
@@ -20,14 +20,17 @@ export class CellCloseEvent extends PreventableEvent {
      */
     column;
     /**
-     * The [FormGroup](link:site.data.urls.angular['formgroupapi']) that is used to edit the cell which will be closed.
+     * The [FormGroup](link:site.data.urls.angular['formgroupapi']) used to edit the cell.
      */
     formGroup;
     /**
-     * The DOM event that caused the `cellClose` event.
-     * May not be present if `cellClose` was caused by an API call.
+     * The DOM event that triggered the `cellClose` event.
+     * May be undefined if the event was triggered programmatically.
      */
     originalEvent;
+    /**
+     * @hidden
+     */
     constructor(options) {
         super();
         Object.assign(this, options);

package/esm2022/editing/edit-command-tool.directive.mjs

@@ -15,21 +15,22 @@ import * as i2 from "@progress/kendo-angular-toolbar";
 import * as i3 from "../selection/selection.service";
 import * as i4 from "../common/provider.service";
 /**
- * Represents the `edit` command in the Grid.
- * You can apply this directive to any `kendo-toolbar-button` element inside a
- * ToolbarComponent used in the Grid.
+ * Represents the `edit` command in the Grid. Apply this directive to any `kendo-toolbar-button`
+ * element inside a ToolbarComponent used in the Grid.
  *
- * When the user clicks the toolbar button that is associated with the directive, the
- * [edit]({% slug api_grid_gridcomponent %}#toc-edit) event is triggered.
+ * When you click the toolbar button with this directive, the
+ * [`edit`]({% slug api_grid_gridcomponent %}#toc-edit) event fires.
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-grid>
- *      <kendo-toolbar>
- *         <kendo-toolbar-button text="Edit" kendoGridEditTool></kendo-toolbar-button>
- *      </kendo-toolbar>
+ *   <kendo-toolbar>
+ *     <kendo-toolbar-button text="Edit" kendoGridEditTool></kendo-toolbar-button>
+ *   </kendo-toolbar>
  * </kendo-grid>
  * ```
+ * @remarks
+ * Applied to: {@link ToolBarButtonComponent}.
  */
 export class EditCommandToolbarDirective extends ToolbarEditingToolBase {
     editService;

package/esm2022/editing/edit-command.directive.mjs

@@ -16,7 +16,7 @@ import * as i2 from "../common/provider.service";
  * Represents the `edit` command of the Grid. You can apply this directive to any `button`
  * element inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %}).
  * When an associated button with the directive is clicked, the
- * [edit]({% slug api_grid_gridcomponent %}#toc-edit) event
+ * [`edit`]({% slug api_grid_gridcomponent %}#toc-edit) event
  * is triggered ([see example]({% slug basics_editing_grid %})).
  *
  * When the row is in the `edit` mode, the button with `kendoGridEditCommand` is automatically hidden.

package/esm2022/editing/edit-template.directive.mjs

@@ -5,16 +5,24 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the column edit-cell template of the Grid ([see example](slug:custom_reactive_editing_grid#toc-setting-up-custom-inputs)).
- * Helps to customize the content of the edited cells. To define the cell template, nest an `<ng-template>`
- * tag with the `kendoGridEditTemplate` directive inside a `<kendo-grid-column>` tag.
+ * Lets you customize the content of edited cells by providing a column edit-cell template for the Grid ([see example](slug:custom_reactive_editing_grid#toc-setting-up-custom-inputs)).
+ * Place an `<ng-template>` tag with the `kendoGridEditTemplate` directive inside a `<kendo-grid-column>` tag to define the template.
  *
- * The template context is set to the current form group and the following additional fields are passed:
- * - `formGroup`&mdash;The current [FormGroup](link:site.data.urls.angular['formgroupapi']). Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax, for example, `let-formGroup`. If you use the Grid inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
- * - `rowIndex`&mdash;The current data row index. If inside a new item row, `rowIndex` is `-1`. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
- * - `dataItem`&mdash;The current data item. Use it as an alias for a template variable by utilizing the `let-dataItem="dataItem"` syntax.
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
- * - `isNew`&mdash;The state of the current item. Use it as an alias for a template variable by utilizing the `let-isNew="isNew"` syntax.
+ * The template context includes:
+ * - `formGroup`&mdash;The current [FormGroup](link:site.data.urls.angular['formgroupapi']). This is the default context for template variables using `let-x`, such as `let-formGroup`. If you use the Grid in [Template-Driven Forms](link:site.data.urls.angular['forms']), this is `undefined`.
+ * - `rowIndex`&mdash;The current data row index. For a new item row, `rowIndex` is `-1`. Use `let-rowIndex="rowIndex"` to access it.
+ * - `dataItem`&mdash;The current data item. Use `let-dataItem="dataItem"` to access it.
+ * - `column`&mdash;The current column instance. Use `let-column="column"` to access it.
+ * - `isNew`&mdash;The state of the current item. Use `let-isNew="isNew"` to access it.
+ *
+ * @example
+ * ```html
+ * <kendo-grid-column>
+ *   <ng-template kendoGridEditTemplate let-formGroup="formGroup" let-dataItem="dataItem">
+ *     <kendo-textbox [formControl]="formGroup.get('field')"></kendo-textbox>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export class EditTemplateDirective {
     templateRef;

package/esm2022/editing/remove-command-tool.directive.mjs

@@ -15,21 +15,22 @@ import * as i2 from "@progress/kendo-angular-toolbar";
 import * as i3 from "../selection/selection.service";
 import * as i4 from "../common/provider.service";
 /**
- * Represents the `remove` command in the Grid.
- * You can apply this directive to any `kendo-toolbar-button` element inside a
- * ToolbarComponent used in the Grid.
+ * Represents the `remove` command in the Grid. Apply this directive to any `kendo-toolbar-button`
+ * element inside a ToolbarComponent used in the Grid.
  *
- * When the user clicks the toolbar button that is associated with the directive, the
- * [remove]({% slug api_grid_gridcomponent %}#toc-remove) event is triggered.
+ * When you click the toolbar button with this directive, the
+ * [`remove`]({% slug api_grid_gridcomponent %}#toc-remove) event fires.
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-grid>
- *      <kendo-toolbar>
- *         <kendo-toolbar-button text="Remove row" kendoGridRemoveTool></kendo-toolbar-button>
- *      </kendo-toolbar>
+ *   <kendo-toolbar>
+ *      <kendo-toolbar-button text="Remove row" kendoGridRemoveTool></kendo-toolbar-button>
+ *   </kendo-toolbar>
  * </kendo-grid>
  * ```
+ * @remarks
+ * Applied to: {@link ToolBarButtonComponent}.
  */
 export class RemoveCommandToolbarDirective extends ToolbarEditingToolBase {
     editService;

package/esm2022/editing/remove-command.directive.mjs

@@ -13,13 +13,12 @@ import * as i0 from "@angular/core";
 import * as i1 from "./edit.service";
 import * as i2 from "../common/provider.service";
 /**
- * Represents the `remove` command of the Grid. You can apply this directive to any `button` element
+ * Represents the `remove` command of the Grid. Apply this directive to any `button` element
  * inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %})
  * ([see example](slug:editing_directives_grid#toc-command-column-directives)).
- * When an associated button with the directive is clicked, the
- * [remove]({% slug api_grid_gridcomponent %}#toc-remove) event
- * is triggered.
- * When the row is in the `edit` mode, the button with the `kendoGridRemoveCommand` is automatically hidden.
+ * When you click the button with this directive, the
+ * [`remove`]({% slug api_grid_gridcomponent %}#toc-remove) event fires.
+ * The button with `kendoGridRemoveCommand` is automatically hidden when the row is in edit mode.
  *
  * @example
  * ```html

package/esm2022/editing/save-command-tool.directive.mjs

@@ -15,21 +15,22 @@ import * as i2 from "@progress/kendo-angular-toolbar";
 import * as i3 from "../selection/selection.service";
 import * as i4 from "../common/provider.service";
 /**
- * Represents the `save` command in the Grid.
- * You can apply this directive to any `kendo-toolbar-button` element inside a
- * ToolbarComponent used in the Grid.
+ * Represents the `save` command in the Grid. Apply this directive to any `kendo-toolbar-button`
+ * element inside a ToolbarComponent used in the Grid.
  *
- * When the user clicks the toolbar button that is associated with the directive, the
- * [save]({% slug api_grid_gridcomponent %}#toc-save) event is triggered.
+ * When you click the toolbar button with this directive, the
+ * [`save`]({% slug api_grid_gridcomponent %}#toc-save) event fires.
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-grid>
  *      <kendo-toolbar>
  *         <kendo-toolbar-button text="Save" kendoGridSaveTool></kendo-toolbar-button>
  *      </kendo-toolbar>
  * </kendo-grid>
  * ```
+ * @remarks
+ * Applied to: {@link ToolBarButtonComponent}.
  */
 export class SaveCommandToolbarDirective extends ToolbarEditingToolBase {
     editService;

package/esm2022/editing/save-command.directive.mjs

@@ -13,14 +13,14 @@ import * as i0 from "@angular/core";
 import * as i1 from "./edit.service";
 import * as i2 from "../common/provider.service";
 /**
- * Represents the `save` command of the Grid. You can apply this directive to any `button`
+ * Represents the `save` command of the Grid. Apply this directive to any `button`
  * element inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %})
  * ([see example](slug:editing_directives_grid#toc-command-column-directives)).
- * When an associated button with the directive is clicked, the
- * [save]({% slug api_grid_gridcomponent %}#toc-save) event
- * is triggered. When the row is not in the edit mode, the button with `kendoGridSaveCommand` is automatically hidden.
+ * When you click the button with this directive, the
+ * [`save`]({% slug api_grid_gridcomponent %}#toc-save) event fires.
+ * The button with `kendoGridSaveCommand` is automatically hidden when the row is not in edit mode.
  *
- * You can control the content of the button based on the state of the row.
+ * You can change the button content based on the row state.
  *
  * @example
  * ```html

package/esm2022/editing-directives/external-editing.directive.mjs

@@ -15,23 +15,30 @@ import * as i1 from "../grid.component";
 import * as i2 from "../editing/local-data-changes.service";
 import * as i3 from "../common/adaptiveness.service";
 /**
- * A directive which encapsulates the editing operations of the Grid when using the
+ * Represents the Kendo UI Grid external editing directive. The directive manages editing operations in the Grid when using the
  * External Form ([see example](slug:editing_directives_grid#external-editing)).
+ *
+ * @example
+ * ```typescript
+ * <kendo-grid [data]="data" kendoGridExternalEditing></kendo-grid>
+ * ```
+ * @remarks
+ * Applied to: {@link GridComponent}.
  */
 export class ExternalEditingDirective extends EditingDirectiveBase {
     grid;
     localDataChangesService;
     adaptiveGridService;
     /**
-     * The function that creates the `FormGroup` for the edited model.
+     * Specifies the function that creates the `FormGroup` for the edited model.
      */
     createFormGroup;
     /**
-     * Allows you to customize form orientation, hints, labels and error messages.
+     * Customizes form orientation, hints, labels, and error messages.
      */
     formSettings;
     /**
-     * Allows you to customize the Dialog that contains the edit form.
+     * Customizes the Dialog that contains the edit form.
      */
     dialogSettings;
     constructor(grid, localDataChangesService, adaptiveGridService) {

package/esm2022/editing-directives/in-cell-editing.directive.mjs

@@ -12,15 +12,21 @@ import * as i0 from "@angular/core";
 import * as i1 from "../grid.component";
 import * as i2 from "../editing/local-data-changes.service";
 /**
- * A directive which encapsulates the editing operations of the Grid when using the in-cell
- * editing with Reactive Forms ([see example]({% slug editing_directives_grid %}#toc-in-cell-editing)).
+ * Represent the directive that manages in-cell editing operations in the Grid when using Reactive Forms ([see example]({% slug editing_directives_grid %}#toc-in-cell-editing)).
+ *
+ * @example
+ * ```typescript
+ * <kendo-grid [data]="data" kendoGridInCellEditing></kendo-grid>
+ * ```
+ * @remarks
+ * Applied to: {@link GridComponent}.
  */
 export class InCellEditingDirective extends EditingDirectiveBase {
     grid;
     localDataChangesService;
     cdr;
     /**
-     * The function that creates the `FormGroup` for the edited model.
+     * Specifies the function that creates the `FormGroup` for the edited model.
      */
     createFormGroup;
     constructor(grid, localDataChangesService, cdr) {

package/esm2022/editing-directives/reactive-editing.directive.mjs

@@ -11,14 +11,20 @@ import * as i0 from "@angular/core";
 import * as i1 from "../grid.component";
 import * as i2 from "../editing/local-data-changes.service";
 /**
- * A directive which encapsulates the editing operations of the Grid when using the
- * Reactive Forms ([see example](slug:editing_directives_grid#toc-reactive-editing-directive)).
+ * Represents the directive that manages editing operations in the Grid when using Reactive Forms ([see example](slug:editing_directives_grid#toc-reactive-editing-directive)).
+ *
+ * @example
+ * ```typescript
+ * <kendo-grid [data]="data" kendoGridReactiveEditing></kendo-grid>
+ * ```
+ * @remarks
+ * Applied to: {@link GridComponent}.
  */
 export class ReactiveEditingDirective extends RowEditingDirectiveBase {
     grid;
     localDataChangesService;
     /**
-     * The function that creates the `FormGroup` for the edited model.
+     * Specifies the function that creates the `FormGroup` for the edited model.
      */
     createFormGroup;
     constructor(grid, localDataChangesService) {

package/esm2022/editing-directives/template-editing.directive.mjs

@@ -10,14 +10,20 @@ import * as i0 from "@angular/core";
 import * as i1 from "../grid.component";
 import * as i2 from "../editing/local-data-changes.service";
 /**
- * A directive which encapsulates the editing operations of the Grid when using
- * the Template-Driven Angular Forms ([see example]({% slug editing_directives_grid %}#toc-template-editing-directive)).
+ * Represents the directive that manages editing operations in the Grid when using Template-Driven Angular Forms ([see example]({% slug editing_directives_grid %}#toc-template-editing-directive)).
+ *
+ * @example
+ * ```typescript
+ * <kendo-grid [data]="data" kendoGridTemplateEditing></kendo-grid>
+ * ```
+ * @remarks
+ * Applied to: {@link GridComponent}.
  */
 export class TemplateEditingDirective extends RowEditingDirectiveBase {
     grid;
     localDataChangesService;
     /**
-     * The function that creates the `dataItem` for the new rows.
+     * Specifies the function that creates the `dataItem` for new rows.
      */
     createNewItem;
     dataItem;

package/esm2022/excel/excel-command-tool.directive.mjs

@@ -13,24 +13,21 @@ import * as i1 from "./excel.service";
 import * as i2 from "@progress/kendo-angular-toolbar";
 import * as i3 from "../common/provider.service";
 /**
- * Represents the `export-to-Excel` toolbar tool of the Grid.
- * You can apply this directive to any `kendo-toolbar-button` element inside a
- * ToolbarComponent used in the Grid.
- *
- * When the user clicks a button associated with the directive, the
- * [excelExport]({% slug api_grid_gridcomponent %}#toc-excelexport) event
- * fires ([see example]({% slug excelexport_grid %})).
+ * Represents the **Export to Excel** toolbar tool of the Grid.
+ * Apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent used in the Grid.
+ * When the user clicks the button, the [`excelExport`]({% slug api_grid_gridcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_grid %})).
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-grid>
- *      <kendo-toolbar>
- *         <kendo-toolbar-button text="Excel Export" kendoGridExcelTool></kendo-toolbar-button>
- *      </kendo-toolbar>
- *      <kendo-grid-excel fileName="Grid.xlsx">
- *      </kendo-grid-excel>
+ *   <kendo-toolbar>
+ *     <kendo-toolbar-button text="Excel Export" kendoGridExcelTool></kendo-toolbar-button>
+ *   </kendo-toolbar>
+ *   <kendo-grid-excel fileName="Grid.xlsx"></kendo-grid-excel>
  * </kendo-grid>
  * ```
+ * @remarks
+ * Applied to: {@link ToolBarButtonComponent}.
  */
 export class ExcelCommandToolbarDirective extends ToolbarToolBase {
     excelService;

package/esm2022/excel/excel-command.directive.mjs

@@ -12,21 +12,17 @@ import * as i0 from "@angular/core";
 import * as i1 from "./excel.service";
 import * as i2 from "../common/provider.service";
 /**
- * Represents the `export-to-Excel` command of the Grid. You can apply this
- * directive to any `button` element inside a
- * [ToolbarTemplate]({% slug api_grid_toolbartemplatedirective %}).
- * When the user clicks a button associated with the directive, the
- * [excelExport]({% slug api_grid_gridcomponent %}#toc-excelexport) event
- * fires ([see example]({% slug excelexport_grid %})).
+ * Represents the `excelExport` command of the Grid. Apply this
+ * directive to any `button` element inside a [`ToolbarTemplate`]({% slug api_grid_toolbartemplatedirective %}).
+ * When the user clicks the button, the [`excelExport`]({% slug api_grid_gridcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_grid %})).
  *
  * @example
  * ```html
  * <kendo-grid>
- *      <ng-template kendoGridToolbarTemplate>
- *          <button kendoGridExcelCommand>Export to Excel</button>
- *      </ng-template>
- *      <kendo-grid-excel fileName="Grid.xlsx">
- *      </kendo-grid-excel>
+ *   <ng-template kendoGridToolbarTemplate>
+ *     <button kendoGridExcelCommand>Export to Excel</button>
+ *   </ng-template>
+ *   <kendo-grid-excel fileName="Grid.xlsx"></kendo-grid-excel>
  * </kendo-grid>
  * ```
  */

package/esm2022/excel/excel-export-event.mjs

@@ -4,10 +4,13 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from '../common/preventable-event';
 /**
- * Arguments for the `excelExport` event.
+ * Provides arguments for the `excelExport` event.
  */
 export class ExcelExportEvent extends PreventableEvent {
     workbook;
+    /**
+     * @hidden
+     */
     constructor(workbook) {
         super();
         this.workbook = workbook;

package/esm2022/excel/excel.component.mjs

@@ -57,64 +57,63 @@ const componentColumns = (component) => {
     return orderBy(columns, [{ field: 'locked', dir: 'desc' }]);
 };
 /**
- * Configures the settings for the export of Grid in Excel ([see example]({% slug excelexport_grid %})).
+ * The component is required when exporting the data to an Excel file. The componnet provides different options to further configure the Excel export settings of the Grid ([see example]({% slug excelexport_grid %})).
+ *
+ * @example
+ * ```html
+ * <kendo-grid>
+ *   <kendo-grid-excel fileName="Export.xlsx"></kendo-grid-excel>
+ * </kendo-grid>
+ * ```
  */
 export class ExcelComponent {
     ctx;
     zone;
     /**
-     * Specifies the file name of the exported Excel file.
+     * Sets the file name for the exported Excel file.
      * @default "Export.xlsx"
      */
     fileName = 'Export.xlsx';
     /**
-     * Enables or disables column filtering in the Excel file. This behavior is different from the filtering feature of the Grid.
+     * Enables or disables column filtering in the Excel file. This option is different from the Grid's filtering feature.
      */
     filterable;
     /**
-     * The author of the workbook.
+     * Sets the author of the workbook.
      */
     creator;
     /**
-     * The date on which the workbook was created. Defaults to `new Date()`.
+     * Sets the creation date of the workbook.
      */
     date;
     /**
-     * If set to `true`, the content is forwarded to [proxyURL](#toc-proxyurl) even if the browser supports the saving of files locally.
+     * Forwards the content to [`proxyURL`](#toc-proxyurl) even if the browser supports local file saving when set to `true`.
      */
     forceProxy;
     /**
-     * The URL of the server-side proxy which streams the file to the end user.
-     *
-     * Using a proxy is required if the browser is not capable of saving files locally.
-     *
-     * Optionally, set up a proxy to reduce memory usage. This avoids copying the file contents in memory,
-     * but transmits it over the network instead. For this use case, set [forceProxy](#toc-forceproxy) to `true`
-     * to skip client-side saving even in browser that support it.
-     *
-     * In the request body, the proxy receives a POST request with the specific parameters. [See example](slug:server_proxy#toc-implementations).
-     * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
-     *
-     * For details on the server-side proxy usage and implementation, see the [File Saver]({% slug overview_filesaver %}) documentation.
+     * Sets the URL of the server-side proxy that streams the file to the user. Use a proxy if the browser cannot save files locally.
+     * You can also use a proxy to reduce memory usage by transmitting the file over the network.
+     * Set [`forceProxy`](#toc-forceproxy) to `true` to skip client-side saving.
+     * The proxy receives a POST request with specific parameters and returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
+     * For more details, see the [File Saver]({% slug overview_filesaver %}) documentation.
      */
     proxyURL;
     /**
-     * The function that is used to get the exported data options. By default, uses the current data and group of the Grid.
-     * To export data that is different from the current Grid data, provide a custom function.
+     * Provides a function to get the exported data options. By default, uses the current Grid data and group.
+     * Supply a custom function to export different data. Typically used to export all data, not just the current page [see example](slug:excelexport_grid#exporting-specific-data).
      */
     fetchData;
     /**
-     * If the data is grouped, the options of the cells that are inserted before the data,
-     * group, and footer cells to indicate the group hierarchy.
+     * Sets options for cells inserted before the data, group, and footer cells to indicate the group hierarchy if the data is grouped.
+     *
      */
     paddingCellOptions;
     /**
-     * If the data is grouped, the options of the cells that are inserted before the
-     * header cells to align the headers and the column values.
+     * Sets the options for cells inserted before the header cells to align the headers and the column values when the data is grouped.
      */
     headerPaddingCellOptions;
     /**
-     * Specifies if the groups in the Excel file are collapsible.
+     * Specifies if groups in the Excel file are collapsible.
      */
     collapsible;
     /**

package/esm2022/excel/excel.module.mjs

@@ -13,11 +13,9 @@ import * as i4 from "./excel-command-tool.directive";
 import * as i5 from "@progress/kendo-angular-excel-export";
 // IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Excel component of the Grid.
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Excel component of the Grid.
  *
  * @example
- *
  * ```ts
  * import { NgModule } from '@angular/core';
  * import { BrowserModule } from "@angular/platform-browser";
@@ -25,12 +23,11 @@ import * as i5 from "@progress/kendo-angular-excel-export";
  * import { AppComponent } from './app.component';
  *
  * _@NgModule({
- *     declarations: [AppComponent],
- *     imports:      [BrowserModule, GridModule, ExcelModule],
- *     bootstrap:    [AppComponent]
+ *   declarations: [AppComponent],
+ *   imports: [BrowserModule, GridModule, ExcelModule],
+ *   bootstrap: [AppComponent]
  * })
  * export class AppModule {}
- *
  * ```
  */
 export class ExcelModule {