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

package/pdf/pdf-margin.component.d.ts

@@ -4,6 +4,15 @@
 *-------------------------------------------------------------------------------------------*/
 import { PDFExportMarginComponent } from '@progress/kendo-angular-pdf-export';
 import * as i0 from "@angular/core";
+/**
+ * Represents the Kendo UI PDFMargin component for Angular.
+ * The supported units are:
+ * `"mm"`
+ * `"cm"`
+ * `"in"`
+ * `"pt"` (default).
+ * Numbers are considered to be points (`"pt"`).
+ */
 export declare class PDFMarginComponent extends PDFExportMarginComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<PDFMarginComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<PDFMarginComponent, "kendo-grid-pdf-margin", never, {}, {}, never, never>;

package/pdf/pdf-margin.interface.d.ts

@@ -6,11 +6,6 @@ import { pdf } from '@progress/kendo-drawing';
 /**
  * Specifies the margins of the page (numbers or strings with units).
  *
- * The supported units are:
- * * `"mm"`
- * * `"cm"`
- * * `"in"`
- * * `"pt"` (default)
  */
 export interface PDFMargin extends pdf.PageMargin {
 }

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/common/spacer.component.d.ts

@@ -7,7 +7,8 @@ import * as i0 from "@angular/core";
  * Represents the Kendo UI GridSpacer component for Angular.
  * Used to give additional white space between the Pager inner elements,
  * and provides a way for customizing the spacer width.
- * It can also be used in any flex container within the Grid.
+ * It can also be used in any flex container within the Grid
+ * ([see example](slug:toolbartemplate_grid#toc-defining-the-spacing-between-toolbar-elements)).
  */
 export declare class GridSpacerComponent {
     hostClass: boolean;

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/row-reordering/row-reorder.service.d.ts

@@ -25,6 +25,7 @@ export declare class RowReorderService {
     private lastDropPosition;
     private dragTarget;
     private dropTarget;
+    private offsetY;
     rowReorder: EventEmitter<RowReorderEvent>;
     constructor(renderer: Renderer2);
     press(ev: DragTargetPressEvent): void;

package/row-reordering/types.d.ts

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 /**
  * The returned type of the `rowReorder` event
- * ([see example](ToDo).
+ * ([see example](slug:reordering_rows_grid)).
  */
 export interface RowReorderEvent {
     /**

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.9',
+            '@progress/kendo-angular-treeview': '12.0.1-develop.1',
             // peer dependency of kendo-angular-inputs
-            '@progress/kendo-angular-dialog': '12.0.0-develop.9',
+            '@progress/kendo-angular-dialog': '12.0.1-develop.1',
             // peer dependency of kendo-angular-icons
             '@progress/kendo-svg-icons': '^1.0.0'
         } });

package/scrolling/content-scroll-event.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Arguments for the `contentScroll` event.
+ * Arguments for the [`contentScroll`](slig:api_grid_gridcomponent#toc-contentscroll) event.
  */
 export interface ContentScrollEvent {
     /**

package/scrolling/scroll-request.service.d.ts

@@ -5,7 +5,8 @@
 import { Subject } from 'rxjs';
 import * as i0 from "@angular/core";
 /**
- * Arguments for the scrollTo method. Specifies to which row / column should the grid scroll to.
+ * Arguments for the `scrollTo` method. Specifies to which row or column should the Grid scroll to.
+ * [See example](slug:scrollmmodes_grid#toc-scrolling-to-a-specific-row-and-column-index).
  */
 export interface ScrollRequest {
     row?: number;

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,15 +6,14 @@ 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;
     item: CellSelectionItem;
 };
 /**
- * The returned type of the `selection` event
- * ([see example]({% slug selection_grid %}#toc-in-combination-with-the-select-all-feature)).
+ * Arguments for the Grid [`selectionChange`](slug:api_grid_gridcomponent#toc-selectionchange) event.
  */
 export interface SelectionEvent {
     /**
@@ -46,48 +45,17 @@ export interface SelectionEvent {
  * The settings for the selection functionality of the Grid ([more information and example]({% slug selection_grid %}#toc-setup)).
  *
  * @example
- * ```ts-preview
- *
- * _@Component({
- *    selector: 'my-app',
- *    template: `
- *        <kendo-grid [data]="gridData" [selectable]="{ checkboxOnly: true, mode: 'multiple' }">
- *          <kendo-grid-column field="ProductID" title="Product ID">
- *          </kendo-grid-column>
- *          <kendo-grid-column field="ProductName" title="Product Name">
- *          </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
- *  }
- * ];
- *
+ * ```html
+ * <kendo-grid [data]="gridData" [selectable]="{ checkboxOnly: true, mode: 'multiple' }">
+ *   <kendo-grid-column field="ProductID"> </kendo-grid-column>
+ *   <kendo-grid-column field="ProductName"> </kendo-grid-column>
+ * </kendo-grid>
  * ```
  */
 export interface SelectableSettings {
     /**
      * Determines if selection is allowed.
      *
-     * @default true
      */
     enabled?: boolean;
     /**
@@ -95,36 +63,51 @@ export interface SelectableSettings {
      * If enabled, clicking the row itself will not select the row.
      * Applicable if at least one checkbox column is present.
      *
-     * @default true
      */
     checkboxOnly?: boolean;
     /**
-     * The available values are:
-     * * `single`
-     * * `multiple`
-     *
-     * @default "multiple"
+     * Determines the selectable mode.
      */
     mode?: SelectableMode;
     /**
      * Determines if cell selection is allowed.
      *
-     * @default false
      */
     cell?: boolean;
     /**
      * Determines if drag selection is allowed.
      *
-     * @default false
      */
     drag?: boolean;
 }
 /**
- * Represents the available selection modes.
+ * Represents the available selection modes. [See example](slug:grid_row_selection).
+ *
+ * The available values are:
+ * * `single`&mdash;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`&mdash;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";
 /**