@heartlandone/vega 2.75.1 → 2.76.0

package/dist/types/components/vega-table/interface.d.ts

@@ -6,52 +6,115 @@ import { BreakpointsForPrefixType } from '../../types/ui.type';
  * A virtual DOM node
  */
 export declare type VegaTableNode = VNode;
+/**
+ * Content that can be rendered in a table cell, supporting VNode, strings, or numbers.
+ */
 export declare type VegaTableCellNode = VegaTableNode | string | number;
+/**
+ * Factory function for creating DOM elements within table cell renderers.
+ * Supports both Vega components and standard JSX elements.
+ */
 export declare type VegaTableCreateElementFunction = <T extends keyof VegaComponents.JSX.IntrinsicElements | keyof JSXBase.IntrinsicElements>(elementType: T, props?: T extends keyof VegaComponents.JSX.IntrinsicElements ? VegaComponents.JSX.IntrinsicElements[T] | {
   [attrName: string]: unknown;
 } : T extends keyof JSXBase.IntrinsicElements ? JSXBase.IntrinsicElements[T] : null, children?: VegaTableCellNode | VegaTableCellNode[]) => VegaTableNode;
+/**
+ * Callback function to render custom content for table cells.
+ * Provides access to the cell value, row data, and rendering utilities.
+ */
 export declare type VegaTableCellRenderFunction = (createElement: VegaTableCreateElementFunction, value: unknown, record: VegaTableDataSourceItem, index: number) => VegaTableCellNode;
+/**
+ * Callback function to render form items in editable table cells.
+ * Provides form context and row information for custom form field rendering.
+ */
 export declare type VegaTableCellFormItemRenderFunction = (createElement: VegaTableCreateElementFunction, value: unknown, record: VegaTableDataSourceItem, index: number, rowPayload: {
   rowForm: HTMLVegaFormElement;
   isNewRow: boolean;
 }) => VegaTableCellNode;
+/**
+ * Comparator function for custom column sorting logic.
+ * Returns negative (a < b), zero (a === b), or positive (a > b) values.
+ */
 export declare type VegaTableSortCompareFunction = (a: VegaTableDataSourceItem, b: VegaTableDataSourceItem) => number;
+/**
+ * Horizontal alignment of table column contents.
+ */
 export declare type ColumnAlignType = 'left' | 'right' | 'center';
+/**
+ * Row spacing density affecting visual compactness of the table.
+ */
 export declare type VegaTableDensityType = 'default' | 'compact' | 'relaxed';
+/**
+ * Positioning options for table pagination controls.
+ */
 export declare type VegaTablePaginationPosition = 'bottom-left' | 'bottom-center' | 'bottom-right';
+/**
+ * Configuration for table pagination behavior and event handling.
+ */
 export declare type VegaTablePagination = {
+  /**
+   * Position where pagination controls should be rendered.
+   */
   position?: VegaTablePaginationPosition;
+  /**
+   * Event handler fired when current page changes.
+   */
   vegaChange?: (e: CustomEvent<number>) => void;
+  /**
+   * Event handler fired when page size selection changes.
+   */
   vegaPageSizeChange?: (e: CustomEvent<number>) => void;
 } & Partial<Pick<HTMLVegaPaginationElement, 'pageSize' | 'current' | 'extensions' | 'pageSizeSelectorOptions'>>;
 /**
- * The column of vega-table
- *
- * @property {string} key - The key of the column. If not provided, it will be the same as the prop.
- * @property {string} label - The label of the column
- * @property {string} prop - The property name of the data object that will be used to populate the cell.
- * @property {VegaTableSorterConfig} sorter - If you need remote sorting from backend, set to 'event'
- * @property {VegaTableSortOrderType} sortOrder - The default sort order of the column.
- * @property {VegaTableCellRenderFunction} render - A function that returns a React component. This is useful if you want to render a custom component in a cell.
- * @property {VegaTableColumnBreakpoint} breakpoint - The breakpoint at which the column will be hidden.
- * @property {VegaTableColumnBreakpoint} align - Align of the column
- * @property {string} width - The width of the column
+ * Column configuration for table data display and interaction.
  */
 export declare type VegaTableColumnConfig = {
+  /**
+   * Unique identifier for the column. Defaults to prop value if not provided.
+   */
   key?: string;
+  /**
+   * Display label shown in column header.
+   */
   label: string;
+  /**
+   * Property name of the data object to bind to this column.
+   */
   prop?: string;
+  /**
+   * If you need remote sorting from backend, set to 'event'
+   */
   sorter?: VegaTableSorterConfig;
+  /**
+   *  The default sort order of the column.
+   */
   sortOrder?: VegaTableSortOrderType;
+  /**
+   * A function that returns a React component. This is useful if you want to render a custom component in a cell.
+   */
   render?: VegaTableCellRenderFunction;
+  /**
+   * The breakpoint at which the column will be hidden.
+   */
   breakpoint?: VegaTableColumnBreakpoint;
+  /**
+   * Horizontal alignment of cell content within the column.
+   */
   align?: ColumnAlignType;
+  /**
+   * Fixed width dimension for the column (e.g., '200px' or '20%').
+   */
   width?: string;
+  /**
+   * Overflow behavior for content exceeding column boundaries.
+   */
   overflow?: 'ellipsis' | 'scroll';
   /**
    * Whether the table cell can be edited
    */
   editable?: boolean;
+  /**
+   * Pin column position (left or right side) for horizontal scrolling.
+   */
   pinned?: VegaTablePinnedType;
   /**
    * Editable table cell's form item type
@@ -66,6 +129,9 @@ export declare type VegaTableColumnConfig = {
    */
   renderFormItem?: VegaTableCellFormItemRenderFunction;
 };
+/**
+ * Type alias for composite column configurations (grouping or leaf models).
+ */
 export declare type VegaTableGroupColumnConfig = VegaTableColumnGroupingModel | VegaTableColumnGroupingLeafModel;
 /**
  * Represents a group header node in `groupColumns`.
@@ -102,8 +168,18 @@ export declare type VegaTableColumnGroupingLeafModel = {
    */
   key: string;
 };
+/**
+ * Responsive breakpoint values for controlling column visibility.
+ */
 export declare type VegaTableColumnBreakpoint = BreakpointsForPrefixType;
+/**
+ * Supported form component types for editable table cells.
+ */
 export declare type VegaTableFormItemType = 'input' | 'input-select' | 'stepper' | 'checkbox' | 'textarea' | 'combo-box' | 'date-picker' | 'time-picker';
+/**
+ * Callback function to generate form item properties based on table context.
+ * Provides form instance and row data for dynamic prop configuration.
+ */
 export declare type VegaTableFormItemProps = (form: HTMLVegaFormElement, 
 /**
  * record: current row data record
@@ -113,7 +189,13 @@ payload: {
   record: VegaTableDataSourceItem;
   index: number;
 }) => VegaTableEditComponentProps;
+/**
+ * Column sorting configuration supporting local comparators or remote sorting.
+ */
 export declare type VegaTableSorterConfig = VegaTableSortCompareFunction | 'event';
+/**
+ * Individual data record for table rows with flexible property support.
+ */
 export declare type VegaTableDataSourceItem = {
   /**
    * Use the `key` property to match data items with respective columns with the same `key` value.
@@ -121,12 +203,12 @@ export declare type VegaTableDataSourceItem = {
   key?: string;
 } & Record<string, unknown>;
 /**
- * The rowSelectionConfig of vega-table
- *
- * @property {boolean} hideSelectAll - Whether to hide the select all checkbox.
- * @property {'multiple' | 'single'} type - The type of selection. Currently, only checkbox is supported.
+ * Configuration for row selection behavior and event handling.
  */
 export declare type VegaTableRowSelectionConfig = {
+  /**
+   * Whether to hide the select all checkbox.
+   */
   hideSelectAll?: boolean;
   /**
    * deprecated 'checkbox' of type, use 'multiple' instead
@@ -141,22 +223,49 @@ export declare type VegaTableRowSelectionConfig = {
    */
   onSelectAllChange?: (selected: boolean, selectedRows: VegaTableDataSourceItem[]) => void;
 };
+/**
+ * Direction order for table column sorting.
+ */
 export declare type VegaTableSortOrderType = 'desc' | 'asc';
+/**
+ * Current sorting state of a column.
+ */
 export declare type VegaTableSorterType = {
   prop: string;
   order: VegaTableSortOrderType;
 };
+/**
+ * Payload containing changed table sorting and filtering state.
+ */
 export declare type VegaTableChangePropType = {
+  /**
+   * Array of current sorting configurations for columns.
+   */
   sorters?: VegaTableSorterType[];
 };
+/**
+ * Payload passed when a table row is clicked.
+ */
 export declare type VegaTableRowClickPropType = {
   record: VegaTableDataSourceItem;
   index: number;
 };
+/**
+ * Event details for row expansion state changes.
+ */
 export declare type VegaTableRowExpandEventDetail = {
+  /**
+   * The data record for the expanded/collapsed row.
+   */
   record: VegaTableDataSourceItem;
+  /**
+   * Whether the row is now expanded (true) or collapsed (false).
+   */
   expanded: boolean;
 };
+/**
+ * Payload for individual row selection state changes.
+ */
 export declare type VegaTableRowSelectProp = {
   /**
    * Row is selected or deselected
@@ -171,6 +280,9 @@ export declare type VegaTableRowSelectProp = {
    */
   selectedRows: VegaTableDataSourceItem[];
 };
+/**
+ * Payload for select-all action state changes.
+ */
 export declare type VegaTableSelectAllProp = {
   /**
    * Whether all row are selected
@@ -181,21 +293,48 @@ export declare type VegaTableSelectAllProp = {
    */
   selectedRows: VegaTableDataSourceItem[];
 };
+/**
+ * Internal properties of a table row element for rendering.
+ */
 export declare type VegaTableRowProps = {
+  /**
+   * Unique identifier for row tracking and selection.
+   */
   rowKey: string;
+  /**
+   * Zero-based index position of the row within visible data.
+   */
   index: number;
+  /**
+   * The data record associated with this row.
+   */
   record: VegaTableDataSourceItem;
+  /**
+   * Whether this is the last row in the data set.
+   */
   isLastRow: boolean;
+  /**
+   * Whether the row is visible in the current paginated view.
+   */
   isVisibleInCurrentPage?: boolean;
 };
+/**
+ * Props for editable table edit components.
+ */
 export declare type VegaTableEditComponentProps = {
+  /**
+   * Form element identifier for associating form controls.
+   */
   dataVegaForm?: string;
 } & Record<string, unknown>;
+/**
+ * Configuration for table scrolling behavior and fixed header/footer.
+ */
 export declare type VegaTableScrollConfig = {
   /**
-   * e.g.
-   * number: 100 -> will be translated to `100px`
-   * string: '100vh' | 'calc(100vh - 20px)'
+   * Maximum height for the table container (enables vertical scrolling).
+   * e.g. number: 100 -> will be translated to `100px`
+   * e.g. string: '100vh' | 'calc(100vh - 20px)'
    */
   maxHeight?: number | string;
   /**
@@ -207,43 +346,109 @@ export declare type VegaTableScrollConfig = {
    */
   fixedFooter?: boolean | undefined;
 };
+/**
+ * List of supported form field types for editable table cells.
+ */
 export declare const VegaTableEditableFieldTypes: VegaTableFormItemType[];
+/**
+ * Observer payload for table row expansion state changes.
+ */
 export declare type VegaTableExpandRowObserverPayload = {
+  /**
+   * Reference to the table row element.
+   */
   host: HTMLVegaTableRowElement;
+  /**
+   * Unique identifier of the expanded/collapsed row.
+   */
   rowKey: string;
+  /**
+   * Whether the row is currently expanded.
+   */
   expanded: boolean;
 };
+/**
+ * Observer payload for table row selection state changes.
+ */
 export declare type VegaTableRowSelectionObserverPayload = {
+  /**
+   * Reference to the table row element.
+   */
   host: HTMLVegaTableRowElement;
+  /**
+   * Unique identifier of the row whose selection changed.
+   */
   rowKey: string;
+  /**
+   * Whether the specific row is currently checked.
+   */
   checked?: boolean;
+  /**
+   * Whether no rows are currently checked.
+   */
   noneChecked?: boolean;
 };
+/**
+ * Observer payload for table row click events.
+ */
 export declare type VegaTableRowClickObserverPayload = {
+  /**
+   * Reference to the clicked table row element.
+   */
   host: HTMLVegaTableRowElement;
+  /**
+   * Unique identifier of the clicked row.
+   */
   rowKey: string;
 };
+/**
+ * Event details emitted when table header cell is clicked.
+ */
 export declare type VegaTableHeadCellClickEvent = {
+  /**
+   * The sort order applied after the click event.
+   */
   sortOrder: VegaTableSortOrderType;
 };
+/**
+ * Event details emitted when table row is clicked.
+ */
 export declare type VegaTableRowClickEvent = {
+  /**
+   * Unique identifier of the clicked row.
+   */
   rowKey: string;
 };
+/**
+ * Event details for table row expansion/collapse.
+ */
 export declare type VegaTableRowExpandEvent = {
+  /**
+   * Unique identifier of the expanded/collapsed row.
+   */
   rowKey: string;
+  /**
+   * Whether the row is now expanded (true) or collapsed (false).
+   */
   expanded: boolean;
 };
+/**
+ * Configuration for multi-column or single-column sorting behavior.
+ */
 export declare type VegaTableSortConfig = {
   /**
-   * Table columns sorting support
+   * Table columns sorting support: allow multiple columns or single column sorting.
    */
   type: 'multiple' | 'single';
   /**
    * Specifies whether the unsorted state is disabled in column sorting.
-   *  If set to true, only 'asc' and 'desc' sorting directions are allowed, preventing the table from returning to an unsorted state.
+   * If set to true, only 'asc' and 'desc' sorting directions are allowed, preventing the table from returning to an unsorted state.
    */
   disableUnsorted?: boolean;
 };
+/**
+ * Event details emitted when a single row's selection state changes.
+ */
 export declare type VegaTableRowSelectEventDetail = {
   /**
    * Row is selected or deselected
@@ -258,6 +463,9 @@ export declare type VegaTableRowSelectEventDetail = {
    */
   selectedRows: VegaTableDataSourceItem[];
 };
+/**
+ * Event details emitted when the select-all action changes selection state.
+ */
 export declare type VegaTableRowSelectAllEventDetail = {
   /**
    * Whether all rows are selected
@@ -272,7 +480,16 @@ export declare type VegaTableRowSelectAllEventDetail = {
    */
   changedRows: VegaTableDataSourceItem[];
 };
+/**
+ * Observer payload for table header cell interactions.
+ */
 export declare type TableHeadCellObserverPayload = {
+  /**
+   * Reference to the table header cell element.
+   */
   host: HTMLVegaTableHeadCellElement;
 };
+/**
+ * Column pinning position for horizontal scrolling layout.
+ */
 export declare type VegaTablePinnedType = 'left' | 'right';

package/dist/types/components/vega-table/vega-table-expand-row/types.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Payload for state changes on expandable rows.
+ */
 export type VegaTableExpandRowStateChangePayload = {
+	/**
+	 * Host element reference.
+	 */
 	host: HTMLVegaTableHeadRowElement;
 };

package/dist/types/components/vega-table/vega-table-foot/types.d.ts

@@ -1,4 +1,13 @@
+/**
+ * Payload emitted when the table foot state changes.
+ */
 export type VegaTableFootStateChangePayload = {
+	/**
+	 * Reference to the host element that triggered the event.
+	 */
 	host: HTMLVegaTableFootElement;
+	/**
+	 * Whether the footer is fixed in position.
+	 */
 	fixed?: boolean;
 };

package/dist/types/components/vega-table/vega-table-foot-row/types.d.ts

@@ -1,4 +1,13 @@
+/**
+ * Payload for state changes on a table foot row.
+ */
 export type VegaTableFootRowStateChangePayload = {
+	/**
+	 * Host element reference.
+	 */
 	host: HTMLVegaTableFootRowElement;
+	/**
+	 * Whether horizontal padding is applied.
+	 */
 	paddingX?: boolean;
 };

package/dist/types/components/vega-table/vega-table-head/types.d.ts

@@ -1,4 +1,13 @@
+/**
+ * Payload emitted when the table head state changes.
+ */
 export type VegaTableHeadStateChangePayload = {
+	/**
+	 * Host element reference.
+	 */
 	host: HTMLVegaTableHeadElement;
+	/**
+	 * Whether the header row is fixed.
+	 */
 	fixed?: boolean;
 };

package/dist/types/components/vega-table/vega-table-head-row/types.d.ts

@@ -1,5 +1,17 @@
+/**
+ * Event payload when a table head row's state changes.
+ */
 export type VegaTableHeadRowStateChangePayload = {
+	/**
+	 * Host element reference.
+	 */
 	host: HTMLVegaTableHeadRowElement;
+	/**
+	 * Whether the row can be expanded.
+	 */
 	expandable?: boolean;
+	/**
+	 * Whether horizontal padding is applied.
+	 */
 	paddingX?: boolean;
 };

package/dist/types/components/vega-table/vega-table-row/types.d.ts

@@ -1,7 +1,25 @@
+/**
+ * Event payload for table row state changes.
+ */
 export type VegaTableRowStateChangePayload = {
+	/**
+	 * Host element reference.
+	 */
 	host: HTMLVegaTableRowElement;
+	/**
+	 * Whether the row can be expanded.
+	 */
 	expandable?: boolean;
+	/**
+	 * Whether the row is clickable.
+	 */
 	clickable?: boolean;
+	/**
+	 * Whether horizontal padding is applied.
+	 */
 	paddingX?: boolean;
+	/**
+	 * Whether selection mode is active.
+	 */
 	selectionType?: boolean;
 };

package/dist/types/components/vega-text/types.d.ts

@@ -1 +1,7 @@
+/**
+ * Configuration properties for the tooltip used by the text component.
+ *
+ * Only the `placement` property from the underlying
+ * `HTMLVegaTooltipElement` is exposed.
+ */
 export type VegaTextTooltipProps = Partial<Pick<HTMLVegaTooltipElement, 'placement'>>;

package/dist/types/components/vega-time-picker/types.d.ts

@@ -1,21 +1,54 @@
 import { AmPm } from '../../types/general';
 import { DatePickerModeType, DatePickerValueType } from '../vega-date-picker/types';
 
+/**
+ * Data source categories used in the time picker dropdown.
+ */
 export type SourceType = 'hour' | 'minute' | 'amPm';
 
+/**
+ * Representation of a time value used by the picker.
+ */
 export type TimeValue = {
+	/**
+	 * Hour component (two-digit string).
+	 */
 	hour?: string;
+	/**
+	 * Minute component (two-digit string).
+	 */
 	minute?: string;
+	/**
+	 * AM/PM indicator.
+	 */
 	amPm?: AmPm;
 };
 
+/**
+ * Data source arrays provided to the time picker dropdown.
+ */
 export type TimePickerDropdownSource = {
+	/**
+	 * Available hour strings.
+	 */
 	hours: string[];
+	/**
+	 * Available minute strings.
+	 */
 	minutes: string[];
 };
 
+/**
+ * Identifies the start or end position in a time range.
+ */
 export type TimeRangeIndex = 'start' | 'end';
 
+/**
+ * Mode type alias reused from the date-picker component.
+ */
 export type TimePickerModeType = DatePickerModeType;
 
+/**
+ * Value type for the time picker, parameterised by mode.
+ */
 export type TimePickerValueType<T extends TimePickerModeType> = DatePickerValueType<T>;

package/dist/types/components/vega-virtual-scroll/types.d.ts

@@ -1,14 +1,43 @@
 import { DropdownSourceItem } from '../vega-dropdown/types';
 
+/**
+ * Item type consumed by the virtual scroll component (alias).
+ */
 export type SourceItemType = DropdownSourceItem;
 
+/**
+ * Scrolling modes supported by the virtual scroll component.
+ */
 export type VirtualScrollMode = 'normal' | 'virtual';
 
+/**
+ * Positioning configuration object used during virtual scroll calculations.
+ */
 export type VirtualScrollPositionConfig = {
+	/**
+	 * Starting index for the rendered window.
+	 */
 	startIndex: number;
+	/**
+	 * Index of the first item visible in the viewport.
+	 */
 	viewportStartIndex: number;
+	/**
+	 * Ending index for the rendered window.
+	 */
 	endIndex: number;
+	/**
+	 * Vertical translate offset in pixels.
+	 */
 	transformY: number;
 };
 
-export type VegaVirtualScrollToBottomEvent = { endIndex: number };
+/**
+ * Payload emitted when the virtual scroll reaches the bottom of the list.
+ */
+export type VegaVirtualScrollToBottomEvent = {
+	/**
+	 * The final item index reached at the bottom.
+	 */
+	endIndex: number;
+};

package/dist/types/components.d.ts

@@ -48,7 +48,7 @@ import { VegaModalBackdrop, VegaModalBackdropColor } from "./components/vega-mod
 import { VegaPageNotificationActionButtonConfig, VegaPageNotificationTypes } from "./components/vega-page-notification/types";
 import { DropdownPropsForPagination, VegaPaginationItemType, VegaPaginationLayoutType } from "./components/vega-pagination/types";
 import { PieChartOptions } from "./helpers/chart/pie-chart";
-import { VegaProgressTrackerDirectionType } from "./components/vega-progress-tracker/type";
+import { VegaProgressTrackerDirectionType, VegaProgressTrackerStepItem } from "./components/vega-progress-tracker/type";
 import { VegaRTEContent } from "./components/vega-rich-text-editor/dto/content-state";
 import { VegaRTEExtension } from "./components/vega-rich-text-editor/extensions/extension.abstract";
 import { VegaRichTextEditorImage, VegaRTESourceEditConfig, VegaRTEToolbarItem } from "./components/vega-rich-text-editor/interface";
@@ -3173,9 +3173,14 @@ export namespace Components {
           * Specifies an array of step subtitles for    the Progress Tracker component.  Each subtitle corresponds to a step in the    progression of the workflow or process.
           * @vegaVersion 1.3.0
          */
-        "steps": string[];
+        "steps": string[] | VegaProgressTrackerStepItem[];
     }
     interface VegaProgressTrackerStep {
+        /**
+          * If step is clickable.
+          * @vegaVersion 2.76.0
+         */
+        "clickable": boolean;
         /**
           * The unique key for the step.
           * @vegaVersion 2.73.0
@@ -9418,9 +9423,14 @@ declare namespace LocalJSX {
           * Specifies an array of step subtitles for    the Progress Tracker component.  Each subtitle corresponds to a step in the    progression of the workflow or process.
           * @vegaVersion 1.3.0
          */
-        "steps"?: string[];
+        "steps"?: string[] | VegaProgressTrackerStepItem[];
     }
     interface VegaProgressTrackerStep {
+        /**
+          * If step is clickable.
+          * @vegaVersion 2.76.0
+         */
+        "clickable"?: boolean;
         /**
           * The unique key for the step.
           * @vegaVersion 2.73.0