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

package/tabstrip/tabstrip.component.d.ts

@@ -20,6 +20,24 @@ import { TabStripSize } from './models/size';
 import * as i0 from "@angular/core";
 /**
  * Represents the [Kendo UI TabStrip component for Angular]({% slug overview_tabstrip %}).
+ *
+ * @example
+ * ```html
+ * <kendo-tabstrip>
+ *   <kendo-tabstrip-tab [title]="'First Tab'">
+ *     <ng-template kendoTabContent>
+ *       <p>Content of the first tab.</p>
+ *     </ng-template>
+ *   </kendo-tabstrip-tab>
+ *   <kendo-tabstrip-tab [title]="'Second Tab'">
+ *     <ng-template kendoTabContent>
+ *       <p>Content of the second tab.</p>
+ *     </ng-template>
+ *   </kendo-tabstrip-tab>
+ * </kendo-tabstrip>
+ * ```
+ * @remarks
+ * Supported children components are: {@link TabStripCustomMessagesComponent}, {@link TabStripTabComponent}.
  */
 export declare class TabStripComponent implements AfterViewInit, OnDestroy {
     localization: LocalizationService;
@@ -30,11 +48,12 @@ export declare class TabStripComponent implements AfterViewInit, OnDestroy {
     private ngZone;
     /**
      * Sets the height of the TabStrip.
+     * Accepts a CSS size value, such as `100px`, `50%`, or `auto`.
      */
     set height(value: string | null | undefined);
     get height(): string | null | undefined;
     /**
-     * Enables the tab animation.
+     * Sets whether the TabStrip should animate when switching tabs.
      *
      * @default true
      */
@@ -42,83 +61,75 @@ export declare class TabStripComponent implements AfterViewInit, OnDestroy {
     /**
      * Sets the alignment of the tabs.
      *
-     * @default: 'start'
+     * @default 'start'
      */
     tabAlignment: TabAlignment;
     /**
-     * Sets the position of the tabs. Defaults to `top`.
+     * Sets the position of the tabs.
      *
      * @default 'top'
      */
     tabPosition: TabPosition;
     /**
-     * When set to `true`, the component renders all tabs and they are persisted in the DOM.
-     * By default, `keepTabContent` is `false`.
+     * When set to `true`, the tabs are persisted in the DOM and their content is not destroyed when they are not selected ([see example](slug:rendering_tabstrip)).
      *
      * @default false
      */
     keepTabContent: boolean;
     /**
-     * When set to `true`, a close button will be rendered inside each tab.
-     * By default, `closable` is `false`.
+     * When set to `true`, renders a close button inside each tab.
      *
      * @default false
      */
     closable: boolean;
     /**
-     * Enables the scrolling of the tab list. When set to `true` and the total size of all tabs
-     * is greater than the size of the TabStrip container, scroll buttons will be rendered on each end of the tab list.
-     *
-     * By default, `scrollable` is `false`.
+     * Enables scrolling of the tab list.
+     * When set to `true` and the total size of all tabs exceeds the size of the TabStrip container, scroll buttons appear on each end of the tab list.
      *
      * @default false
      */
     set scrollable(value: boolean | TabStripScrollableSettings);
     get scrollable(): boolean | TabStripScrollableSettings;
     /**
-     * Specifies the size of the TabStrip.
-     * ([see example](slug:api_layout_tabstripcomponent#toc-size).
-     *
-     * The possible values are:
-     * * `small`
-     * * `medium` (Default)
-     * * `large`
-     * * `none`
+     * Sets the size of the TabStrip.
+     * [See example](slug:api_layout_tabstripcomponent#toc-size).
+     * @default 'medium'
      */
     set size(value: TabStripSize);
     get size(): TabStripSize;
     /**
-     * Defines the name for an existing font icon in the Kendo UI theme for the close icon.
+     * Defines the name of an existing font icon in the Kendo UI theme for the close icon.
+     * @default 'x'
      */
     closeIcon: string;
     /**
-     * Allows defining a custom CSS class, or multiple classes separated by spaces, which will be applied to the close button.
+     * Defines a custom CSS class, or multiple classes separated by spaces, applied to the close button.
      */
     closeIconClass: string;
     /**
-     * Defines an SVGIcon to be rendered for the close icon.
-     * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
+     * Defines an SVGIcon to render for the close icon.
+     * The input accepts either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
      */
     set closeSVGIcon(icon: SVGIcon);
     get closeSVGIcon(): SVGIcon;
     /**
-     * Determines whether the content associated with each tab will be rendered.
+     * If set to `false`, the content area is hidden, but the tab headers are still visible.
      *
      * @default true
      */
     showContentArea: boolean;
     /**
-     * Fires each time the user selects a tab ([see example](slug:events_tabstrip)).
+     * Fires each time a tab is selected.
      * The event data contains the index of the selected tab and its title.
      */
     tabSelect: EventEmitter<SelectEvent>;
     /**
-     * Fires each time the user closes a tab.
+     * Fires each time a tab is closed.
      * The event data contains the index of the closed tab and its instance.
      */
     tabClose: EventEmitter<TabCloseEvent>;
     /**
-     * Fires each time the user scrolls the TabStrip list.
+     * Fires when the tab list is scrolled.
      * The event is preventable.
      */
     tabScroll: EventEmitter<TabScrollEvent>;
@@ -191,8 +202,9 @@ export declare class TabStripComponent implements AfterViewInit, OnDestroy {
      */
     get itemsWrapperClass(): string;
     /**
-     * Allows the user to select a tab programmatically.
-     * @param {number} index - The index of the tab that will be selected.
+     * Allows you to programmatically select a tab by its index.
+     * If the tab is disabled, it will not be selected.
+     * @param {number} index The index of the tab that will be selected.
      */
     selectTab(index: number): void;
     /**

package/tabstrip.module.d.ts

@@ -9,14 +9,20 @@ import * as i3 from "./tabstrip/directives/tab-content.directive";
 import * as i4 from "./tabstrip/directives/tab-title.directive";
 import * as i5 from "./tabstrip/localization/custom-messages.component";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the TabStrip component.
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the TabStrip component.
  *
- * The module registers:
- * - `TabStripComponent`—The `TabStrip` component class.
- * - `TabStripTabComponent`—The `TabStripTab` component class.
- * - `TabContentDirective`&mdash;The tab content directive used on the `<ng-template>` tag.
- * - `TabTitleDirective`&mdash;The tab title directive used on the `<ng-template>` tag.
+ * Use this module to add the TabStrip component to your NgModule-based Angular application.
+ *
+ * @example
+ * ```typescript
+ * import { TabStripModule } from '@progress/kendo-angular-layout';
+ * import { NgModule } from '@angular/core';
+ *
+ * @NgModule({
+ *   imports: [TabStripModule]
+ * })
+ * export class AppModule { }
+ * ```
  */
 export declare class TabStripModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<TabStripModule, never>;

package/tilelayout/models/flowmode.type.d.ts

@@ -3,15 +3,14 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Controls how the auto-placement algorithm works, specifying exactly how auto-placed items are flowed in the TileLayout.
+ * The flow modes controls how auto-placed items are arranged in the TileLayout.
  * For further reference, check the [grid-auto-flow CSS article](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow).
  *
- * The possible values are:
- * * (Default) `column`
- * * `row`
- * * `row-dense`
- * * `column-dense`
- * * `none`
- *
+ * The available values are:
+ * * `column` (Default)—Sets the grid-auto-flow CSS property of the TileLayout to column.
+ * * `column-dense`—Sets the grid-auto-flow CSS property of the TileLayout to column dense.
+ * *`row`—Sets the grid-auto-flow CSS property of the TileLayout to row.
+ * *`row-dense`—Sets the grid-auto-flow CSS property of the TileLayout to row dense.
+ * *`none`—Does not apply the grid-auto-flow CSS property. In this case the default behavior of the CSS Grid Layout will be used.
  */
 export type TileLayoutFlowMode = 'none' | 'row' | 'column' | 'row-dense' | 'column-dense';

package/tilelayout/models/gap.interface.d.ts

@@ -3,17 +3,15 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Тhe values which determine the spacing between the layout items horizontally and vertically.
+ * Sets the spacing between layout items horizontally and vertically.
  */
 export interface TileLayoutGap {
     /**
-     * The vertical spacing. Numeric values are treated as pixels.
-     * @default 16
+     * Sets the vertical spacing in pixels.
      */
     rows?: number;
     /**
-     * The horizontal spacing. Numeric values are treated as pixels.
-     * @default 16
+     * Sets the horizontal spacing in pixels.
      */
     columns?: number;
 }

package/tilelayout/reorder-event.d.ts

@@ -5,8 +5,9 @@
 import { PreventableEvent } from '@progress/kendo-angular-common';
 import { TileLayoutItemComponent } from './tilelayout-item.component';
 /**
- * Arguments for the `reorder` event. The event fires when the order or starting
- * positions of the items is changed via the UI. If you prevent the event, the change is canceled ([see example]({% slug reordering_tilelayout %}#toc-handling-the-reorder-event)).
+ * Arguments for the `reorder` event.
+ * The event fires when you change the order or starting positions of items through the UI.
+ * You can prevent this event to cancel the reorder operation.
  */
 export declare class TileLayoutReorderEvent extends PreventableEvent {
     item: TileLayoutItemComponent;

package/tilelayout/resize-event.d.ts

@@ -5,8 +5,9 @@
 import { PreventableEvent } from '@progress/kendo-angular-common';
 import { TileLayoutItemComponent } from './tilelayout-item.component';
 /**
- * Arguments for the `resize` event. The `resize` event fires when any item size
- * is changed from the UI. If you cancel the event, the change is prevented ([see example]({% slug resizing_tilelayout %}#toc-handling-the-resize-event)).
+ * Arguments for the `resize` event.
+ * The `resize` event fires when you change any item size through the UI.
+ * You can prevent this event to stop the resize operation.
  */
 export declare class TileLayoutResizeEvent extends PreventableEvent {
     item: TileLayoutItemComponent;

package/tilelayout/tilelayout-item-body.component.d.ts

@@ -4,7 +4,16 @@
 *-------------------------------------------------------------------------------------------*/
 import * as i0 from "@angular/core";
 /**
- * Holds the main content of the TileLayoutItem component.
+ * Contains the main content of the `TileLayoutItem` component.
+ *
+ * @example
+ * ```html
+ * <kendo-tilelayout-item>
+ *   <kendo-tilelayout-item-body>
+ *     <p>Main content goes here</p>
+ *   </kendo-tilelayout-item-body>
+ * </kendo-tilelayout-item>
+ * ```
  */
 export declare class TileLayoutItemBodyComponent {
     hostClass: boolean;

package/tilelayout/tilelayout-item-header.component.d.ts

@@ -4,8 +4,18 @@
 *-------------------------------------------------------------------------------------------*/
 import * as i0 from "@angular/core";
 /**
- * Holds the content of the header section of the TileLayoutItem component.
- * This is the area which can be dragged to reorder the items if reordering is enabled for this item.
+ * Contains the header content of the `TileLayoutItem` component.
+ * You can drag this area to reorder items when reordering is enabled.
+ *
+ * @example
+ * ```html
+ * <kendo-tilelayout-item>
+ *   <kendo-tilelayout-item-header>
+ *     <h3>Custom Header</h3>
+ *   </kendo-tilelayout-item-header>
+ *   <p>Item content</p>
+ * </kendo-tilelayout-item>
+ * ```
  */
 export declare class TileLayoutItemHeaderComponent {
     hostClass: boolean;

package/tilelayout/tilelayout-item.component.d.ts

@@ -9,6 +9,17 @@ import { TileLayoutKeyboardNavigationService } from './keyboard-navigation.servi
 import * as i0 from "@angular/core";
 /**
  * Represents a tile item within the TileLayoutComponent.
+ *
+ * @example
+ * ```html
+ * <kendo-tilelayout>
+ *   <kendo-tilelayout-item [title]="'Item 1'" [colSpan]="2">
+ *     <p>Item content goes here</p>
+ *   </kendo-tilelayout-item>
+ * </kendo-tilelayout>
+ * ```
+ * @remarks
+ * Supported children components are: {@link TileLayoutItemBodyComponent}, {@link TileLayoutItemHeaderComponent}.
  */
 export declare class TileLayoutItemComponent implements AfterViewInit, OnDestroy, OnChanges {
     elem: ElementRef;
@@ -18,42 +29,41 @@ export declare class TileLayoutItemComponent implements AfterViewInit, OnDestroy
     private draggingService;
     private keyboardNavigationService;
     /**
-     * The title that will be rendered in the item header ([see example]({% slug tiles_tilelayout %}#toc-tiles-configuration)).
+     * Sets the title text that appears in the item header ([see example]({% slug tiles_tilelayout %}#toc-tiles-configuration)).
      */
     title: string;
     /**
-     * Determines how many rows will the tile item span ([see example](slug:resizing_tilelayout#programmatic-resizing)).
+     * Sets how many rows the tile item spans ([see example](slug:resizing_tilelayout#programmatic-resizing)).
      * @default 1
      */
     rowSpan: number;
     /**
-     * Determines how many columns will the tile item span ([see example](slug:resizing_tilelayout#programmatic-resizing)).
+     *  Sets how many columns the tile item spans ([see example](slug:resizing_tilelayout#programmatic-resizing)).
      * @default 1
      */
     colSpan: number;
     /**
-     * Determines the order of the tile items within the TileLayout.
-     * If not set, the items will receive increasing sequential order in accordance with
-     * their position in the DOM when initially rendered.
+     * Sets the order of the tile item within the TileLayout.
+     * When not set, items receive increasing order values based on their DOM position.
      */
     set order(value: number);
     get order(): number;
     /**
-     * Sets the starting column of the item ([see example](slug:tiles_tilelayout#size-and-position)).
+     * Sets the starting column position of the item ([see example](slug:tiles_tilelayout#size-and-position)).
      */
     col: number;
     /**
-     * Sets the starting row of the item ([see example](slug:tiles_tilelayout#size-and-position)).
+     * Sets the starting row position of the item ([see example](slug:tiles_tilelayout#size-and-position)).
      */
     row: number;
     /**
-     * Determines whether the item can be reordered. By default all items are reorderable when the [reorderable]({% slug api_layout_tilelayoutcomponent %}#toc-reorderable) property of the TileLayoutComponent is set to `true` ([see example]({% slug reordering_tilelayout %}#toc-disabling-reordering)).
+     * Enables or disables individual item reordering.
      *
      * @default true
      */
     reorderable: boolean;
     /**
-     * Determines whether the item can be resized. By default all items are resizable when the [resizable]({% slug api_layout_tilelayoutcomponent %}#resizable) property of the TileLayoutComponent is set to `true` ([see example](slug:resizing_tilelayout#toc-disabling-resizing)).
+     * Enables or disables individual item resizing.
      * @default true
      */
     resizable: boolean;

package/tilelayout/tilelayout.component.d.ts

@@ -14,6 +14,16 @@ import { TileLayoutKeyboardNavigationService } from './keyboard-navigation.servi
 import * as i0 from "@angular/core";
 /**
  * Represents the [Kendo UI TileLayout component for Angular]({% slug overview_tilelayout %})
+ *
+ * @example
+ * ```html
+ * <kendo-tilelayout [columns]="3" [gap]="10">
+ *   <kendo-tilelayout-item>Content 1</kendo-tilelayout-item>
+ *   <kendo-tilelayout-item>Content 2</kendo-tilelayout-item>
+ * </kendo-tilelayout>
+ * ```
+ * @remarks
+ * Supported children components are: {@link TileLayoutItemComponent}.
  */
 export declare class TileLayoutComponent implements OnInit, AfterViewInit, AfterContentInit, OnDestroy, OnChanges {
     private zone;
@@ -23,68 +33,62 @@ export declare class TileLayoutComponent implements OnInit, AfterViewInit, After
     private draggingService;
     private navigationService;
     /**
-     * Defines the number of columns ([see example](slug:tiles_tilelayout#size-and-position)).
+     * Specifies the number of columns ([see example](slug:tiles_tilelayout#size-and-position)).
      * @default 1
      */
     columns: number;
     /**
-     * Determines the width of the columns. Numeric values are treated as pixels ([see example](slug:tiles_tilelayout#size-and-position)).
+     * Sets the width of the columns.
+     * Use numeric values for pixels or string values for other CSS units ([see example](slug:tiles_tilelayout#size-and-position)).
      * @default '1fr'
      */
     columnWidth: string | number;
     /**
-     * The numeric values which determine the spacing in pixels between the layout items horizontally and vertically.
-     * Properties:
-     * * rows - the vertical spacing. Numeric values are treated as pixels. Defaults to `16`.
-     * * columns - the horizontal spacing. Numeric values are treated as pixels. Defaults to `16`.
+     * Sets the spacing between layout items in pixels.
+     * Use an object with `rows` and `columns` properties to set different horizontal and vertical spacing.
+     * Use a single number to apply the same spacing to both directions.
      *
-     * When bound to a single numeric value, it will be set to both `rows` and `columns` properties.
+     * @default { rows: 16, columns: 16 }
      */
     set gap(value: TileLayoutGap | number);
     get gap(): TileLayoutGap | number;
     /**
-     * Determines whether the reordering functionality will be enabled ([see example]({% slug reordering_tilelayout %})).
+     * Enables or disables item reordering ([see example]({% slug reordering_tilelayout %})).
      * @default false
      */
     reorderable: boolean;
     /**
-     * Determines whether the resizing functionality will be enabled ([see example]({% slug resizing_tilelayout %})).
+     * Enables or disables item resizing ([see example]({% slug resizing_tilelayout %})).
      * @default false
      */
     resizable: boolean;
     /**
-     * Determines the height of the rows. Numeric values are treated as pixels ([see example](slug:tiles_tilelayout#size-and-position)).
+     * Sets the height of the rows.
+     * Use numeric values for pixels or string values for other CSS units ([see example](slug:tiles_tilelayout#size-and-position)).
      * @default '1fr'
      */
     rowHeight: string | number;
     /**
-     * Controls how the auto-placement algorithm works, specifying exactly how auto-placed items are flowed in the TileLayout ([see example]({% slug tiles_autoflow_tilelayout %})).
-     * For further reference, check the [grid-auto-flow CSS article](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow).
      *
-     * The possible values are:
-     * * (Default) `column`
-     * * `row`
-     * * `row dense`
-     * * `column dense`
-     * * `none`
+     * Controls how the auto-placement algorithm works, specifying exactly how auto-placed items are flowed in the TileLayout ([see example]({% slug tiles_autoflow_tilelayout %})).
      *
+     * For further reference, check the [grid-auto-flow CSS article](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow).
+     * @default 'column'
      */
     autoFlow: TileLayoutFlowMode;
     /**
-     * When the keyboard navigation is enabled, the user can use dedicated shortcuts to interact with the TileLayout.
-     * By default, navigation is enabled. To disable it and include focusable TileLayout content as a part of the natural tab sequence of the page, set the property to `false`.
-     *
+     * Enables or disables [keyboard navigation](slug:keyboard_navigation_tilelayout).
      * @default true
      */
     navigable: boolean;
     /**
-     * Fires when the user completes the reordering of the item ([see example]({% slug reordering_tilelayout %})).
-     * This event is preventable. If you cancel it, the item will not be reordered.
+     * Fires when item reordering is completed ([see example]({% slug reordering_tilelayout %})).
+     * You can prevent this event to cancel the reorder operation.
      */
     reorder: EventEmitter<TileLayoutReorderEvent>;
     /**
-     * Fires when the user completes the resizing of the item ([see example]({% slug resizing_tilelayout %})).
-     * This event is preventable. If you cancel it, the item will not be resized.
+     * Fires when item resizing is completed ([see example]({% slug resizing_tilelayout %})).
+     * You can prevent this event to cancel the resize operation.
      */
     resize: EventEmitter<TileLayoutResizeEvent>;
     hostClass: boolean;
@@ -96,7 +100,8 @@ export declare class TileLayoutComponent implements OnInit, AfterViewInit, After
     get draggedItemWrapper(): HTMLElement;
     get targetOrder(): number;
     /**
-     * A query list of all declared [TileLayoutItemComponent]({% slug api_layout_tilelayoutitemcomponent %}) items.
+     * Contains a query list of the `TileLayoutItemComponent` instances that are used in the TileLayout.
+     * This allows you to access the items programmatically and manipulate their properties or listen to their events.
      */
     items: QueryList<TileLayoutItemComponent>;
     private hint;

package/tilelayout.module.d.ts

@@ -8,14 +8,20 @@ import * as i2 from "./tilelayout/tilelayout-item-body.component";
 import * as i3 from "./tilelayout/tilelayout-item.component";
 import * as i4 from "./tilelayout/tilelayout-item-header.component";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the TileLayout component.
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the TileLayout component.
  *
- * The module registers:
- * - `TileLayoutComponent`—The `TileLayoutComponent` component class.
- * - `TileLayoutItemComponent`—The `TileLayoutItemComponent` component class.
- * - `TileLayoutItemHeaderComponent`—The `TileLayoutItemHeaderComponent` component class.
- * - `TileLayoutItemBodyComponent`—The `TileLayoutItemBodyComponent` component class.
+ * Use this module to add the TileLayout component to your NgModule-based Angular application.
+ *
+ * @example
+ * ```typescript
+ * import { TileLayoutModule } from '@progress/kendo-angular-layout';
+ * import { NgModule } from '@angular/core';
+ *
+ * @NgModule({
+ *   imports: [TileLayoutModule]
+ * })
+ * export class AppModule { }
+ * ```
  */
 export declare class TileLayoutModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<TileLayoutModule, never>;

package/timeline/events/navigation-direction.d.ts

@@ -2,4 +2,10 @@
 * Copyright © 2025 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
+/**
+ * Specifies the direction for navigating through `Timeline` items.
+ *
+ * Use 'previous' to navigate to the previous item.
+ * Use 'next' to navigate to the next item.
+ */
 export type NavigationDirection = 'previous' | 'next';

package/timeline/models/anchor-target.d.ts

@@ -2,4 +2,10 @@
 * Copyright © 2025 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
+/**
+ * Defines the target for opening links in the Timeline component.
+ *
+ * Use 'self' to open the link in the same window or tab.
+ * Use 'blank' to open the link in a new window or tab.
+ */
 export type AnchorTarget = 'self' | 'blank';

package/timeline/templates/timeline-card-actions.directive.d.ts

@@ -9,8 +9,17 @@ import * as i0 from "@angular/core";
  * with the `kendoTimelineCardActionsTemplate` directive inside the `<kendo-timeline>` tag.
  *
  * The following values are available as context variables:
- * - `let-event="event"` (`TimelineEvent`) - The current card's event. Also available as implicit context variable.
- * - `let-index="index"` (`number`) - The current event index.
+ * - `let-event="event"` (`TimelineEvent`)&mdash;The current card's event. Also available as implicit context variable.
+ * - `let-index="index"` (`number`)&mdash;The current event index.
+ *
+ * @example
+ * ```html
+ * <kendo-timeline [events]="events">
+ *   <ng-template kendoTimelineCardActionsTemplate let-event let-index="index">
+ *     Content for the actions of the card with index {{ index }} and event {{ event.title }}.
+ *   </ng-template>
+ * </kendo-timeline>
+ * ```
  */
 export declare class TimelineCardActionsTemplateDirective {
     templateRef: TemplateRef<any>;

package/timeline/templates/timeline-card-body.directive.d.ts

@@ -9,8 +9,17 @@ import * as i0 from "@angular/core";
  * with the `kendoTimelineCardBodyTemplate` directive inside the `<kendo-timeline>` tag.
  *
  * The following values are available as context variables:
- * - `let-event="event"` (`TimelineEvent`) - The current card's event. Also available as implicit context variable.
- * - `let-index="index"` (`number`) - The current event index.
+ * - `let-event="event"` (`TimelineEvent`)&mdash;The current card's event. Also available as implicit context variable.
+ * - `let-index="index"` (`number`)&mdash;The current event index.
+ *
+ * @example
+ * ```html
+ * <kendo-timeline [events]="events">
+ *   <ng-template kendoTimelineCardBodyTemplate let-event let-index="index">
+ *     Component for the body of the card with index {{ index }} and event {{ event.title }}.
+ *   </ng-template>
+ * </kendo-timeline>
+ * ```
  */
 export declare class TimelineCardBodyTemplateDirective {
     templateRef: TemplateRef<any>;

package/timeline/templates/timeline-card-header.directive.d.ts

@@ -9,8 +9,18 @@ import * as i0 from "@angular/core";
  * with the `kendoTimelineCardHeaderTemplate` directive inside the `<kendo-timeline>` tag.
  *
  * The following values are available as context variables:
- * - `let-event="event"` (`TimelineEvent`) - The current card's event. Also available as implicit context variable.
- * - `let-index="index"` (`number`) - The current event index.
+ * - `let-event="event"` (`TimelineEvent`)&mdash;The current card's event. Also available as implicit context variable.
+ * - `let-index="index"` (`number`)&mdash;The current event index.
+ *
+ * @example
+ * ```html
+ * <kendo-timeline [events]="events">
+ *   <ng-template kendoTimelineCardHeaderTemplate let-event let-index="index">
+ *     <span class="k-event-title">Title: {{ event.title }}</span>
+ *     <div kendoCardSubtitle>Event number {{ index }}</div>
+ *   </ng-template>
+ * </kendo-timeline>
+ * ```
  */
 export declare class TimelineCardHeaderTemplateDirective {
     templateRef: TemplateRef<any>;

package/timeline/timeline.component.d.ts

@@ -15,6 +15,9 @@ import { TimelineCardActionsTemplateDirective } from './templates/timeline-card-
 import * as i0 from "@angular/core";
 /**
  * Represents the [Kendo UI Timeline component for Angular]({% slug overview_timeline %}).
+ *
+ * @remarks
+ * Supported children components are: {@link TimelineCustomMessagesComponent}.
  */
 export declare class TimelineComponent implements AfterContentInit, OnDestroy {
     private timelineService;

package/timeline.module.d.ts

@@ -9,11 +9,20 @@ import * as i3 from "./timeline/templates/timeline-card-actions.directive";
 import * as i4 from "./timeline/templates/timeline-card-body.directive";
 import * as i5 from "./timeline/templates/timeline-card-header.directive";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Timeline component.
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Timeline component.
  *
- * The module registers:
- * - `TimelineComponent`—The `TimelineComponent` component class.
+ * Use this module to add the Timeline component to your NgModule-based Angular application.
+ *
+ * @example
+ * ```typescript
+ * import { TimelineModule } from '@progress/kendo-angular-layout';
+ * import { NgModule } from '@angular/core';
+ *
+ * @NgModule({
+ *   imports: [TimelineModule]
+ * })
+ * export class AppModule { }
+ * ```
  */
 export declare class TimelineModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<TimelineModule, never>;