cps-ui-kit 0.140.0 → 0.141.0

package/lib/components/cps-tree-table/cps-tree-table.component.d.ts

@@ -8,92 +8,399 @@ export declare function treeTableFactory(tableComponent: CpsTreeTableComponent):
 export type CpsTreeTableSize = 'small' | 'normal' | 'large';
 export type CpsTreeTableToolbarSize = 'small' | 'normal';
 export type CpsTreeTableSortMode = 'single' | 'multiple';
+/**
+ * CpsTreeTableComponent is used to display hierarchical data in tabular format.
+ * @group Components
+ */
 export declare class CpsTreeTableComponent implements OnInit, AfterViewInit, OnDestroy, AfterViewChecked, OnChanges {
     private cdRef;
     private renderer;
     private ngZone;
+    /**
+     * An array of objects to display.
+     * @group Props
+     */
     data: any[];
+    /**
+     * An array of objects to represent dynamic columns.
+     * @group Props
+     */
     columns: {
         [key: string]: any;
     }[];
+    /**
+     * A key used to retrieve the header from columns.
+     * @group Props
+     */
     colHeaderName: string;
+    /**
+     * A key used to retrieve the field from columns.
+     * @group Props
+     */
     colFieldName: string;
+    /**
+     * Treetable min width of type number denoting pixels or string.
+     * @group Props
+     */
     minWidth: number | string;
+    /**
+     * Whether minWidth prop is used for treetable body only, excluding toolbar and paginator.
+     * @group Props
+     */
     minWidthForBodyOnly: boolean;
     /**
      * Whether the cell widths scale according to their content or not.
      * @group Props
      */
     autoLayout: boolean;
+    /**
+     * Whether the treetable should have alternating stripes.
+     * @group Props
+     */
     striped: boolean;
+    /**
+     * Whether the treetable should have borders.
+     * @group Props
+     */
     bordered: boolean;
+    /**
+     * Size of treetable cells, it can be "small", "normal" or "large".
+     * @group Props
+     */
     size: CpsTreeTableSize;
+    /**
+     * Whether the treetable should have row selection.
+     * @group Props
+     */
     selectable: boolean;
+    /**
+     * Whether the treetable should have rows highlighting on hover.
+     * @group Props
+     */
     rowHover: boolean;
+    /**
+     * Whether the treetable should show row menu.
+     * @group Props
+     */
     showRowMenu: boolean;
+    /**
+     * When enabled, a loader component is displayed.
+     * @group Props
+     */
     loading: boolean;
+    /**
+     * Inline style of the treetable.
+     * @group Props
+     */
     tableStyle: undefined;
+    /**
+     * Style class of the treetable.
+     * @group Props
+     */
     tableStyleClass: string;
+    /**
+     * Makes all columns sortable if columns prop is provided.
+     * @group Props
+     */
     sortable: boolean;
+    /**
+     * Defines whether sorting works on single column or on multiple columns.
+     * @group Props
+     */
     sortMode: CpsTreeTableSortMode;
+    /**
+     * Whether to use the default sorting or a custom one using sortFunction.
+     * @group Props
+     */
     customSort: boolean;
+    /**
+     * Whether the treetable has toolbar.
+     * @group Props
+     */
     hasToolbar: boolean;
+    /**
+     * Toolbar size, it can be "small" or "normal".
+     * @group Props
+     */
     toolbarSize: CpsTreeTableToolbarSize;
+    /**
+     * Toolbar title.
+     * @group Props
+     */
     toolbarTitle: string;
+    /**
+     * Toolbar icon name.
+     * @group Props
+     */
     toolbarIcon: string;
+    /**
+     * Toolbar icon color.
+     * @group Props
+     */
     toolbarIconColor: string;
+    /**
+     * Makes treetable scrollable.
+     * @group Props
+     */
     scrollable: boolean;
+    /**
+     * Height of the scroll viewport in fixed pixels or the "flex" keyword for a dynamic size.
+     * @group Props
+     */
     scrollHeight: string;
+    /**
+     * Whether only the elements within scrollable area should be added into the DOM. Works only if scrollable prop is true.
+     * @group Props
+     */
     virtualScroll: boolean;
+    /**
+     * Height of a virtual scroll item in fixed pixels.
+     * @group Props
+     */
     virtualScrollItemHeight: number;
+    /**
+     * Determines how many additional elements to add to the DOM outside of the view.
+     * @group Props
+     */
     numToleratedItems: number;
+    /**
+     * Whether the treetable should have paginator.
+     * @group Props
+     */
     paginator: boolean;
+    /**
+     * Whether to show paginator even there is only one page.
+     * @group Props
+     */
     alwaysShowPaginator: boolean;
+    /**
+     * Array of integer values to display inside rows per page dropdown of paginator.
+     * @group Props
+     */
     rowsPerPageOptions: number[];
+    /**
+     * Index of the first row to be displayed.
+     * @group Props
+     */
     first: number;
+    /**
+     * Number of rows to display per page.
+     * @group Props
+     */
     rows: number;
+    /**
+     * Whether to reset page on rows change.
+     * @group Props
+     */
     resetPageOnRowsChange: boolean;
+    /**
+     * Whether to reset page on treetable data sorting.
+     * @group Props
+     */
     resetPageOnSort: boolean;
+    /**
+     * Number of total records.
+     * @group Props
+     */
     totalRecords: number;
+    /**
+     * Text to display when there is no data.
+     * @group Props
+     */
     emptyMessage: string;
+    /**
+     * Height of treetable's body when there is no data, of type number denoting pixels or string.
+     * @group Props
+     */
     emptyBodyHeight: number | string;
+    /**
+     * Defines if data is loaded and interacted with in lazy manner.
+     * @group Props
+     */
     lazy: boolean;
+    /**
+     * Whether to call lazy loading on initialization.
+     * @group Props
+     */
     lazyLoadOnInit: boolean;
+    /**
+     * Whether to show global filter in the toolbar.
+     * @group Props
+     */
     showGlobalFilter: boolean;
+    /**
+     * Global filter placeholder.
+     * @group Props
+     */
     globalFilterPlaceholder: string;
+    /**
+     * An array of fields to use in global filtering.
+     * @group Props
+     */
     globalFilterFields: string[];
+    /**
+     * Whether to clear global filter on data loading.
+     * @group Props
+     */
     clearGlobalFilterOnLoading: boolean;
+    /**
+     * Whether to show remove button in the toolbar when rows are selected.
+     * @group Props
+     */
     showRemoveBtnOnSelect: boolean;
+    /**
+     * Whether removeBtnOnSelect is disabled.
+     * @group Props
+     */
     removeBtnOnSelectDisabled: boolean;
+    /**
+     * Whether to show additional button in the toolbar when rows are selected.
+     * @group Props
+     */
     showAdditionalBtnOnSelect: boolean;
+    /**
+     * AdditionalBtnOnSelect title.
+     * @group Props
+     */
     additionalBtnOnSelectTitle: string;
+    /**
+     * Whether additionalBtnOnSelect is disabled.
+     * @group Props
+     */
     additionalBtnOnSelectDisabled: boolean;
+    /**
+     * Whether to show action button in the toolbar.
+     * @group Props
+     */
     showActionBtn: boolean;
+    /**
+     * Action button title.
+     * @group Props
+     */
     actionBtnTitle: string;
+    /**
+     * Whether actionBtn is disabled.
+     * @group Props
+     */
     actionBtnDisabled: boolean;
+    /**
+     * Whether to show data reload button in the toolbar.
+     * @group Props
+     */
     showDataReloadBtn: boolean;
+    /**
+     * Whether dataReloadBtn is disabled.
+     * @group Props
+     */
     dataReloadBtnDisabled: boolean;
+    /**
+     * Whether the treetable should show columnsToggle menu, where you can choose which columns to be displayed. If external body template is provided, use columnsSelected event emitter.
+     * @group Props
+     */
     showColumnsToggleBtn: boolean;
+    /**
+     * Whether columnsToggle button is disabled.
+     * @group Props
+     */
     columnsToggleBtnDisabled: boolean;
+    /**
+     * Array of initial columns to show in the treetable. If not provided, all columns are initially visible.
+     * @group Props
+     */
     initialColumns: {
         [key: string]: any;
     }[];
+    /**
+     * Callback to invoke on selected node change.
+     * @param {any[]} array - selection changed.
+     * @group Emits
+     */
     selectionChanged: EventEmitter<any[]>;
+    /**
+     * Callback to invoke when action button is clicked.
+     * @param {void} void - action button clicked.
+     * @group Emits
+     */
     actionBtnClicked: EventEmitter<void>;
+    /**
+     * Callback to invoke when additional button on select is clicked.
+     * @param {any[]} any[] - selected data.
+     * @group Emits
+     */
     additionalBtnOnSelectClicked: EventEmitter<any[]>;
+    /**
+     * Callback to invoke when edit-row button is clicked.
+     * @param {any} any - button clicked.
+     * @group Emits
+     */
     editRowBtnClicked: EventEmitter<any>;
+    /**
+     * Callback to invoke when rows are removed.
+     * @param {any} any - rows removed.
+     * @group Emits
+     */
     rowsRemoved: EventEmitter<any[]>;
+    /**
+     * Callback to invoke when page is changed.
+     * @param {any} any - page changed.
+     * @group Emits
+     */
     pageChanged: EventEmitter<any>;
+    /**
+     * Callback to invoke when data is sorted.
+     * @param {any} any - Sort data.
+     * @group Emits
+     */
     sorted: EventEmitter<any>;
+    /**
+     * Callback to invoke when data is filtered.
+     * @param {any} any - Custom filter event.
+     * @group Emits
+     */
     filtered: EventEmitter<any>;
+    /**
+     * Callback to invoke on selected columns.
+     * @param {any[]} object[] - selection changed.
+     * @group Emits
+     */
     columnsSelected: EventEmitter<{
         [key: string]: any;
     }[]>;
+    /**
+     * Callback to invoke when paging, sorting or filtering happens in lazy mode.
+     * @param {any} any - Custom lazy load event.
+     * @group Emits
+     */
     lazyLoaded: EventEmitter<any>;
+    /**
+     * Callback to invoke when data reload button is clicked.
+     * @param {any} any - data reload button clicked.
+     * @group Emits
+     */
     dataReloadBtnClicked: EventEmitter<any>;
+    /**
+     * Callback to invoke when a node is expanded.
+     * @param {any} any - Node instance.
+     * @group Emits
+     */
     nodeExpanded: EventEmitter<any>;
+    /**
+     * Callback to invoke when a node is collapsed.
+     * @param {any} any - Node collapse event.
+     * @group Emits
+     */
     nodeCollapsed: EventEmitter<any>;
+    /**
+     * Callback to invoke when a node is selected.
+     * @param {any} any - Node instance.
+     * @group Emits
+     */
     nodeSelected: EventEmitter<any>;
+    /**
+     * Callback to invoke when a node is unselected.
+     * @param {any} any - Custom node unselect event.
+     * @group Emits
+     */
     nodeUnselected: EventEmitter<any>;
     /**
      * A function to implement custom sorting. customSort must be true.

package/lib/components/cps-tree-table/directives/cps-tree-table-column-filter.directive.d.ts

@@ -2,23 +2,87 @@ import { ComponentRef, ElementRef, OnDestroy, OnInit, OnChanges, ViewContainerRe
 import { TableColumnFilterComponent } from '../../cps-table/components/internal/table-column-filter/table-column-filter.component';
 import { CpsColumnFilterType, CpsColumnFilterMatchMode, CpsColumnFilterCategoryOption } from '../../cps-table/cps-column-filter-types';
 import * as i0 from "@angular/core";
+/**
+ * CpsTreeTableColumnFilterDirective is a filtering directive used to filter single or multiple columns in treetable.
+ * @group Directives
+ */
 export declare class CpsTreeTableColumnFilterDirective implements OnInit, OnChanges, OnDestroy {
     private elementRef;
     private viewContainerRef;
+    /**
+     * Name of the column to be filtered.
+     * @group Props
+     */
     field: string | undefined;
+    /**
+     * Type of filter in treetable, it can be of type "number", "boolean", "text", "date" or "category".
+     * @group Props
+     */
     filterType: CpsColumnFilterType;
+    /**
+     * Whether the filter menu should be persistent.
+     * @group Props
+     */
     filterPersistent: boolean;
+    /**
+     * Whether the filter should have clear button.
+     * @group Props
+     */
     filterShowClearButton: boolean;
+    /**
+     * Whether the filter should have apply button.
+     * @group Props
+     */
     filterShowApplyButton: boolean;
+    /**
+     * Whether the filter should have close button.
+     * @group Props
+     */
     filterShowCloseButton: boolean;
+    /**
+     * Whether the filter should have match modes.
+     * @group Props
+     */
     filterShowMatchModes: boolean;
+    /**
+     * Match modes for filter.
+     * @group Props
+     */
     filterMatchModes: CpsColumnFilterMatchMode[];
+    /**
+     * Whether the filter should have operator.
+     * @group Props
+     */
     filterShowOperator: boolean;
+    /**
+     * Title of the filter.
+     * @group Props
+     */
     filterHeaderTitle: string;
+    /**
+     * Whether the filter should hide on clear.
+     * @group Props
+     */
     filterHideOnClear: boolean;
+    /**
+     * Options for category filter.
+     * @group Props
+     */
     filterCategoryOptions: CpsColumnFilterCategoryOption[] | string[];
+    /**
+     * Whether to show category filter as button toggles.
+     * @group Props
+     */
     filterAsButtonToggle: boolean;
+    /**
+     * Single selection for category filter.
+     * @group Props
+     */
     filterSingleSelection: boolean;
+    /**
+     * Placeholder for filter constraints.
+     * @group Props
+     */
     filterPlaceholder: string;
     filterCompRef: ComponentRef<TableColumnFilterComponent>;
     constructor(elementRef: ElementRef, viewContainerRef: ViewContainerRef);

package/lib/components/cps-tree-table/directives/cps-tree-table-column-sortable.directive.d.ts

@@ -2,10 +2,18 @@ import { ComponentRef, ElementRef, OnDestroy, OnInit, ViewContainerRef } from '@
 import { TTSortableColumn, TreeTable } from 'primeng/treetable';
 import { CpsSortIconComponent } from '../../cps-table/components/internal/cps-sort-icon/cps-sort-icon.component';
 import * as i0 from "@angular/core";
+/**
+ * CpsTreeTableColumnSortableDirective is a sorting directive used to sort single or multiple columns in treetable.
+ * @group Directives
+ */
 export declare class CpsTreeTableColumnSortableDirective extends TTSortableColumn implements OnInit, OnDestroy {
     private elementRef;
     private viewContainerRef;
     tt: TreeTable;
+    /**
+     * Name of the column to be sorted.
+     * @group Props
+     */
     field: string;
     sortIconRef: ComponentRef<CpsSortIconComponent>;
     constructor(elementRef: ElementRef, viewContainerRef: ViewContainerRef, tt: TreeTable);

package/lib/components/cps-tree-table/directives/cps-tree-table-header-selectable.directive.d.ts

@@ -1,6 +1,10 @@
 import { ComponentRef, ElementRef, OnDestroy, OnInit, ViewContainerRef } from '@angular/core';
 import { TTHeaderCheckbox } from 'primeng/treetable';
 import * as i0 from "@angular/core";
+/**
+ * CpsTreeTableHeaderSelectableDirective is a directive used to apply a checkbox to a header cell.
+ * @group Directives
+ */
 export declare class CpsTreeTableHeaderSelectableDirective implements OnInit, OnDestroy {
     private elementRef;
     private viewContainerRef;

package/lib/components/cps-tree-table/directives/cps-tree-table-row-selectable.directive.d.ts

@@ -1,9 +1,17 @@
 import { ComponentRef, ElementRef, OnDestroy, OnInit, ViewContainerRef } from '@angular/core';
 import { TTCheckbox } from 'primeng/treetable';
 import * as i0 from "@angular/core";
+/**
+ * CpsTreeTableRowSelectableDirective is a directive used to apply a checkbox to a body cell.
+ * @group Directives
+ */
 export declare class CpsTreeTableRowSelectableDirective implements OnInit, OnDestroy {
     private elementRef;
     private viewContainerRef;
+    /**
+     * Cell value.
+     * @group Props
+     */
     value: any;
     checkboxCompRef: ComponentRef<TTCheckbox>;
     constructor(elementRef: ElementRef, viewContainerRef: ViewContainerRef);

package/lib/components/cps-tree-table/directives/cps-tree-table-row-toggler.directive.d.ts

@@ -1,9 +1,17 @@
 import { ComponentRef, ElementRef, OnDestroy, OnInit, ViewContainerRef } from '@angular/core';
 import { TreeTableToggler } from 'primeng/treetable';
 import * as i0 from "@angular/core";
+/**
+ * CpsTreetableRowTogglerDirective is a directive used to apply a chevron toggler icon to a body cell.
+ * @group Directives
+ */
 export declare class CpsTreetableRowTogglerDirective implements OnInit, OnDestroy {
     private elementRef;
     private viewContainerRef;
+    /**
+     * Cell value.
+     * @group Props
+     */
     rowNode: any;
     togglerCompRef: ComponentRef<TreeTableToggler>;
     constructor(elementRef: ElementRef, viewContainerRef: ViewContainerRef);

package/lib/components/internal/cps-base-tree-dropdown/cps-base-tree-dropdown.component.d.ts

@@ -6,39 +6,156 @@ import { IconType, iconSizeType } from '../../cps-icon/cps-icon.component';
 import { CpsTooltipPosition } from '../../../directives/cps-tooltip.directive';
 import { CpsMenuComponent } from '../../cps-menu/cps-menu.component';
 import * as i0 from "@angular/core";
+/**
+ * BaseTreeDropdownComponent is an internal base component to support hierarchical data dropdown.
+ * @group Components
+ */
 export declare class CpsBaseTreeDropdownComponent implements ControlValueAccessor, OnInit, AfterViewInit, OnDestroy {
     control: NgControl;
     cdRef: ChangeDetectorRef;
+    /**
+     * Label of the component.
+     * @group Props
+     */
     label: string;
+    /**
+     * Bottom hint text.
+     * @group Props
+     */
     hint: string;
+    /**
+     * Specifies if multiple values can be selected.
+     * @group Props
+     */
     multiple: boolean;
+    /**
+     * Whether the component is disabled.
+     * @group Props
+     */
     disabled: boolean;
+    /**
+     * Width of the component, of type number denoting pixels or string.
+     * @group Props
+     */
     width: number | string;
+    /**
+     * When selecting an element, it will appear in a form of a chip.
+     * @group Props
+     */
     chips: boolean;
+    /**
+     * Whether the chips can be directly removed.
+     * @group Props
+     */
     closableChips: boolean;
+    /**
+     * When enabled, a clear icon is displayed to clear the value.
+     * @group Props
+     */
     clearable: boolean;
+    /**
+     * Whether the dropdown should open on clear.
+     * @group Props
+     */
     openOnClear: boolean;
+    /**
+     * Name of the label field of an option.
+     * @group Props
+     */
     optionLabel: string;
+    /**
+     * Name of the info field of an option, shows the additional information text.
+     * @group Props
+     */
     optionInfo: string;
+    /**
+     * Options for hiding details.
+     * @group Props
+     */
     hideDetails: boolean;
+    /**
+     * Whether the component should have persistent clear icon.
+     * @group Props
+     */
     persistentClear: boolean;
+    /**
+     * Icon before input value.
+     * @group Props
+     */
     prefixIcon: IconType;
+    /**
+     * Size of icon before input value, of type number, string, 'fill', 'xsmall', 'small', 'normal' or 'large'.
+     * @group Props
+     */
     prefixIconSize: iconSizeType;
+    /**
+     * When enabled, a loading bar is displayed.
+     * @group Props
+     */
     loading: boolean;
+    /**
+     * Whether only the elements within scrollable area should be added into the DOM.
+     * @group Props
+     */
     virtualScroll: boolean;
+    /**
+     * Determines how many additional elements to add to the DOM outside of the view.
+     * @group Props
+     */
     numToleratedItems: number;
+    /**
+     * When it is not an empty string, an info icon is displayed to show text for more info.
+     * @group Props
+     */
     infoTooltip: string;
+    /**
+     * Info tooltip class for styling.
+     * @group Props
+     */
     infoTooltipClass: string;
+    /**
+     * Max width of infoTooltip of type number denoting pixels or string.
+     * @group Props
+     */
     infoTooltipMaxWidth: number | string;
+    /**
+     * Whether the infoTooltip is persistent.
+     * @group Props
+     */
     infoTooltipPersistent: boolean;
+    /**
+     * Position of infoTooltip, it can be 'top', 'bottom', 'left' or 'right'.
+     * @group Props
+     */
     infoTooltipPosition: CpsTooltipPosition;
+    /**
+     * When set, it expands all directiories initially.
+     * @group Props
+     */
     initialExpandDirectories: boolean;
+    /**
+     * When set, it expands all options initially.
+     * @group Props
+     */
     initialExpandAll: boolean;
+    /**
+     * An array of objects to display as the available options.
+     * @group Props
+     */
     set options(options: any[]);
     get options(): TreeNode[];
+    /**
+     * Value of the component.
+     * @group Props
+     */
     _value: any;
     set value(value: any);
     get value(): any;
+    /**
+     * Callback to invoke on value change.
+     * @param {any} any - value changed.
+     * @group Emits
+     */
     valueChanged: EventEmitter<any>;
     componentContainer: ElementRef;
     optionsMenu: CpsMenuComponent;