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

package/grid.module.d.ts

@@ -146,8 +146,9 @@ import * as i140 from "./column-resizing/table.directive";
 import * as i141 from "./state-management/undo-command-tool";
 import * as i142 from "./state-management/redo-command-tool";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Grid component.
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Grid component.
+ *
+ * Use this module to import the Grid in your NgModule-based Angular application.
  *
  * @example
  *

package/grouping/group-footer-template.directive.d.ts

@@ -5,12 +5,11 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the column group footer cell template of the Grid which helps to customize the group footer cell for the column.
- * To define the group footer template, nest an `<ng-template>` tag with the `kendoGridGroupFooterTemplate` directive
- * inside `<kendo-grid-column>`.
+ * The directive allows customizing the group footer cell for a column in the Grid.
+ * To set the group footer template, nest an `<ng-template>` tag with the `kendoGridGroupFooterTemplate` directive inside `<kendo-grid-column>`.
  *
- * The template context is set to the current data item and the following additional fields are passed:
- * - `column`&mdash;Defines an instance of the `ColumnComponent` option.
+ * The template context uses the current data item and provides these fields:
+ * - `column`&mdash;An instance of the `ColumnComponent` option.
  * - `field`&mdash;The current column field name.
  * - `group`&mdash;The current group data item.
  * - `aggregates`&mdash;All aggregate values for the current group.
@@ -18,7 +17,7 @@ import * as i0 from "@angular/core";
  * @example
  * ```html
  * <kendo-grid [data]="gridData" [group]="groups">
- *    <kendo-grid-column field="ProductName">
+ *    <kendo-grid-column field="ProductName" title="Product Name">
  *       <ng-template kendoGridGroupFooterTemplate let-aggregates let-field="field">
  *          Count: {{aggregates[field].count}}
  *       </ng-template>

package/grouping/group-header-column-template.directive.d.ts

@@ -5,15 +5,15 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the group-header column template of the Grid which helps to customize the content of the group headers.
+ * Represents the group-header column template of the Grid, allowing customization of group header content.
  * To define the group header template, nest an `<ng-template>` tag with the `kendoGridGroupHeaderColumnTemplate`
- * directive inside `<kendo-grid-column>`. ([See example](slug:grouping_grid_templates#toc-header-column-template)).
+ * directive inside a `<kendo-grid-column>`. [See example](slug:grouping_grid_templates#toc-header-column-template).
  *
- * The template context is set to the current data item and the following additional fields are passed:
+ * The template context is set to the current data item and provides the following fields:
  * - `group`&mdash;The current group item.
- * - `field`&mdash;The name of the field by which data is grouped.
+ * - `field`&mdash;The name of the field used for grouping.
  * - `value`&mdash;The current group value.
- * - `aggregates`&mdash;All aggregate values for the current group.
+ * - `aggregates`&mdash;Aggregate values for the current group.
  *
  * @example
  * ```html

package/grouping/group-header-template.directive.d.ts

@@ -5,17 +5,16 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the group-header cell template of the Grid which helps to customize the content of the group header item.
- * To define the group header template, nest an `<ng-template>` tag with the `kendoGridGroupHeaderTemplate`
- * directive inside `<kendo-grid-column>`. ([See example](slug:grouping_grid_templates#toc-header-template)).
+ * The directive allows customizing the content of the group header cell in the Grid.
+ * Place an `<ng-template>` with the `kendoGridGroupHeaderTemplate` directive inside `<kendo-grid-column>` to set the group header template. ([See example](slug:grouping_grid_templates#toc-header-template)).
  *
- * The template context is set to the current data item and the following additional fields are passed:
+ * The template context uses the current data item and provides these fields:
  * - `group`&mdash;The current group item.
- * - `field`&mdash;The name of the field by which data is grouped.
+ * - `field`&mdash;The field name used for grouping.
  * - `value`&mdash;The current group value.
  * - `aggregates`&mdash;All aggregate values for the current group.
  * - `index`&mdash;The index of the current group.
- * - `expanded`&mdash;A boolean value indicating if the group is currently expanded.
+ * - `expanded`&mdash;A boolean that shows if the group is expanded.
  *
  * @example
  * ```html

package/grouping/group-key.interface.d.ts

@@ -3,23 +3,23 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Represents the default format in which the [kendoGridExpandGroupBy]({% slug api_grid_expandgroupdirective %})
- * directive persists the expanded group keys ([see example]({% slug groups_expanded_state_grid %}#toc-built-in-directive)).
+ * Shows the default format for the [`kendoGridExpandGroupBy`]({% slug api_grid_expandgroupdirective %}) directive.
+ * The directive saves the expanded group keys. ([See example]({% slug groups_expanded_state_grid %}#toc-built-in-directive)).
  *
- * Determining whether a group is expanded or collapsed is done by comparing all of the following field values.
+ * The Grid checks if a group is expanded or collapsed by comparing all of these field values.
  */
 export interface GroupKey {
     /**
-     * Represents the `field` property value of the current group item.
+     * Specifies the `field` property value of the current group item.
      */
     field: string;
     /**
-     * Represents the `value` property value of the current group item.
+     * Specifies the `value` property value of the current group item.
      */
     value: any;
     /**
-     * An array of `{ field: string, value: any }` items indicating all parent groups of the current one,
-     * staring from the direct parent group all the way to the root level one. [See example](slug:groups_expanded_state_grid#toc-default-configuration).
+     * Represents an array of `{ field: string, value: any }` items that lists all parent groups of the current group.
+     * The array starts from the direct parent group and goes up to the root group. [See example](slug:groups_expanded_state_grid#toc-default-configuration).
      *
      */
     parentGroupKeys?: Array<{

package/grouping/group-rows-args.interface.d.ts

@@ -4,20 +4,20 @@
 *-------------------------------------------------------------------------------------------*/
 import { GroupResult } from "@progress/kendo-data-query";
 /**
- * Represents a group row on a specific position in the Grid. [See example](slug:groups_expanded_state_grid#toc-custom-group-key-format).
+ * Describes a group row at a specific position in the Grid. [See example](slug:groups_expanded_state_grid#toc-custom-group-key-format).
  */
 export interface GroupRowArgs {
     /**
-     * The GroupResult object associated with the group row.
+     * Represents the `GroupResult` object for the group row.
      */
     group?: GroupResult;
     /**
-     * The hierarchical row group index.
-     * For example, "4_0" would be the 1st sub-group in the 5th group.
+     * Represents the hierarchical group row index.
+     * For example, "4_0" is the first sub-group in the fifth group.
      */
     groupIndex: string;
     /**
-     * The current row parent group.
+     * Represents the parent group of the current row.
      */
     parentGroup?: GroupRowArgs;
 }

package/grouping/group-scroll-binding.directive.d.ts

@@ -25,6 +25,8 @@ export declare const noDescriptors: (descriptors?: any[]) => boolean;
 export declare const slice: (groups: any[], skip: number, take: number, includeFooters?: boolean) => VirtualGroupResult[];
 /**
  * A directive which encapsulates the in-memory handling of grouping with virtual scrolling.
+ * @remarks
+ * Applied to: {@link GridComponent}.
  */
 export declare class GroupBindingDirective extends DataBindingDirective implements AfterContentInit {
     private groupsService;

package/grouping/group-settings.d.ts

@@ -3,22 +3,22 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The settings for the grouping functionality of the Grid.
+ * Sets options for the Grid's grouping feature.
  */
 export interface GroupableSettings {
     /**
-     * Determines if grouping by dragging and dropping the column headers is allowed.
+     * If `true`, lets users group by dragging and dropping column headers.
+     * If set to `true`, users can group the Grid by dragging column headers.
+     * Grouping is off by default.
      */
     enabled?: boolean;
     /**
-     * The text that is displayed when the grouping area is empty. The default value is
-     * **Drag a column header and drop it here to group by that column**. If set to `true`,
-     * the user can group the Grid by dragging the column header cells. By default,
-     * grouping is disabled.
+     * Represents the text shown when the grouping area is empty.
+     * The default is **Drag a column header and drop it here to group by that column**.
      */
     emptyText?: string;
     /**
-     * Determines if the group footer template is visible when the group is collapsed. The default value is `false`.
+     * When `true`, shows the group footer template when the group is collapsed.
      */
     showFooter: boolean;
 }

package/grouping/virtual-group-result.interface.d.ts

@@ -4,15 +4,15 @@
 *-------------------------------------------------------------------------------------------*/
 import { GroupResult } from "@progress/kendo-data-query";
 /**
- * Represents the group result which is used in virtual scrolling.
+ * Describes the group result used for virtual scrolling.
  */
 export interface VirtualGroupResult extends GroupResult {
     /**
-     * Determines if the group header will be rendered.
+     * If `true`, skips rendering the group header.
      */
     skipHeader: boolean;
     /**
-     * Represents the absolute index of the current group.
+     * Specifies the absolute index of the current group.
      */
     offset: number;
 }

package/localization/custom-messages.component.d.ts

@@ -6,8 +6,18 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { GridMessages } from './messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override default component messages
- * ([see example](slug:globalization_grid#toc-custom-messages)).
+ * The component allows you to override the default component messages with custom ones.
+ * ([See example](slug:globalization_grid#toc-custom-messages).)
+ *
+ * @example
+ * ```html
+ * <kendo-grid [data]="gridData">
+ *   <kendo-grid-messages
+ *     [noRecords]="'No data found.'"
+ *     [pagerLabel]="'Page {currentPage} of {totalPages}'">
+ *   </kendo-grid-messages>
+ * </kendo-grid>
+ * ```
  */
 export declare class CustomMessagesComponent extends GridMessages {
     protected service: LocalizationService;