@progress/kendo-angular-grid 12.0.0 → 12.0.1-develop.2

package/esm2020/filtering/string-filter.component.mjs

@@ -32,8 +32,9 @@ export class StringFilterComponent extends BaseFilterCellComponent {
         super(filterService);
         this.localization = localization;
         /**
-         * The default filter operator. Defaults to `contains`.
+         * The default filter operator.
          * @type {string}
+         * @default 'contains'
          */
         this.operator = "contains";
     }

package/esm2020/grid.component.mjs

@@ -137,33 +137,11 @@ const handleExpandCollapseDetailsService = (service, expandEmitter, collapseEmit
 const isInEditedCell = (element, gridElement) => closest(element, matchesClasses('k-grid-edit-cell')) &&
     closest(element, matchesNodeName('kendo-grid')) === gridElement;
 /**
- * Represents the Kendo UI Grid component for Angular.
+ * Represents the Kendo UI for Angular Data Grid component.
  *
  * @example
- * ```ts-preview
- * _@Component({
- *    selector: 'my-app',
- *    template: `
- *        <kendo-grid [data]="gridData">
- *        </kendo-grid>
- *    `
- * })
- * class AppComponent {
- *    public gridData: any[] = products;
- * }
- *
- * const products = [{
- *    "ProductID": 1,
- *    "ProductName": "Chai",
- *    "UnitPrice": 18.0000,
- *    "Discontinued": true
- *  }, {
- *    "ProductID": 2,
- *    "ProductName": "Chang",
- *    "UnitPrice": 19.0000,
- *    "Discontinued": false
- *  }
- * ];
+ * ```html
+ * <kendo-grid [data]="gridData"></kendo-grid>
  * ```
  */
 export class GridComponent {
@@ -199,64 +177,25 @@ export class GridComponent {
         /**
          * Defines the scroll mode used by the Grid.
          *
-         * The available options are:
-         *  - `none`&mdash;Renders no scrollbar.
-         *  - `scrollable`&mdash;The default scroll mode. It requires the setting of the `height` option.
-         *  - `virtual`&mdash;Displays no pager and renders a portion of the data (optimized rendering) while the user is scrolling the content.
+         * @default 'scrollable'
          */
         this.scrollable = 'scrollable';
         /**
-         * Enables the single-row [selection]({% slug selection_grid %}) of the Grid.
+         * Enables the [single-row selection](slug:grid_row_selection) of the Grid.
+         *
+         * @default false
          */
         this.selectable = false;
         /**
          * A function that defines how to track changes for the data rows.
-         *
          * By default, the Grid tracks changes by the index of the data item.
          * Edited rows are tracked by reference.
-         * In some cases, you might need to override the default behavior,
-         * for example, when you implement editing with immutable data items.
-         *
-         * The following example demonstrates how to track items only by index.
-         *
-         * @example
-         * ```ts
-         * import { Component } from '@angular/core';
-         * import { GridItem } from '@progress/kendo-angular-grid';
-         *
-         * _@Component({
-         *    selector: 'my-app',
-         *    template: `
-         *        <kendo-grid [data]="gridData" [trackBy]="trackBy">
-         *        </kendo-grid>
-         *    `
-         * })
-         * class AppComponent {
-         *    public gridData: any[] = products;
-         *
-         *    public trackBy(index: number, item: GridItem): any {
-         *        console.log(item);
-         *        return index;
-         *    }
-         * }
-         *
-         * const products = [{
-         *    "ProductID": 1,
-         *    "ProductName": "Chai",
-         *    "UnitPrice": 18.0000,
-         *    "Discontinued": true
-         *  }, {
-         *    "ProductID": 2,
-         *    "ProductName": "Chang",
-         *    "UnitPrice": 19.0000,
-         *    "Discontinued": false
-         *  }
-         * ];
-         * ```
+         * [See exmpale](slug:track_changes_grid)
          */
         this.trackBy = defaultTrackBy;
         /**
          * If set to `true`, the grid will render only the columns in the current viewport.
+         * @default false
          */
         this.virtualColumns = false;
         /**
@@ -265,35 +204,31 @@ export class GridComponent {
         this.gridData = () => { return this.flatData; };
         /**
          * Enables the [filtering]({% slug filtering_grid %}) of the Grid columns that have their `field` option set.
+         * @default false
          */
         this.filterable = false;
         /**
          * Enables the [sorting]({% slug sorting_grid %}) of the Grid columns that have their `field` option set.
+         * @default false
          */
         this.sortable = false;
         /**
-         * Configures the pager of the Grid ([see example]({% slug paging_grid %})).
-         *
-         * The available options are:
-         * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed. Defaults to `10`.
-         * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records. Defaults to `true`.
-         * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers) and `input` (input for typing the page number) values. Defaults to `'numeric'`.
-         * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size. Defaults to `false`.
-         * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons. Defaults to `true`.
-         * - `responsive: Boolean`&mdash;Toggles the built-in responsive behavior of the Pager. Defaults to `true`.
+         * Configures the pager of the Grid ([see example](slug:paging_grid_settings)).
+         * @default false
          */
         this.pageable = false;
         /**
-         * If set to `true`, the user can group the Grid by dragging the column header cells.
-         * By default, grouping is disabled ([see example]({% slug grouping_grid %})).
+         * If set to `true`, the user can group the Grid by dragging the column header cells ([see example]({% slug grouping_grid %})).
+         * @default false
          */
         this.groupable = false;
         /**
          * Indicates whether the Grid columns will be resized during initialization so that
-         * they fit their headers and row content. Defaults to `false`.
+         * they fit their headers and row content.
          * Columns with `autoSize` set to `false` are excluded.
          * To dynamically update the column width to match the new content,
          * refer to [this example]({% slug resizing_columns_grid %}).
+         * @default false
          */
         this.autoSize = false;
         /**
@@ -318,8 +253,8 @@ export class GridComponent {
         this.columnMenu = false;
         /**
          * Specifies if the header of the grid will be hidden. The header is visible by default.
-         *
-         * > The header includes column headers and the [filter row]({% slug filtering_grid %}#toc-filter-row).
+         * The header includes column headers and the [filter row](slug:filter_row).
+         * @default false
          */
         this.hideHeader = false;
         /**
@@ -680,50 +615,8 @@ export class GridComponent {
         return this.navigable;
     }
     /**
-     * Defines a function that is executed for every data row in the component.
-     *
-     * @example
-     * ```ts
-     * import { Component, ViewEncapsulation } from '@angular/core';
-     * import { RowClassArgs } from '@progress/kendo-angular-grid';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    encapsulation: ViewEncapsulation.None,
-     *    styles: [`
-     *        .k-grid tr.even { background-color: #f45c42; }
-     *        .k-grid tr.odd { background-color: #41f4df; }
-     *    `],
-     *    template: `
-     *        <kendo-grid [data]="gridData" [rowClass]="rowCallback">
-     *        </kendo-grid>
-     *    `
-     * })
-     * class AppComponent {
-     *    public gridData: any[] = products;
-     *
-     *    public rowCallback(context: RowClassArgs) {
-     *        const isEven = context.index % 2 === 0;
-     *        return {
-     *            even: isEven,
-     *            odd: !isEven
-     *        };
-     *    }
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
+     * Defines a function that is executed for every data row in the component
+     * ([see example](slug:styling_grid_rows)).
      */
     set rowClass(fn) {
         if (isDevMode() && typeof fn !== 'function') {
@@ -1024,9 +917,9 @@ export class GridComponent {
      * This method is provided only for backwards-compatibility with legacy versions.
      * These versions tracked the expanded group state internally using the hierarchical group index.
      *
-     * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
-     * > the `expandGroup` method is not supported.
-     * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
+     * The `expandGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
+     *
+     * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
      *
      * @param {string} index - The underscore separated hierarchical index of the group.
      */
@@ -1040,9 +933,9 @@ export class GridComponent {
      * This method is provided only for backwards-compatibility with legacy versions.
      * These versions tracked the expanded group state internally using the hierarchical group index.
      *
-     * > * When you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive,
-     * > the `collapseGroup` method is not supported.
-     * > * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
+     * The `collapseGroup` method is not supported when you use the [kendoGridGroupBinding]({% slug api_grid_groupbindingdirective %}) directive.
+     *
+     * When a Grid is pageable, the indexes of the groups are offset by the current Grid [skip]({% slug api_grid_gridcomponent %}#toc-skip).
      *
      * @param {string} index - The underscore separated hierarchical index of the group.
      */
@@ -1300,7 +1193,7 @@ export class GridComponent {
         this.focusEditElement('.k-grid-add-row');
     }
     /**
-     * Puts the cell that is specified by the table row and column in edit mode.
+     * Puts the cell that is specified by the table row and column in edit mode ([see example](slug:editing_incell_grid)).
      *
      * @param {number} rowIndex - The data row index that will be switched in the edit mode.
      * @param {number|string|any} column - The leaf column index, or the field name or the column instance that should be edited.
@@ -1355,7 +1248,7 @@ export class GridComponent {
      * Exports the Grid element to a Drawing [Group]({% slug api_kendo-drawing_group %}) by using the `kendo-grid-pdf` component options.
      * ([see example]({% slug pdfexport_grid %}#toc-exporting-multiple-grids-to-the-same-pdf)).
      *
-     * @return {Promise} - A promise that will be resolved with the Drawing `Group`.
+     * @return {Promise} A promise that will be resolved with the Drawing `Group`.
      */
     drawPDF() {
         const promise = createPromise();
@@ -1371,138 +1264,19 @@ export class GridComponent {
     /**
      * Applies the minimum possible width for the specified column,
      * so that the whole text fits without wrapping. This method expects the Grid
-     * to be resizable (set `resizable` to `true`).
-     * Makes sense to execute this method only
+     * to be [resizable](slug:resizing_columns_grid). The method must be executed
      * after the Grid is already populated with data.
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-grid
-     *            #grid
-     *            [data]="gridData"
-     *            [resizable]="true"
-     *            style="height: 300px">
-     *            <ng-template kendoGridToolbarTemplate>
-     *                 <button kendoButton (click)="grid.autoFitColumn(groupColumn)">
-     *                     Auto-fit the group column
-     *                 </button>
-     *            </ng-template>
-     *            <kendo-grid-column-group #groupColumn title="Product Info">
-     *                <kendo-grid-column
-     *                    field="ProductID"
-     *                    [width]="50"
-     *                    [minResizableWidth]="30"
-     *                    title="ID">
-     *                </kendo-grid-column>
-     *
-     *                <kendo-grid-column
-     *                    field="ProductName"
-     *                    title="Product Name">
-     *                </kendo-grid-column>
-     *            </kendo-grid-column-group>
-     *
-     *            <kendo-grid-column
-     *                field="UnitPrice"
-     *                title="Unit Price"
-     *                [width]="180"
-     *                filter="numeric"
-     *                format="{0:c}">
-     *            </kendo-grid-column>
-     *        </kendo-grid>
-     *    `
-     * })
-     * class AppComponent {
-     *    public gridData: any[] = products;
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
+     * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
      */
     autoFitColumn(column) {
         this.columnResizingService.autoFit(column);
     }
     /**
      * Adjusts the width of the specified columns to fit the entire content, including headers, without wrapping.
-     * If no columns are specified, `autoFitColumns` is applied to all columns.
-     *
-     * This method requires the Grid to be resizable (set `resizable` to `true`).
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *      <kendo-grid
-     *          #grid
-     *          [data]="gridData"
-     *          [resizable]="true"
-     *          style="height: 300px">
-     *          <ng-template kendoGridToolbarTemplate>
-     *              <button kendoButton (click)="grid.autoFitColumns([firstColumn, lastColumn])">
-     *                  Auto-fit the first and last column
-     *              </button>
-     *              <button kendoButton (click)="grid.autoFitColumns()">
-     *                  Auto-fit all columns
-     *              </button>
-     *          </ng-template>
-     *          <kendo-grid-column-group title="Product Info">
-     *              <kendo-grid-column
-     *                  #firstColumn
-     *                  field="ProductID"
-     *                  [width]="50"
-     *                  [minResizableWidth]="30"
-     *                  title="ID">
-     *              </kendo-grid-column>
-     *
-     *              <kendo-grid-column
-     *                  field="ProductName"
-     *                  title="Product Name"
-     *                  >
-     *              </kendo-grid-column>
-     *          </kendo-grid-column-group>
-     *
-     *          <kendo-grid-column
-     *              #lastColumn
-     *              field="UnitPrice"
-     *              title="Unit Price"
-     *              [width]="180"
-     *              filter="numeric"
-     *              format="{0:c}">
-     *          </kendo-grid-column>
-     *      </kendo-grid>
-     *    `
-     * })
-     * class AppComponent {
-     *    public gridData: any[] = products;
-     * }
+     * If no columns are specified, `autoFitColumns` is applied to all columns.The method must be executed
+     * after the Grid is already populated with data.
+     * [See example](slug:resizing_columns_grid#toc-auto-fitting-the-content)
      *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
      */
     autoFitColumns(columns = this.columns) {
         let cols;
@@ -1563,10 +1337,10 @@ export class GridComponent {
     /**
      * Focuses the cell with the specified row and column index.
      *
-     * The row index is based on the logical structure of the Grid and does not correspond to the data item index:
-     * * Header rows are included, starting at index 0.
-     * * Group headers and footers are included.
-     * * The row indexing is absolute and does not change with paging.
+     * The row index is based on the logical structure of the Grid and does not correspond to the data item index.
+     * Header rows are included, starting at index 0.
+     * Group headers and footers are included.
+     * The row indexing is absolute and does not change with paging.
      *
      * If the Grid is configured for scrolling, including virtual scrolling, the scroll position will be updated.
      * If the row is not present on the current page, the method will have no effect.
@@ -1617,67 +1391,6 @@ export class GridComponent {
      * @param {number} destIndex - The new position of the column.
      * @param {ColumnReorderConfig} options - Additional options.
      *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-grid
-     *            #grid
-     *            [data]="gridData"
-     *            [reorderable]="true"
-     *            style="height: 300px">
-     *            <ng-template kendoGridToolbarTemplate>
-     *                 <button kendoButton
-     *                     (click)="grid.reorderColumn(groupColumn, 2, { before: true })">
-     *                     Move the group column before the last one.
-     *                 </button>
-     *            </ng-template>
-     *            <kendo-grid-column-group #groupColumn title="Product Info">
-     *                <kendo-grid-column
-     *                    field="ProductID"
-     *                    [width]="50"
-     *                    title="ID">
-     *                </kendo-grid-column>
-     *
-     *                <kendo-grid-column
-     *                    field="ProductName"
-     *                    title="Product Name">
-     *                </kendo-grid-column>
-     *            </kendo-grid-column-group>
-     *
-     *            <kendo-grid-column
-     *                field="UnitPrice"
-     *                title="Unit Price"
-     *                [width]="180"
-     *                format="{0:c}">
-     *            </kendo-grid-column>
-     *
-     *            <kendo-grid-column
-     *                field="Discontinued"
-     *                title="Discontinued"
-     *                [width]="100">
-     *            </kendo-grid-column>
-     *        </kendo-grid>
-     *    `
-     * })
-     * class AppComponent {
-     *    public gridData: any[] = products;
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
      */
     reorderColumn(source, destIndex, options = { before: false }) {
         const columnsForLevel = sortColumns(this.allColumnsForLevel(source.level));

package/esm2020/localization/custom-messages.component.mjs

@@ -9,7 +9,7 @@ import * as i0 from "@angular/core";
 import * as i1 from "@progress/kendo-angular-l10n";
 /**
  * Custom component messages override default component messages
- * ([see example]({% slug globalization_grid %}#toc-localization)).
+ * ([see example](slug:globalization_grid#toc-custom-messages)).
  */
 export class CustomMessagesComponent extends GridMessages {
     constructor(service) {

package/esm2020/package-metadata.mjs

@@ -9,7 +9,7 @@ export const packageMetadata = {
     name: '@progress/kendo-angular-grid',
     productName: 'Kendo UI for Angular',
     productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
-    publishDate: 1682434440,
-    version: '12.0.0',
+    publishDate: 1683098077,
+    version: '12.0.1-develop.2',
     licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
 };

package/esm2020/pager/pager-info.component.mjs

@@ -11,7 +11,7 @@ import * as i0 from "@angular/core";
 import * as i1 from "@progress/kendo-angular-l10n";
 import * as i2 from "./pager-context.service";
 /**
- * Displays information about the current page and the total number of records ([see example]({% slug paging_grid %}#toc-pager-templates)).
+ * Displays information about the current page and the total number of records ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
  */
 export class PagerInfoComponent extends PagerElementComponent {
     constructor(localization, cd, pagerContext) {

package/esm2020/pager/pager-input.component.mjs

@@ -18,54 +18,7 @@ import * as i5 from "./pager-input.directive";
 import * as i6 from "../navigation/focusable.directive";
 import * as i7 from "@progress/kendo-angular-common";
 /**
- * Displays an input element which allows the typing and rendering of page numbers.
- *
- * @example
- * ```ts-preview
- *
- * _@Component({
- *     selector: 'my-app',
- *     template: `
- *      <kendo-grid
- *        [kendoGridBinding]="gridData"
- *        [pageSize]="1"
- *        [pageable]="true"
- *      >
- *       <kendo-grid-column field="ProductID" title="ID" [width]="40">
- *       </kendo-grid-column>
- *       <kendo-grid-column field="ProductName" title="Name" [width]="250">
- *       </kendo-grid-column>
- *       <kendo-grid-column field="UnitPrice" title="Price" [width]="80" format="{0:c}">
- *       </kendo-grid-column>
- *
- *       <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
- *          <kendo-pager-prev-buttons></kendo-pager-prev-buttons>
- *          <kendo-pager-numeric-buttons [buttonCount]="10"></kendo-pager-numeric-buttons>
- *          <kendo-pager-next-buttons></kendo-pager-next-buttons>
- *          <kendo-pager-input></kendo-pager-input>
- *          <kendo-pager-info></kendo-pager-info>
- *       </ng-template>
- *
- *    </kendo-grid>
- *     `
- * })
- *
- * class AppComponent {
- *     public gridData = [{
- *         "ProductID": 1,
- *         "ProductName": "Chai",
- *         "UnitPrice": 18.0000,
- *         "Discontinued": false
- *       }, {
- *         "ProductID": 2,
- *         "ProductName": "Chang",
- *         "UnitPrice": 19.0000,
- *         "Discontinued": true
- *       }
- *     ];
- * }
- *
- * ```
+ * Displays an input element which allows the typing and rendering of page numbers ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
  */
 export class PagerInputComponent extends PagerElementComponent {
     constructor(localization, pagerContext, zone, navigationService, cd) {

package/esm2020/pager/pager-next-buttons.component.mjs

@@ -15,7 +15,7 @@ import * as i3 from "./../navigation/navigation.service";
 import * as i4 from "@progress/kendo-angular-buttons";
 import * as i5 from "../navigation/focusable.directive";
 /**
- * Displays buttons for navigating to the next and to the last page ([see example]({% slug paging_grid %}#toc-pager-template)).
+ * Displays buttons for navigating to the next and to the last page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
  */
 export class PagerNextButtonsComponent extends PagerElementComponent {
     constructor(localization, pagerContext, cd, navigationService) {

package/esm2020/pager/pager-numeric-buttons.component.mjs

@@ -13,7 +13,7 @@ import * as i3 from "@progress/kendo-angular-buttons";
 import * as i4 from "../navigation/focusable.directive";
 import * as i5 from "@angular/common";
 /**
- * Displays numeric buttons to enable navigation between the pages.
+ * Displays numeric buttons to enable navigation between the pages ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
  */
 export class PagerNumericButtonsComponent extends PagerElementComponent {
     constructor(localization, cd, pagerContext) {