@progress/kendo-angular-grid 12.0.0-develop.10 → 12.0.0-develop.12

package/fesm2020/progress-kendo-angular-grid.mjs

@@ -1035,7 +1035,7 @@ class PreventableEvent {
         this.prevented = true;
     }
     /**
-     * Returns `true` if the event was prevented
+     * Returns a respective boolean if the event was prevented
      * by any of its subscribers.
      *
      * @returns `true` if the default action was prevented.
@@ -2826,8 +2826,8 @@ const packageMetadata = {
     name: '@progress/kendo-angular-grid',
     productName: 'Kendo UI for Angular',
     productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
-    publishDate: 1681902962,
-    version: '12.0.0-develop.10',
+    publishDate: 1682004294,
+    version: '12.0.0-develop.12',
     licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
 };
 
@@ -3190,9 +3190,9 @@ class ColumnBase {
          */
         this.matchesMedia = true;
         /**
-         * The column index after reordering.
+         * The column index after reordering. The `orderIndex` is a read-only property. Setting this field does not affect column order.
          *
-         * > `orderIndex` is a read-only property. Setting this field does not affect column order.
+         * @default 0
          */
         this.orderIndex = 0;
         /**
@@ -3227,18 +3227,22 @@ class ColumnBase {
         this.sticky = false;
         /**
          * Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.
+         * @default true
          */
         this.lockable = true;
         /**
          * Specifies if the column can be stuck or unstuck from the column menu.
+         * @default true
          */
         this.stickable = true;
         /**
          * Specifies if the column menu will be shown for the column.
+         * @default true
          */
         this.columnMenu = true;
         /**
          * Specifies if the column will be included in the column-chooser list.
+         * @default true
          */
         this.includeInChooser = true;
         /**
@@ -3286,44 +3290,6 @@ class ColumnBase {
      *
      * @default false
      *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-grid [data]="gridData" [scrollable]="scrollable" style="height: 200px">
-     *          <kendo-grid-column field="ProductID" title="Product ID" [width]="120" [locked]="true">
-     *          </kendo-grid-column>
-     *          <kendo-grid-column field="ProductName" title="Product Name" [width]="200">
-     *          </kendo-grid-column>
-     *          <kendo-grid-column field="UnitPrice" title="Unit Price" [width]="230">
-     *          </kendo-grid-column>
-     *        </kendo-grid>
-     *    `
-     * })
-     *
-     * class AppComponent {
-     *    public gridData: any[];
-     *
-     *    constructor() {
-     *        this.gridData = products;
-     *    }
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     *
-     * ```
      */
     set locked(value) {
         this._locked = value;
@@ -5730,7 +5696,7 @@ class PopupCloseEvent extends PreventableEvent {
 const DEFAULT_POPUP_CLASS = 'k-grid-filter-popup';
 /**
  * The service that is used for the popups of the filter and column menus
- * ([see example]({% slug filter_menu %}#toc-custom-filter-row-components)#toc-filter-menu-with-popup).
+ * ([see example]({% slug filter_menu %}#toc-filter-menu-with-popup)).
  */
 class SinglePopupService {
     constructor(popupService, renderer, ngZone, scrollSyncService, localization) {
@@ -6323,6 +6289,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
                 }]
         }], ctorParameters: function () { return [{ type: i0.TemplateRef }]; } });
 
+/**
+ * @hidden
+*/
 class SizingOptionsService {
     constructor() {
         this.changes = new Subject();
@@ -11295,27 +11264,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
  * [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
  *
  * @example
- * ```ts-preview
- *
- * _@Component({
- *     selector: 'my-app',
- *     template: `
- *       <kendo-grid [data]="data" [columnMenu]="true">
- *          <ng-template kendoGridColumnMenuTemplate let-service="service">
- *              <span class="k-icon k-i-x" (click)="service.close()"
- *                  style="position: absolute; right: 5px; top: 5px;cursor: pointer;"></span>
- *              <kendo-grid-columnmenu-sort [service]="service">
- *              </kendo-grid-columnmenu-sort>
- *          </ng-template>
- *          <kendo-grid-column field="Field1"></kendo-grid-column>
- *          <kendo-grid-column field="Field2"></kendo-grid-column>
- *       </kendo-grid>
- *     `
- * })
- *
- * class AppComponent {
- *   public data: any[] = [{ Field1: 'Foo', Field2: 'Bar' }];
- * }
+ * ```html
+ * <kendo-grid [data]="data" [columnMenu]="true">
+ *    <ng-template kendoGridColumnMenuTemplate let-service="service">
+ *       <span class="k-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>
  *
  * ```
  */
@@ -19435,7 +19392,7 @@ class GridComponent {
         return this.selectionService.enableMarquee || this.cellSelectionService.enableMarquee;
     }
     /**
-     * Enables the [row reordering]({% slug ToDo %}) of the Grid.
+     * Enables the [row reordering]({% slug reordering_rows_grid %}) of the Grid.
      * @default false
      */
     set rowReorderable(value) {
@@ -25845,29 +25802,19 @@ const declarations$2 = [
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Grid module
- * import { GridModule } from '@progress/kendo-angular-grid';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { GridModule } from '@progress/kendo-angular-grid';
+ * import { BrowserModule } from "@angular/platform-browser";
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, GridModule], // import Grid module
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, GridModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
  *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 class GridModule {
@@ -26485,28 +26432,19 @@ const declarations$1 = [
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Grid and PDF modules
- * import { GridModule, PDFModule } from '@progress/kendo-angular-grid';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { GridModule, PDFModule } from '@progress/kendo-angular-grid';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, GridModule, PDFModule], // import Grid and PDF modules
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, GridModule, PDFModule],
  *     bootstrap:    [AppComponent]
  * })
- * export class AppModule {}
  *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
+ * export class AppModule {}
  *
  * ```
  */
@@ -26766,29 +26704,19 @@ const declarations = [ExcelComponent, ExcelCommandDirective];
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Grid and Excel modules
- * import { GridModule, ExcelModule } from '@progress/kendo-angular-grid';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { GridModule, ExcelModule } from '@progress/kendo-angular-grid';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
  * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, GridModule, ExcelModule], // import Grid and Excel modules
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, GridModule, ExcelModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
  *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 class ExcelModule {

package/filtering/filterable.d.ts

@@ -4,6 +4,16 @@
 *-------------------------------------------------------------------------------------------*/
 /**
  * Represents the options for the `filterable` setting of the Grid.
+ *
+ * The available values are:
+ * * `row`—Displays a filter row in Grid. [See example](slug:filter_row).
+ * * `menu`—Displays a filter menu in Grid. [See example](slug:filter_menu).
+ * * `menu, row`—Displays filter menu with filter row.
+ *
+ * @example
+ * ```html
+ * <kendo-grid filterable="menu, row"></kendo-grid>
+ * ```
  */
 export declare type FilterableSettings = boolean | 'row' | 'menu' | 'menu, row';
 /**

package/grid.component.d.ts

@@ -324,7 +324,7 @@ export declare class GridComponent implements AfterContentInit, AfterViewInit, O
      */
     groupable: GroupableSettings | boolean;
     /**
-     * Enables the [row reordering]({% slug ToDo %}) of the Grid.
+     * Enables the [row reordering]({% slug reordering_rows_grid %}) of the Grid.
      * @default false
      */
     set rowReorderable(value: boolean);

package/grid.module.d.ts

@@ -123,29 +123,19 @@ import * as i114 from "./column-menu/column-menu-autosize-all.component";
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Grid module
- * import { GridModule } from '@progress/kendo-angular-grid';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { GridModule } from '@progress/kendo-angular-grid';
+ * import { BrowserModule } from "@angular/platform-browser";
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, GridModule], // import Grid module
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, GridModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
  *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export declare class GridModule {

package/layout/sizing-options.service.d.ts

@@ -5,6 +5,9 @@
 import { Subject } from 'rxjs';
 import { GridSize } from '../common/size-options';
 import * as i0 from "@angular/core";
+/**
+ * @hidden
+*/
 export declare class SizingOptionsService {
     changes: Subject<GridSize>;
     static ɵfac: i0.ɵɵFactoryDeclaration<SizingOptionsService, never>;

package/navigation/navigable-settings.d.ts

@@ -4,9 +4,23 @@
 *-------------------------------------------------------------------------------------------*/
 /**
  * Represents the possible navigable sections of the Grid ([see example]({% slug keyboard_navigation_grid %}#toc-navigable-sections)).
+ *
+ * The available values are:
+ * * `pager`—Includes the Grid pager and its internal elements
+ * * `table`—Includes the Grid pager and its internal elements
+ * * `toolbar`—Includes the Grid toolbars and the group panel when the Grid is groupable.
+ *
+ * @xample
+ * ```html
+ * <kendo-grid [navigable]="['pager', 'toolbar']"> </kendo-grid>
+ * ```
  */
 export declare type GridNavigableSection = 'pager' | 'table' | 'toolbar';
 /**
- * Represents the type of the Grid [`navigable`]({% slug api_grid_gridcomponent %}#toc-navigable) option.
+ * Represents the type of the Grid [`navigable`]({% slug api_grid_gridcomponent %}#toc-navigable) property.
+ *
+ * The available values are:
+ * * `boolean`
+ * * [`GridNavigableSection`](slug:api_grid_gridnavigablesection)
  */
 export declare type GridNavigableSettings = boolean | GridNavigableSection[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progress/kendo-angular-grid",
-  "version": "12.0.0-develop.10",
+  "version": "12.0.0-develop.12",
   "description": "Kendo UI Grid for Angular - high performance data grid with paging, filtering, virtualization, CRUD, and more.",
   "license": "SEE LICENSE IN LICENSE.md",
   "author": "Progress",
@@ -32,24 +32,24 @@
     "@progress/kendo-data-query": "^1.0.0",
     "@progress/kendo-drawing": "^1.17.2",
     "@progress/kendo-licensing": "^1.0.2",
-    "@progress/kendo-angular-buttons": "12.0.0-develop.10",
-    "@progress/kendo-angular-common": "12.0.0-develop.10",
-    "@progress/kendo-angular-dateinputs": "12.0.0-develop.10",
-    "@progress/kendo-angular-dropdowns": "12.0.0-develop.10",
-    "@progress/kendo-angular-excel-export": "12.0.0-develop.10",
-    "@progress/kendo-angular-icons": "12.0.0-develop.10",
-    "@progress/kendo-angular-inputs": "12.0.0-develop.10",
-    "@progress/kendo-angular-intl": "12.0.0-develop.10",
-    "@progress/kendo-angular-l10n": "12.0.0-develop.10",
-    "@progress/kendo-angular-label": "12.0.0-develop.10",
-    "@progress/kendo-angular-pdf-export": "12.0.0-develop.10",
-    "@progress/kendo-angular-popup": "12.0.0-develop.10",
-    "@progress/kendo-angular-utils": "12.0.0-develop.10",
+    "@progress/kendo-angular-buttons": "12.0.0-develop.12",
+    "@progress/kendo-angular-common": "12.0.0-develop.12",
+    "@progress/kendo-angular-dateinputs": "12.0.0-develop.12",
+    "@progress/kendo-angular-dropdowns": "12.0.0-develop.12",
+    "@progress/kendo-angular-excel-export": "12.0.0-develop.12",
+    "@progress/kendo-angular-icons": "12.0.0-develop.12",
+    "@progress/kendo-angular-inputs": "12.0.0-develop.12",
+    "@progress/kendo-angular-intl": "12.0.0-develop.12",
+    "@progress/kendo-angular-l10n": "12.0.0-develop.12",
+    "@progress/kendo-angular-label": "12.0.0-develop.12",
+    "@progress/kendo-angular-pdf-export": "12.0.0-develop.12",
+    "@progress/kendo-angular-popup": "12.0.0-develop.12",
+    "@progress/kendo-angular-utils": "12.0.0-develop.12",
     "rxjs": "^6.5.3 || ^7.0.0"
   },
   "dependencies": {
     "tslib": "^2.3.1",
-    "@progress/kendo-angular-schematics": "12.0.0-develop.10",
+    "@progress/kendo-angular-schematics": "12.0.0-develop.12",
     "@progress/kendo-common": "^0.2.0",
     "@progress/kendo-file-saver": "^1.0.0"
   },

package/pager/pager-settings.d.ts

@@ -10,12 +10,10 @@
  * * `input`—Input for typing the page number.
  *
  * @example
- * ```html-no-run
- *
- * <kendo-grid
- *    [pageable]="{
- *        type: 'numeric'
- *    }">
+ * ```html
+ * <kendo-grid [pageable]="{ type: 'numeric' }">
+ *   <kendo-grid-column field="ProductID"></kendo-grid-column>
+ *   ...
  * </kendo-grid>
  * ```
  */
@@ -29,12 +27,10 @@ export declare type PagerType = 'numeric' | 'input';
  * * `both`&mdash;Two pagers are rendered - one above the Grid headers, and one - below the data table.
  *
  * @example
- * ```html-no-run
- *
- * <kendo-grid
- *    [pageable]="{
- *        position: 'both'
- *    }">
+ * ```html
+ * <kendo-grid [pageable]="{ position: 'both' }">
+ *   <kendo-grid-column field="ProductID"></kendo-grid-column>
+ *   ...
  * </kendo-grid>
  * ```
  */

package/pdf/pdf.module.d.ts

@@ -14,28 +14,19 @@ import * as i5 from "@progress/kendo-angular-icons";
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Grid and PDF modules
- * import { GridModule, PDFModule } from '@progress/kendo-angular-grid';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { GridModule, PDFModule } from '@progress/kendo-angular-grid';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, GridModule, PDFModule], // import Grid and PDF modules
+ * @NgModule({
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, GridModule, PDFModule],
  *     bootstrap:    [AppComponent]
  * })
- * export class AppModule {}
  *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
+ * export class AppModule {}
  *
  * ```
  */

package/rendering/common/row-class.d.ts

@@ -11,9 +11,9 @@ export interface RowClassArgs extends RowArgs {
 }
 /**
  * Represents the callback that is used by the
- * [rowClass]({% slug api_grid_gridcomponent %}#toc-rowClass) property.
+ * [rowClass]({% slug api_grid_gridcomponent %}#toc-rowclass) property.
  *
- * ```ts-no-run
+ * ```ts
  *  rowCallback({ dataItem, index }) {
  *    const isEven = index % 2 === 0;
  *    return {
@@ -31,7 +31,7 @@ export declare type RowClassFn = (context: RowClassArgs) => string | string[] |
  * Represents the callback that is used by the
  * [rowSelected]({% slug api_grid_gridcomponent %}#toc-rowselected) property.
  *
- * ```ts-no-run
+ * ```ts
  * rowCallback({ dataItem, index }) {
  *   return index % 2 === 0;
  * }
@@ -41,7 +41,7 @@ export declare type RowSelectedFn = (context: RowArgs) => boolean;
 /**
  * Represents the callback that is used to determine whether a given data row will be sticky.
  *
- * ```ts-no-run
+ * ```ts
  * rowStickyCallback({ dataItem, index }) {
  *   return index % 2 === 0;
  * }

package/rendering/toolbar/toolbar-position.d.ts

@@ -2,4 +2,21 @@
 * Copyright © 2023 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
-export declare type ToolbarPosition = 'top' | 'bottom';
+/**
+ * Defines the settings for `position` property of the  the Grid Toolbar Template. [See example](slug:toolbartemplate_grid#toc-setting-the-toolbar-position)
+ *
+ * The possible values are:
+ * * `top`—Displays the Toolbar a the top of the Grid.
+ * * `bottom`—Displays the Toolbar at the bottom of the Grid.
+ * * `both`—Displays the Toolbar at the top and bottom of the Grid.
+ *
+ * @example
+ * ```html
+ * <kendo-grid >
+ *   <ng-template kendoGridToolbarTemplate position="bottom" let-position="position">
+ *     <button (click)="onClick()">Custom action</button>
+ *   </ng-template>
+ * </kendo-grid>
+ * ```
+ */
+export declare type ToolbarPosition = 'top' | 'bottom' | 'both';

package/schematics/ngAdd/index.js

@@ -4,9 +4,9 @@ const schematics_1 = require("@angular-devkit/schematics");
 function default_1(options) {
     const finalOptions = Object.assign(Object.assign({}, options), { mainNgModule: 'GridModule', package: 'grid', peerDependencies: {
             // peer dep of the dropdowns
-            '@progress/kendo-angular-treeview': '12.0.0-develop.10',
+            '@progress/kendo-angular-treeview': '12.0.0-develop.12',
             // peer dependency of kendo-angular-inputs
-            '@progress/kendo-angular-dialog': '12.0.0-develop.10',
+            '@progress/kendo-angular-dialog': '12.0.0-develop.12',
             // peer dependency of kendo-angular-icons
             '@progress/kendo-svg-icons': '^1.0.0'
         } });

package/scrolling/scrollmode.d.ts

@@ -6,12 +6,12 @@
  * The scroll mode of the Grid.
  *
  * The available values are:
- * - `none`
- * - `scrollable`
- * - `virtual`
+ * * `none`—Scrollbars are hidden. The Grid cannot be scrolled.
+ * * `scrollable`—Displays scrollbars in Grid.
+ * * `virtual`—Enables the [virtual scroll mode](slug:virtualscrolling_grid) of the Grid.
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-grid scrollable="scrollable"></kendo-grid>
  * ```
  */

package/selection/types.d.ts

@@ -6,7 +6,7 @@ import { ColumnComponent } from './../columns/column.component';
 import { RowArgs } from './../rendering/common/row-args';
 /**
  * Represents the callback that is used by the
- * [cellSelected]({% slug api_grid_gridcomponent %}#toc-cellselected) property.
+ * [cellSelected]({% slug api_grid_gridcomponent %}#toc-cellselected) property ([see example](slug:grid_selection_custom#toc-setting-the-selected-cells)).
  */
 export declare type CellSelectedFn = (row: RowArgs, column: ColumnComponent, colIndex: number) => {
     selected: boolean;
@@ -120,11 +120,33 @@ export interface SelectableSettings {
     drag?: boolean;
 }
 /**
- * Represents the available selection modes.
+ * Represents the available selection modes. [See example](slug:grid_row_selection).
+ *
+ * The available values are:
+ * * `single`—Enables single selection. If you click the selected row, it will not be deselected. [See example](slug:grid_row_selection#toc-single-row-selection).
+ * * `multiple`—Enables multiple selection. [See example](slug:grid_row_selection#toc-multiple-rows-selection).
+ *
+ * @example
+ * ```html
+ * <kendo-grid [selectable]="{mode: 'multiple'}"></kendo-grid>
+ * ```
  */
 export declare type SelectableMode = "single" | "multiple";
 /**
  * Represents the possible states of the select-all checkbox.
+ *
+ * @example
+ * ```html
+ *  <kendo-grid-column>
+ *   <ng-template kendoGridHeaderTemplate>
+ *     <input
+ *       kendoGridSelectAllCheckbox
+ *       state="indeterminate"
+*        ...
+ *     />
+ *    </ng-template>
+ *  <kendo-grid-column>
+ * ```
  */
 export declare type SelectAllCheckboxState = "checked" | "unchecked" | "indeterminate";
 /**