cps-ui-kit 0.140.0 → 0.141.0

package/lib/components/cps-sidebar-menu/cps-sidebar-menu.component.d.ts

@@ -10,12 +10,32 @@ export type CpsSidebarMenuItem = {
     disabled?: boolean;
     items?: CpsMenuItem[];
 };
+/**
+ * CpsSidebarMenuComponent is a vertical menu panel component displayed at the edge of the screen.
+ * @group Components
+ */
 export declare class CpsSidebarMenuComponent implements OnInit {
     private _router;
+    /**
+     * An array of menu items.
+     * @group Props
+     */
     items: CpsSidebarMenuItem[];
+    /**
+     * Indicates current expansion state of the sidebar.
+     * @group Props
+     */
     isExpanded: boolean;
+    /**
+     * Whether the menu items should allow activating only exact links.
+     * @group Props
+     */
     exactRoutes: boolean;
-    height: string;
+    /**
+     * Height of the sidebar, of type number denoting pixels or string.
+     * @group Props
+     */
+    height: number | string;
     allMenus?: QueryList<CpsMenuComponent>;
     constructor(_router: Router);
     ngOnInit(): void;

package/lib/components/cps-tab-group/cps-tab/cps-tab.component.d.ts

@@ -1,14 +1,54 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * CpsTabComponent is a tab within a tab-group.
+ * @group Components
+ */
 export declare class CpsTabComponent {
+    /**
+     * Label of the tab.
+     * @group Props
+     */
     label: string;
+    /**
+     * Icon before the label.
+     * @group Props
+     */
     icon: string;
+    /**
+     * Whether tab is disabled.
+     * @group Props
+     */
     disabled: boolean;
+    /**
+     * Whether to show the tooltip on tab hover.
+     * @group Props
+     */
     tooltipText: string;
+    /**
+     * Class for styling the tab tooltip.
+     * @group Props
+     */
     tooltipContentClass: string;
+    /**
+     * Max width of the tooltip, of type number denoting pixels or string.
+     * @group Props
+     */
     tooltipMaxWidth: number | string;
+    /**
+     * Whether the tooltip should have persistent info.
+     * @group Props
+     */
     tooltipPersistent: boolean;
+    /**
+     * Badge value to show on the tab after the label in a form of a circle.
+     * @group Props
+     */
     badgeValue: string;
+    /**
+     * Tooltip text to show on badge hover.
+     * @group Props
+     */
     badgeTooltip: string;
     content: TemplateRef<any>;
     active: boolean;

package/lib/components/cps-tab-group/cps-tab-group.component.d.ts

@@ -7,13 +7,43 @@ export interface TabChangeEvent {
     newTabIndex?: number;
 }
 export type CpsTabsAnimationType = 'slide' | 'fade';
+/**
+ * CpsTabGroupComponent is a navigation component that displays items as tab headers.
+ * @group Components
+ */
 export declare class CpsTabGroupComponent implements OnInit, AfterContentInit, AfterViewInit, OnDestroy {
     private cdRef;
+    /**
+     * Index of the selected tab.
+     * @group Props
+     */
     selectedIndex: number;
+    /**
+     * Whether to apply an alternative 'subtabs' styling.
+     * @group Props
+     */
     isSubTabs: boolean;
+    /**
+     * Transition options of how content appears, it can be "slide" or "fade".
+     * @group Props
+     */
     animationType: CpsTabsAnimationType;
+    /**
+     * Background styling of tabs.
+     * @group Props
+     */
     tabsBackground: string;
+    /**
+     * Callback to invoke before tab change.
+     * @param {TabChangeEvent} any - tab changed.
+     * @group Emits
+     */
     beforeTabChanged: EventEmitter<TabChangeEvent>;
+    /**
+     * Callback to invoke after tab change.
+     * @param {TabChangeEvent} any - tab changed.
+     * @group Emits
+     */
     afterTabChanged: EventEmitter<TabChangeEvent>;
     tabsList: ElementRef;
     backBtn?: ElementRef;

package/lib/components/cps-table/components/internal/table-column-filter/table-column-filter.component.d.ts

@@ -6,25 +6,93 @@ import { CpsColumnFilterCategoryOption, CpsColumnFilterMatchMode, CpsColumnFilte
 import { CpsMenuComponent } from '../../../../cps-menu/cps-menu.component';
 import { TableColumnFilterConstraintComponent } from '../table-column-filter-constraint/table-column-filter-constraint.component';
 import * as i0 from "@angular/core";
+/**
+ * TableColumnFilterComponent is an internal filter component in table and treetable.
+ * @group Components
+ */
 export declare class TableColumnFilterComponent implements OnInit, OnDestroy {
     elementRef: ElementRef;
     dt: Table;
     tt: TreeTable;
+    /**
+     * Name of the column to be filtered.
+     * @group Props
+     */
     field: string | undefined;
+    /**
+     * Type of filter in table, it can be of type "number", "boolean", "text", "date" or "category".
+     * @group Props
+     */
     type: CpsColumnFilterType;
+    /**
+     * Whether the filter menu should be persistent.
+     * @group Props
+     */
     persistent: boolean;
+    /**
+     * Whether the filter should have clear button.
+     * @group Props
+     */
     showClearButton: boolean;
+    /**
+     * Whether the filter should have apply button.
+     * @group Props
+     */
     showApplyButton: boolean;
+    /**
+     * Whether the filter should have close button.
+     * @group Props
+     */
     showCloseButton: boolean;
+    /**
+     * Whether the filter should have match modes.
+     * @group Props
+     */
     showMatchModes: boolean;
+    /**
+     * Match modes for filter.
+     * @group Props
+     */
     matchModes: CpsColumnFilterMatchMode[];
+    /**
+     * Whether the filter should have operator.
+     * @group Props
+     */
     showOperator: boolean;
+    /**
+     * Maximum number of constraints.
+     * @group Props
+     */
     maxConstraints: number;
+    /**
+     * Title of the filter.
+     * @group Props
+     */
     headerTitle: string;
+    /**
+     * Whether the filter should hide on clear.
+     * @group Props
+     */
     hideOnClear: boolean;
+    /**
+     * Options for category filter.
+     * @group Props
+     */
     categoryOptions: CpsColumnFilterCategoryOption[] | string[];
+    /**
+     * Whether to show category filter as button toggles.
+     * @group Props
+     */
     asButtonToggle: boolean;
+    /**
+     * Single selection for category filter.
+     * @group Props
+     */
     singleSelection: boolean;
+    /**
+     * Placeholder for filter constraints.
+     * @group Props
+     */
     placeholder: string;
     constraintCompList: QueryList<TableColumnFilterConstraintComponent>;
     operator: string;

package/lib/components/cps-table/components/internal/table-column-filter-constraint/table-column-filter-constraint.component.d.ts

@@ -6,16 +6,52 @@ import { CpsButtonToggleOption } from '../../../../cps-button-toggle/cps-button-
 import { CpsAutocompleteComponent } from '../../../../cps-autocomplete/cps-autocomplete.component';
 import { CpsColumnFilterCategoryOption, CpsColumnFilterType } from '../../../cps-column-filter-types';
 import * as i0 from "@angular/core";
+/**
+ * TableColumnFilterConstraintComponent is an internal filtering constraint component in table and treetable.
+ * @group Components
+ */
 export declare class TableColumnFilterConstraintComponent implements OnChanges {
     dt: Table;
     tt: TreeTable;
+    /**
+     * Type of filter constraint.
+     * @group Props
+     */
     type: CpsColumnFilterType;
+    /**
+     * Column name.
+     * @group Props
+     */
     field: string | undefined;
+    /**
+     * Constraint data.
+     * @group Props
+     */
     filterConstraint: FilterMetadata | undefined;
+    /**
+     * An array of category options.
+     * @group Props
+     */
     categoryOptions: CpsColumnFilterCategoryOption[] | string[];
+    /**
+     * Whether to show category filter as button toggles.
+     * @group Props
+     */
     asButtonToggle: boolean;
+    /**
+     * Single selection for category filter.
+     * @group Props
+     */
     singleSelection: boolean;
+    /**
+     * Placeholder for input field.
+     * @group Props
+     */
     placeholder: string;
+    /**
+     * Whether the filter should have an apply button.
+     * @group Props
+     */
     hasApplyButton: boolean;
     categoryAutocompleteComponent?: CpsAutocompleteComponent;
     booleanOptions: CpsButtonToggleOption[];

package/lib/components/cps-table/{table-row-menu → components/internal/table-row-menu}/table-row-menu.component.d.ts

@@ -1,8 +1,22 @@
 import { EventEmitter } from '@angular/core';
-import { CpsMenuItem } from '../../cps-menu/cps-menu.component';
+import { CpsMenuItem } from '../../../../cps-menu/cps-menu.component';
 import * as i0 from "@angular/core";
+/**
+ * TableRowMenuComponent is an internal component which applies the menu to each row.
+ * @group Components
+ */
 export declare class TableRowMenuComponent {
+    /**
+     * Callback to invoke when edit-row button is clicked.
+     * @param {any} any - button clicked.
+     * @group Emits
+     */
     editRowBtnClicked: EventEmitter<any>;
+    /**
+     * Callback to invoke when remove-row button is clicked.
+     * @param {any} any - button clicked.
+     * @group Emits
+     */
     removeRowBtnClicked: EventEmitter<any>;
     items: CpsMenuItem[];
     static ɵfac: i0.ɵɵFactoryDeclaration<TableRowMenuComponent, never>;

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

@@ -9,85 +9,389 @@ export type CpsTableExportFormat = 'csv' | 'xlsx';
 export type CpsTableSize = 'small' | 'normal' | 'large';
 export type CpsTableToolbarSize = 'small' | 'normal';
 export type CpsTableSortMode = 'single' | 'multiple';
+/**
+ * CpsTableComponent displays data in tabular format.
+ * @group Components
+ */
 export declare class CpsTableComponent implements OnInit, AfterViewChecked, OnChanges {
     private cdRef;
+    /**
+     * 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;
+    /**
+     * Whether the table should have alternating stripes.
+     * @group Props
+     */
     striped: boolean;
+    /**
+     * Whether the table should have borders.
+     * @group Props
+     */
     bordered: boolean;
+    /**
+     * Size of table cells, it can be "small", "normal" or "large".
+     * @group Props
+     */
     size: CpsTableSize;
+    /**
+     * Whether the table should have row selection.
+     * @group Props
+     */
     selectable: boolean;
+    /**
+     * Whether the table should have rows highlighting on hover.
+     * @group Props
+     */
     rowHover: boolean;
+    /**
+     * Field, that uniquely identifies a record in data (needed for expandable rows).
+     * @group Props
+     */
     dataKey: string;
+    /**
+     * Whether the table should show row menu.
+     * @group Props
+     */
     showRowMenu: boolean;
+    /**
+     * Whether the table should have re-orderable rows.
+     * @group Props
+     */
     reorderableRows: boolean;
+    /**
+     * When enabled, a loader component is displayed.
+     * @group Props
+     */
     loading: boolean;
+    /**
+     * Inline style of the table.
+     * @group Props
+     */
     tableStyle: undefined;
+    /**
+     * Style class of the table.
+     * @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: CpsTableSortMode;
+    /**
+     * Whether to use the default sorting or a custom one using sortFunction.
+     * @group Props
+     */
     customSort: boolean;
+    /**
+     * Whether the table has toolbar.
+     * @group Props
+     */
     hasToolbar: boolean;
+    /**
+     * Toolbar size, it can be "small" or "normal".
+     * @group Props
+     */
     toolbarSize: CpsTableToolbarSize;
+    /**
+     * Toolbar title.
+     * @group Props
+     */
     toolbarTitle: string;
+    /**
+     * Toolbar icon name.
+     * @group Props
+     */
     toolbarIcon: string;
+    /**
+     * Toolbar icon color.
+     * @group Props
+     */
     toolbarIconColor: string;
+    /**
+     * Makes table 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;
+    /**
+     * Determines how many additional elements to add to the DOM outside of the view.
+     * @group Props
+     */
     numToleratedItems: number;
+    /**
+     * Whether the table should have paginator.
+     * @group Props
+     */
     paginator: boolean;
+    /**
+     * Whether to show paginator even if 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 table 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 table'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 export button in the toolbar.
+     * @group Props
+     */
     showExportBtn: boolean;
+    /**
+     * Whether exportBtn is disabled.
+     * @group Props
+     */
     exportBtnDisabled: boolean;
+    /**
+     * Name of the exported file.
+     * @group Props
+     */
     exportFilename: string;
+    /**
+     * Character to use as the csv separator.
+     * @group Props
+     */
     csvSeparator: string;
+    /**
+     * Whether to show data reload button in the toolbar.
+     * @group Props
+     */
     showDataReloadBtn: boolean;
+    /**
+     * Whether dataReloadBtn is disabled.
+     * @group Props
+     */
     dataReloadBtnDisabled: boolean;
+    /**
+     * Whether the table 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 table. If not provided, all columns are initially visible.
+     * @group Props
+     */
     initialColumns: {
         [key: string]: any;
     }[];
+    /**
+     * Callback to invoke on selection changed.
+     * @param {any[]} value - selected data.
+     * @group Emits
+     */
     selectionChanged: EventEmitter<any[]>;
+    /**
+     * Callback to invoke when action button is clicked.
+     * @param {void} void - button clicked.
+     * @group Emits
+     */
     actionBtnClicked: EventEmitter<void>;
+    /**
+     * Callback to invoke when edit-row button is clicked.
+     * @param {any} any - button clicked.
+     * @group Emits
+     */
     editRowBtnClicked: EventEmitter<any>;
+    /**
+     * Callback to invoke on rows removal.
+     * @param {any[]} any[] - array of rows removed.
+     * @group Emits
+     */
     rowsRemoved: EventEmitter<any[]>;
+    /**
+     * Callback to invoke on page changed.
+     * @param {any} any - page changed.
+     * @group Emits
+     */
     pageChanged: EventEmitter<any>;
+    /**
+     * Callback to invoke when data is sorted.
+     * @param {any} any - sort meta.
+     * @group Emits
+     */
     sorted: EventEmitter<any>;
+    /**
+     * Callback to invoke when data is filtered.
+     * @param {any} any - custom filtering event.
+     * @group Emits
+     */
     filtered: EventEmitter<any>;
+    /**
+     * Callback to invoke when rows are reordered.
+     * @param {any} any - rows reordered.
+     * @group Emits
+     */
     rowsReordered: EventEmitter<any>;
+    /**
+     * Callback to invoke on columns selection.
+     * @param {object} object - selected column.
+     * @group Emits
+     */
     columnsSelected: EventEmitter<{
         [key: string]: any;
     }[]>;
+    /**
+     * Callback to invoke when paging, sorting or filtering happens in lazy mode.
+     * @param {any} any - custom lazy loading event.
+     * @group Emits
+     */
     lazyLoaded: EventEmitter<any>;
+    /**
+     * Callback to invoke when data-reload button is clicked.
+     * @param {any} any - button clicked.
+     * @group Emits
+     */
     dataReloadBtnClicked: EventEmitter<any>;
+    /**
+     * Callback to invoke when additional button on select is clicked.
+     * @param {any[]} any[] - selected data.
+     * @group Emits
+     */
     additionalBtnOnSelectClicked: EventEmitter<any[]>;
     /**
      * A function to implement custom sorting. customSort must be true.