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

package/esm2022/column-menu/column-menu-filter.component.mjs

@@ -14,9 +14,8 @@ import * as i1 from "../common/provider.service";
 /**
  * Represents the column-menu item for editing column filters in the Grid. [See example](slug:columnmenu_grid#toc-filter-item).
  *
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
- * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
- * the template to the service input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive.
+ * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_grid_columnmenuservice %}) that the template passes to the `service` input of the `kendo-grid-columnmenu-filter` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
  *
  * @example
  * ```html
@@ -27,16 +26,25 @@ import * as i1 from "../common/provider.service";
  *   </ng-template>
  * </kendo-grid>
  * ```
+ * @example
+ * ```html
+ * <kendo-grid-column field="ProductName">
+ *   <ng-template kendoGridColumnMenuTemplate let-service="service">
+ *     <kendo-grid-columnmenu-filter [service]="service">
+ *     </kendo-grid-columnmenu-filter>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export class ColumnMenuFilterComponent extends ColumnMenuItemBase {
     ctx;
     hostElement;
     /**
-     * Fires when the content is expanded.
+     * Emits when the content expands.
      */
     expand = new EventEmitter();
     /**
-     * Fires when the content is collapsed.
+     * Emits when the content collapses.
      */
     collapse = new EventEmitter();
     /**
@@ -45,13 +53,18 @@ export class ColumnMenuFilterComponent extends ColumnMenuItemBase {
      */
     expanded = false;
     /**
+     * Specifies if this is the last item in the menu.
      * @hidden
      */
     isLast = false;
     /**
+     * Sets the CSS class for the actions container.
      * @hidden
      */
     actionsClass = 'k-actions k-actions-stretched k-actions-horizontal';
+    /**
+     * Defines the SVG icon for the filter.
+     */
     filterIcon = filterIcon;
     constructor(ctx, hostElement) {
         super();

package/esm2022/column-menu/column-menu-item-base.mjs

@@ -11,8 +11,8 @@ import * as i0 from "@angular/core";
  */
 export class ColumnMenuItemBase {
     /**
-     * Represents the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) class.
-     * Requires a mandatory input.
+     * Represents the [`ColumnMenuService`]({% slug api_grid_columnmenuservice %}) class.
+     * This input is required.
      */
     service;
     hostClass = true;

package/esm2022/column-menu/column-menu-item-content-template.directive.mjs

@@ -7,7 +7,7 @@ import * as i0 from "@angular/core";
 /**
  * Represents the content template of the
  * [`ColumnMenuItemComponent`]({% slug api_grid_columnmenuitemcomponent %}) component.
- * Provides an option for specifying the content of a column item.
+ * Use this directive to specify the content of a column menu item.
  * To define the content template, nest an `<ng-template>` tag with the
  * `kendoGridColumnMenuItemContentTemplate` directive inside a `<kendo-grid-columnmenu-item>`.
  *
@@ -15,13 +15,13 @@ import * as i0 from "@angular/core";
  * ```html
  * <kendo-grid [data]="data" [columnMenu]="true" ...>
  *   <ng-template kendoGridColumnMenuTemplate>
- *     <kendo-grid-columnmenu-item text="Item Text" [expanded]="true">
+ *     <kendo-grid-columnmenu-item text="Text" [expanded]="true">
  *       <ng-template kendoGridColumnMenuItemContentTemplate>
- *         Item Content
+ *         Content
  *       </ng-template>
  *     </kendo-grid-columnmenu-item>
  *   </ng-template>
- *   <kendo-grid-column field="Field1"></kendo-grid-column>
+ *   <kendo-grid-column field="ID"></kendo-grid-column>
  *   ...
  * </kendo-grid>
  * ```

package/esm2022/column-menu/column-menu-item.component.mjs

@@ -21,8 +21,8 @@ import * as i0 from "@angular/core";
 import * as i1 from "../common/provider.service";
 import * as i2 from "../common/adaptiveness.service";
 /**
- * Represents an item that can be placed inside a
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
+ * Represents an item that you can place inside a
+ * [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive.
  *
  * @example
  * ```html
@@ -32,6 +32,14 @@ import * as i2 from "../common/adaptiveness.service";
  *   </ng-template>
  * </kendo-grid>
  * ```
+ * @example
+ * ```html
+ * <kendo-grid-column field="ProductName">
+ *   <ng-template kendoGridColumnMenuTemplate let-service="service">
+ *     kendo-grid-columnmenu-item text="Fit column"></kendo-grid-columnmenu-item>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export class ColumnMenuItemComponent {
     ngZone;
@@ -51,20 +59,19 @@ export class ColumnMenuItemComponent {
      */
     itemClick = new EventEmitter();
     /**
-     * Fires when the content is expanded.
+     * Fires when the content expands.
      */
     expand = new EventEmitter();
     /**
-     * Fires when the content is collapsed.
+     * Fires when the content collapses.
      */
     collapse = new EventEmitter();
     /**
-     * Specifies the name of the [font icon](slug:icon_list)
-     * that will be rendered within the item.
+     * Specifies the name of the font icon to render within the item.
      */
     icon;
     /**
-     * Defines the [SVG icon](slug:svgicon_list) to be rendered within the item.
+     * Specifies the SVG icon to render within the item.
      */
     svgIcon;
     /**

package/esm2022/column-menu/column-menu-item.directive.mjs

@@ -11,6 +11,28 @@ import { ColumnMenuFilterComponent } from './column-menu-filter.component';
 import { ContextService } from '../common/provider.service';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/provider.service";
+/**
+ * Represents a directive that manages keyboard navigation for a column menu item. [See example](slug:columnmenu_grid#customizing-the-content).
+ *
+ * @example
+ * ```html
+ * <ng-template kendoGridColumnMenuTemplate let-service="service" let-column="column">
+ *   <kendo-grid-columnmenu-sort #sortItem [kendoGridColumnMenuItem]="sortItem" [service]="service"></kendo-grid-columnmenu-sort>
+ * </ng-template>
+ * ```
+ * @remarks
+ * Applied to:
+ * {@link ColumnMenuChooserComponent},
+ * {@link ColumnMenuFilterComponent},
+ * {@link ColumnMenuSortComponent},
+ * {@link ColumnMenuLockComponent},
+ * {@link ColumnMenuStickyComponent},
+ * {@link ColumnMenuComponent},
+ * {@link ColumnMenuItemComponent},
+ * {@link ColumnMenuPositionComponent},
+ * {@link ColumnMenuAutoSizeAllColumnsComponent},
+ * {@link ColumnMenuAutoSizeColumnComponent}.
+ */
 export class ColumnMenuItemDirective {
     hostElement;
     renderer;
@@ -18,10 +40,16 @@ export class ColumnMenuItemDirective {
     cdr;
     ctx;
     /**
-     * The reference to the Grid column menu item. Required to include the item in the built-in keyboard navigation.
+     * Reference to the Grid column menu item. Required when you want to include the item in the built-in keyboard navigation.
      */
     menuItemComponent;
+    /**
+     * Holds the first focusable element.
+     */
     firstFocusableElement;
+    /**
+     * Holds the last focusable element.
+     */
     lastFocusableElement;
     /**
      * @hidden

package/esm2022/column-menu/column-menu-lock.component.mjs

@@ -14,9 +14,8 @@ import * as i2 from "../common/column-info.service";
 /**
  * Represents the column-menu item for locking and unlocking columns in the Grid. [See example](slug:columnmenu_grid#toc-lock-and-unlock-items).
  *
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
- * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
- * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive.
+ * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_grid_columnmenuservice %}) that the template passes to the `service` input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
  *
  * @example
  * ```html
@@ -27,6 +26,15 @@ import * as i2 from "../common/column-info.service";
  *   </ng-template>
  * </kendo-grid>
  * ```
+ * @example
+ * ```html
+ * <kendo-grid-column field="ProductName">
+ *   <ng-template kendoGridColumnMenuTemplate let-service="service">
+ *     <kendo-grid-columnmenu-lock [service]="service">
+ *     </kendo-grid-columnmenu-lock>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export class ColumnMenuLockComponent extends ColumnMenuItemBase {
     ctx;

package/esm2022/column-menu/column-menu-position.component.mjs

@@ -14,11 +14,10 @@ import { ColumnMenuItemComponent } from './column-menu-item.component';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/provider.service";
 /**
- * Represents the column-menu item which combines the lock and sticky column functionalities.
+ * Represents the column-menu item that combines lock and sticky column functionalities.
  *
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
- * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
- * the template to the service input of the `kendo-grid-columnmenu-position` component. [See example](slug:columnmenu_grid#toc-set-column-position-item).
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive.
+ * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_grid_columnmenuservice %}) that the template passes to the `service` input of the `kendo-grid-columnmenu-position` component. [See example](slug:columnmenu_grid#toc-set-column-position-item).
  *
  * @example
  * ```html
@@ -29,16 +28,25 @@ import * as i1 from "../common/provider.service";
  *   </ng-template>
  * </kendo-grid>
  * ```
+ * @example
+ * ```html
+ * <kendo-grid-column field="ProductName">
+ *   <ng-template kendoGridColumnMenuTemplate let-service="service">
+ *     <kendo-grid-columnmenu-position [service]="service" [showLock]="true" [showStick]="true">
+ *     </kendo-grid-columnmenu-position>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export class ColumnMenuPositionComponent extends ColumnMenuItemBase {
     ctx;
     hostElement;
     /**
-     * Fires when the content is expanded.
+     * Emits when the content expands.
      */
     expand = new EventEmitter();
     /**
-     * Fires when the content is collapsed.
+     * Emits when the content collapses.
      */
     collapse = new EventEmitter();
     /**
@@ -47,11 +55,11 @@ export class ColumnMenuPositionComponent extends ColumnMenuItemBase {
      */
     expanded = false;
     /**
-     * Specifies if the lock column item is displayed.
+     * Specifies if the lock column item is shown.
      */
     showLock;
     /**
-     * Specifies if the stick column item is displayed.
+     * Specifies if the stick column item is shown.
      */
     showStick;
     /**

package/esm2022/column-menu/column-menu-sort.component.mjs

@@ -14,24 +14,26 @@ import * as i1 from "../common/provider.service";
 import * as i2 from "../common/sort.service";
 /**
  * Represents the column-menu item for sorting Grid columns.
- * [See example](slug:columnmenu_grid#toc-sort-item).
  *
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
- * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
- * the template to the service input of the `kendo-grid-columnmenu-sort` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
- *
- * You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
- * the template to the service input of the `kendo-grid-columnmenu-sort` component.
+ * Provides sorting options (ascending and descending) for a specific column in the Grid.
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive and pass the [`ColumnMenuService`]({% slug api_grid_columnmenuservice %}) to the `service` input of the `kendo-grid-columnmenu-sort` component.
  *
  * @example
  * ```html
  * <kendo-grid [kendoGridBinding]="data" [sortable]="true" [columnMenu]="true">
  *   <ng-template kendoGridColumnMenuTemplate let-service="service">
- *     <kendo-grid-columnmenu-sort [service]="service">
- *     </kendo-grid-columnmenu-sort>
+ *     <kendo-grid-columnmenu-sort [service]="service"></kendo-grid-columnmenu-sort>
  *   </ng-template>
  * </kendo-grid>
  * ```
+ *  * @example
+ * ```html
+ * <kendo-grid-column field="ProductName">
+ *   <ng-template kendoGridColumnMenuTemplate let-service="service">
+ *     <kendo-grid-columnmenu-sort [service]="service"></kendo-grid-columnmenu-sort>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export class ColumnMenuSortComponent extends ColumnMenuItemBase {
     ctx;

package/esm2022/column-menu/column-menu-stick.component.mjs

@@ -12,12 +12,12 @@ import * as i0 from "@angular/core";
 import * as i1 from "../common/provider.service";
 import * as i2 from "../common/column-info.service";
 /**
- * Represents the column-menu item that sticks or unsticks columns in the Grid.
+ * Represents a column-menu item for sticking or unsticking columns in the Grid.
  * [See example](slug:columnmenu_grid#toc-stick-and-unstick-items).
  *
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
- * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
- * the template to the service input of the `kendo-grid-columnmenu-lock` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive.
+ * To register the component as a column menu item, set the [`ColumnMenuService`]({% slug api_grid_columnmenuservice %}) from the template to the `service` input of the `kendo-grid-columnmenu-stick` component.
+ * [See example](slug:columnmenu_grid#toc-customizing-the-content).
  *
  * @example
  * ```html
@@ -27,7 +27,15 @@ import * as i2 from "../common/column-info.service";
  *      </kendo-grid-columnmenu-stick>
  *   </ng-template>
  * </kendo-grid>
- *
+ * ```
+ * @example
+ * ```html
+ * <kendo-grid-column field="ProductName">
+ *   <ng-template kendoGridColumnMenuTemplate let-service="service">
+ *     <kendo-grid-columnmenu-stick [service]="service">
+ *     </kendo-grid-columnmenu-stick>
+ *   </ng-template>
+ * </kendo-grid-column>
  * ```
  */
 export class ColumnMenuStickComponent extends ColumnMenuItemBase {

package/esm2022/column-menu/column-menu-template.directive.mjs

@@ -5,14 +5,12 @@
 import { Directive, Optional, TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the template for the column menu in the Grid. Provides an option for
- * customizing the content of the column menu for all or for specific columns.
- * To define the content template, nest an `<ng-template>` tag with the
- * `kendoGridColumnMenuTemplate` directive inside the `<kendo-grid>` or the `<kendo-grid-column>` component.
+ * Defines a template for the column menu in the Grid. Use this directive to customize the column menu content for all columns or for specific columns.
+ * Place an `<ng-template>` tag with the `kendoGridColumnMenuTemplate` directive inside the `<kendo-grid>` or `<kendo-grid-column>` component to set the template.
  *
- * The template context is passes through the following fields:
- * - `service`&mdash;Represents the [ColumnMenuService]({% slug api_grid_columnmenuservice %}).
- * - `column`&mdash;Represents the Grid column.
+ * The template context provides these fields:
+ * - `service`&mdash;The [`ColumnMenuService`]({% slug api_grid_columnmenuservice %}).
+ * - `column`&mdash;The Grid column.
  *
  * @example
  * ```html

package/esm2022/column-menu/column-menu.component.mjs

@@ -44,15 +44,25 @@ let id = 0;
 const getId = (gridId) => `${gridId}-column-menu-${id++}`;
 /**
  * Represents the [column menu](slug:columnmenu_grid#toc-customizing-the-position) component.
+ *
+ * @example
  * ```html
  * <kendo-grid ...>
  *   <kendo-grid-column field="ProductName" [columnMenu]="false">
  *     <ng-template kendoGridHeaderTemplate let-column>
- *        <kendo-grid-column-menu [column]="column"> </kendo-grid-column-menu>
+ *       <kendo-grid-column-menu [column]="column"></kendo-grid-column-menu>
  *     </ng-template>
  *   </kendo-grid-column>
  * </kendo-grid>
  * ```
+ * @example
+ * ```html
+ * <kendo-grid-column field="ProductName">
+ *   <ng-template kendoGridColumnMenuTemplate let-service="service">
+ *     <kendo-grid-column-menu [column]="column"></kendo-grid-column-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export class ColumnMenuComponent {
     navigationService;
@@ -69,21 +79,21 @@ export class ColumnMenuComponent {
      */
     standalone = true;
     /**
-     * The Grid column instance to control with the menu.
+     * The Grid column instance controlled by the menu.
      */
     column;
     /**
-     * The settings for the Column Menu.
+     * The settings for the column menu.
      */
     settings = {};
     /**
-     * The descriptors by which the data will be sorted.
-     * Typically bound to the same value as [GridComponent.sort]({% slug api_grid_gridcomponent %}#toc-sort).
+     * The sort descriptors for the Grid data.
+     * Typically bound to [`GridComponent.sort`]({% slug api_grid_gridcomponent %}#toc-sort).
      */
     sort;
     /**
-     * The descriptor by which the data will be filtered.
-     * Typically bound to the same value as [GridComponent.filter]({% slug api_grid_gridcomponent %}#toc-filter).
+     * The filter descriptor for the Grid data.
+     * Typically bound to [`GridComponent.filter`]({% slug api_grid_gridcomponent %}#toc-filter).
      */
     filter;
     /**

package/esm2022/column-menu/column-menu.service.mjs

@@ -7,20 +7,19 @@ import { Injectable, EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "./../filtering/menu/menu-tabbing.service";
 /**
- * Represents the service that is passed to the
- * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
+ * Represents the service passed to the [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive.
+ *
+ * Use this service to interact with the column menu from a custom template.
  *
  * @example
  * ```html
  * <kendo-grid [data]="data" [columnMenu]="true">
- *    <ng-template kendoGridColumnMenuTemplate let-service="service">
- *       <span class="k-icon k-font-icon k-i-x" (click)="service.close()" </span>
- *       <kendo-grid-columnmenu-sort [service]="service">
- *       </kendo-grid-columnmenu-sort>
- *    </ng-template>
- *    <kendo-grid-column field="Field1"></kendo-grid-column>
+ *   <ng-template kendoGridColumnMenuTemplate let-service="service">
+ *     <span class="k-icon k-font-icon k-i-x" (click)="service.close()"></span>
+ *     <kendo-grid-columnmenu-sort [service]="service"></kendo-grid-columnmenu-sort>
+ *   </ng-template>
+ *   <kendo-grid-column field="Field1"></kendo-grid-column>
  * </kendo-grid>
- *
  * ```
  */
 export class ColumnMenuService {

package/esm2022/columns/checkbox-column.component.mjs

@@ -16,11 +16,13 @@ import * as i4 from "../common/id.service";
 /**
  * Represents the checkbox column for selecting rows in the Grid. [See example](slug:grid_row_selection#toc-select-all-checkbox).
  *
+ * Use this column to add checkboxes for row selection.
+ *
  * @example
  * ```html
  * <kendo-grid [selectable]="{enabled: true, checkboxOnly: true}">
- *   <kendo-grid-checkbox-column title="Default checkbox"></kendo-grid-checkbox-column>
- *   <kendo-grid-column field="ProductID"></kendo-grid-column>
+ *   <kendo-grid-checkbox-column title="Select"></kendo-grid-checkbox-column>
+ *   <kendo-grid-column field="ID"></kendo-grid-column>
  * </kendo-grid>
  * ```
  */
@@ -29,11 +31,11 @@ export class CheckboxColumnComponent extends ColumnBase {
     cellSelectionService;
     parent;
     /**
-     * Determines whether a select-all `kendoGridSelectAllCheckbox` checkbox will be displayed in the header.
+     * Shows a select-all `kendoGridSelectAllCheckbox` checkbox in the header.
      */
     showSelectAll;
     /**
-     * Determines whether checkboxes will be rendered for rows which are marked as non-selectable. By default, such checkboxes are visible and disabled.
+     * Shows checkboxes for rows marked as non-selectable. By default, these checkboxes are visible and disabled.
      */
     showDisabledCheckbox = true;
     /*
@@ -57,7 +59,7 @@ export class CheckboxColumnComponent extends ColumnBase {
         return !this.selectionService.nonSelectableRows.has(rowIdx) && !this.cellSelectionService.nonSelectableRows.has(rowIdx);
     }
     /**
-     * Defines a function that is used to determine the rowspan of each column cell.
+     * Defines a function to determine the rowspan of each column cell.
      */
     set cellRowspan(cellRowspan) {
         super.cellRowspan = cellRowspan;