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

package/esm2022/columns/column.component.mjs

@@ -16,6 +16,14 @@ import { EditTemplateDirective } from './edit-template.directive';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/option-changes.service";
 import * as i2 from "./column-base.component";
+/**
+ * Represents a column in the Gantt. Use this component to define columns and customize their behavior and appearance.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-column field="title" title="Task"></kendo-gantt-column>
+ * ```
+ */
 export class GanttColumnComponent extends ColumnComponent {
     options;
     headerTemplates = new QueryList();
@@ -26,11 +34,13 @@ export class GanttColumnComponent extends ColumnComponent {
     filterCellTemplate;
     filterMenuTemplate;
     /**
-     * Defines the filter type that is displayed inside the filter row. The default value is `text`.
+     * Sets the filter type for the filter row. The default value is `text`.
+     * @default 'text'
      */
     filter = 'text';
     /**
-     * Defines if a filter UI will be displayed for this column. The default value is `true`.
+     * Shows or hides the filter UI for this column. The default value is `true`.
+     * @default true
      */
     filterable = true;
     /**

package/esm2022/columns/edit-template.directive.mjs

@@ -5,18 +5,27 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the column edit-cell template of the Gantt.
- * Helps to customize the content of the edited cells. To define the cell template, nest an `<ng-template>`
+ * Represents the column template for edited cells in the Gantt.
+ *
+ * Use this directive to customize the content of edited cells. To define the cell template, nest an `<ng-template>`
  * tag with the `kendoGanttEditTemplate` directive inside a `<kendo-gantt-column>` tag.
  *
- * The template context contains the following fields:
+ * The template context provides the following fields:
  * - `column`&mdash;The current column instance.
  * - `dataItem`&mdash;The current data item.
- * - `cellContext`&mdash;An object used to pass context information to built-in directives.
- * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']).
- * If you use the Gantt inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
+ * - `cellContext`&mdash;An object for passing context information to built-in directives.
+ * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']). If you use the Gantt inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it is `undefined`.
  * - `isNew`&mdash;The state of the current item.
  * - `rowIndex`&mdash;The current row index. If inside a new item row, `rowIndex` is `-1`.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-column>
+ *   <ng-template kendoGanttEditTemplate let-dataItem="dataItem" let-formGroup="formGroup">
+ *     <input [formControl]="formGroup.get('field')" />
+ *   </ng-template>
+ * </kendo-gantt-column>
+ * ```
  */
 export class EditTemplateDirective {
     templateRef;

package/esm2022/columns/filter-menu-template.directive.mjs

@@ -5,12 +5,22 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the filter-menu template.
+ * Represents the filter-menu template for the Gantt column.
  *
- * The column, current filter and the filter service are available as context variables:
- * - `column`—The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
+ * Use this directive to customize the filter menu for a column.
+ * The template context provides:
+ * - `column`—The current column instance. Use as an alias for a template variable with the `let-column="column"` syntax.
  * - `filter`—The filter descriptor.
- * - `cellContext`—An object used to pass context information to built-in directives.
+ * - `cellContext`—An object for passing context information to built-in directives.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-column>
+ *   <ng-template kendoGanttFilterMenuTemplate let-column let-filter="filter">
+ *     Custom filter for {{ column.field }}
+ *   </ng-template>
+ * </kendo-gantt-column>
+ * ```
  */
 export class FilterMenuTemplateDirective {
     templateRef;

package/esm2022/columns/footer-template.directive.mjs

@@ -5,16 +5,25 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the column footer cell template of the Gantt.
+ * Represents the footer cell template of the Gantt columns.
  *
- * Helps to customize the table footer cell for the column.
+ * Use this directive to customize the table footer cell for a column.
  * To define a footer template, nest an `<ng-template>` tag with the
  * [`kendoGanttFooterTemplate`]({% slug api_gantt_footertemplatedirective %}) directive inside the `<kendo-gantt-column>` tag.
  *
- *  The current column, column index and field are available as context variables:
- * * `column`&mdash;Points to the instance of the current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
- * * `columnIndex`&mdash;Defines the current column index.
+ * The template context provides:
+ * * `column`&mdash;The current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
+ * * `columnIndex`&mdash;The current column index.
  * * `field`&mdash;The name of the column field, if set.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-column>
+ *   <ng-template kendoGanttFooterTemplate let-column let-columnIndex="columnIndex" let-field="field">
+ *     Footer for {{ field }}
+ *   </ng-template>
+ * </kendo-gantt-column>
+ * ```
  */
 export class FooterTemplateDirective {
     templateRef;

package/esm2022/columns/header-template.directive.mjs

@@ -5,14 +5,24 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the column header cell template of the Gantt.
- * Helps to customize the table header cell for the column.
+ * Represents the header cell template of the Gantt columns.
+ *
+ * Use this directive to customize the table header cell for a column.
  * To define a header template, nest an `<ng-template>` tag with the
  * [`kendoGanttHeaderTemplate`]({% slug api_gantt_headertemplatedirective %}) directive inside the `<kendo-gantt-column>` tag.
  *
- *  The current column and column index are available as context variables:
- * * `column`&mdash;Points to the instance of the current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
- * * `columnIndex`&mdash;Defines the current column index.
+ * The template context provides:
+ * * `column`&mdash;The current [`ColumnComponent`]({% slug api_gantt_ganttcolumncomponent %}).
+ * * `columnIndex`&mdash;The current column index.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-column>
+ *   <ng-template kendoGanttHeaderTemplate let-column let-columnIndex="columnIndex">
+ *     Custom Header for {{ column.field }} ({{ columnIndex }})
+ *   </ng-template>
+ * </kendo-gantt-column>
+ * ```
  */
 export class HeaderTemplateDirective {
     templateRef;

package/esm2022/columns/span-column.component.mjs

@@ -12,6 +12,22 @@ import { EditTemplateDirective } from './edit-template.directive';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/option-changes.service";
 import * as i2 from "./column-base.component";
+/**
+ * Represents the Gantt span column.
+ *
+ * Use this component to span row content over multiple column cells.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt-span-column>
+ *   <kendo-gantt-column field="id"></kendo-gantt-column>
+ *   <kendo-gantt-column field="name"></kendo-gantt-column>
+ * </kendo-gantt-span-column>
+ * ```
+ *
+ * @remarks
+ * Supported children components are: {@link GanttColumnComponent}.
+ */
 export class GanttSpanColumnComponent extends SpanColumnComponent {
     options;
     /**

package/esm2022/directives.mjs

@@ -26,7 +26,7 @@ import { ToolbarTemplateDirective } from "./toolbar/toolbar-template.directive";
 import { TaskDragDirective } from "./dragging/task-drag.directive";
 import { GanttTaskTooltipTemplateDirective } from "./template-directives/task-tooltip-template.directive";
 /**
-* Utility array that contains all `@progress/kendo-angular-gantt` related components and directives
+* Use the `KENDO_GANTT` utility array to import all Kendo UI for Angular Gantt components and directives to a standalone Angular component.
 */
 export const KENDO_GANTT = [
     GanttComponent,

package/esm2022/dragging/dependency-drag-create.directive.mjs

@@ -17,28 +17,19 @@ import * as i1 from "../gantt.component";
 import * as i2 from "../common/mapping.service";
 import * as i3 from "@progress/kendo-angular-popup";
 import * as i4 from "../scrolling/timeline-scroll.service";
-/**
- * When added to the .k-task-dot, the element will be kept with hover styles.
- * Used for the drag clue from which the dragging has started.
- */
 const DRAG_CLUE_HOVER_CLASS = 'k-hover';
-/**
- * Add the selection disabling class to the enitre container.
- * Otherwise existing selection on a given task text prevents dragging the clue even if the clue has `user-select: none` styles.
- */
 const USER_SELECT_NONE_CLASS = 'k-user-select-none';
-/**
- * When added to the .k-task-wrap, the containing .k-task-dot elements will be kept visible even when not hovered.
- * Used for the drag clue from which the dragging has started.
- */
 const TASK_WRAPPER_DRAG_CLASS = 'k-origin';
-/**
- * Use 20px margin between the pointer and the popup.
- * Could be made user-configurable if there's demand.
- */
 const DEFAULT_POPUP_VERTICAL_MARGIN = 20;
 /**
- * A directive which enables the creation of new dependencies via dragging.
+ * Enables creating new dependencies by dragging.
+ *
+ * ```html
+ * <kendo-gantt kendoGanttDependencyDragCreate></kendo-gantt>
+ * ```
+ *
+ * @remarks
+ * Applied to: {@link GanttComponent}
  */
 export class DependencyDragCreateDirective {
     gantt;
@@ -48,7 +39,7 @@ export class DependencyDragCreateDirective {
     popupService;
     timelineScrollService;
     /**
-     * Specifies whether the validation tooltip will be displayed during drag operations.
+     * Shows the validation tooltip during drag operations.
      *
      * @default true
      */

package/esm2022/dragging/task-drag.directive.mjs

@@ -15,15 +15,28 @@ import * as i1 from "../gantt.component";
 import * as i2 from "../common/mapping.service";
 import * as i3 from "@progress/kendo-angular-utils";
 import * as i4 from "./task-drag.service";
+/**
+ * Represents the Gantt task drag directive.
+ *
+ * Use this directive to enable dragging of tasks in the Gantt. The directive listens and emits events with information about the dragged task.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt [data]="tasks" kendoGanttTaskDrag (taskDrag)="onTaskDrag($event)" (taskDragEnd)="onTaskDragEnd($event)">
+ * </kendo-gantt>
+ * ```
+ *
+ * @remarks
+ * Applied to: {@link GanttComponent}
+ */
 export class TaskDragDirective {
     /**
-     * Emitted while the end user is resizing or moving a task through dragging.
+     * Emits while the user resizes or moves a task by dragging.
      */
     taskDrag = new EventEmitter();
     /**
-     * Triggered when the dragging action associated with resizing or moving an event is finished.
-     * The event data contains all necessary information to update the task and all related tasks
-     * accordingly.
+     * Fires when the user finishes dragging to resize or move a task.
+     * The event data gives you all information needed to update the task and related tasks.
      */
     taskDragEnd = new EventEmitter();
     subs = new Subscription();

package/esm2022/editing/add-task.component.mjs

@@ -12,26 +12,26 @@ import * as i0 from "@angular/core";
 import * as i1 from "@progress/kendo-angular-l10n";
 import * as i2 from "./edit.service";
 /**
- * The UI for adding new items to the Gantt.
- * Use it within a toolbar template to provide a custom icon or list of options.
+ * Displays the UI for adding new items to the Gantt.
+ * Use this in a toolbar template to show a custom icon or a list of options.
  */
 export class GanttAddTaskComponent {
     localizationService;
     editService;
     ngZone;
     /**
-     * Sets the data of the DropDownButton.
-     * > The data has to be provided in an array-like list.
+     * Sets the data for the DropDownButton.
+     * Provide the data as an array-like list.
      */
     data;
     /**
-     * Defines the name of an existing icon in a Kendo UI theme.
+     * Sets the name of an existing icon in a Kendo UI theme.
      * @default 'plus'
      */
     icon = 'plus';
     /**
-     * Defines an [`SVGIcon`](slug:api_icons_svgicon) icon to be rendered inside the `GanttAddTaskComponent` using
-     * a [`KendoSVGIcon`](slug:api_icons_svgiconcomponent) component.
+     * Sets an [`SVGIcon`](slug:api_icons_svgicon) to render inside the `GanttAddTaskComponent` using
+     * an [`SVGIconComponent`](slug:api_icons_svgiconcomponent).
      */
     svgIcon = plusIcon;
     constructor(localizationService, editService, ngZone) {

package/esm2022/expanded-state/expand-event.mjs

@@ -3,7 +3,8 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Arguments for the Gantt `expand` and `collapse` events.
+ * Represents the arguments for the Gantt `expand` and `collapse` events.
+ *
  */
 export class ExpandEvent {
     /** @hidden */
@@ -11,7 +12,7 @@ export class ExpandEvent {
         //TODO: empty ctor
     }
     /**
-     * The expanded/collapsed data item.
+     * The expanded or collapsed data item.
      */
     dataItem;
 }

package/esm2022/expanded-state/expandable.directive.mjs

@@ -6,14 +6,20 @@ import { Directive, Input } from '@angular/core';
 import { ExpandableDirective } from '@progress/kendo-angular-treelist';
 import * as i0 from "@angular/core";
 /**
- * A directive which controls the expanded state of the items.
+ * Represents a directive that controls the expanded state of Gantt items.
+ *
+ * @example
+ * ```html
+ * <kendo-gantt kendoGanttExpandable [expandedKeys]="expandedKeys"></kendo-gantt>
+ * ```
+ *
+ * @remarks
+ * Applied to: {@link GanttComponent}
  */
 export class GanttExpandableDirective extends ExpandableDirective {
     /**
-     * Defines the item key that will be stored in the expandedKeys collection.
-     * Defaults to the task data item ID field,
-     * which is specified in the [`taskModelFields`]({% slug api_gantt_ganttcomponent %}#toc-taskmodelfields) object.
-     *
+     * Sets the item key stored in the `expandedKeys` collection.
+     * The default value is the task data item ID field, specified in the `taskModelFields` object.
      */
     set expandBy(value) {
         super.expandBy = value;