cps-ui-kit 0.140.0 → 0.141.0

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

@@ -2,24 +2,92 @@ import { ComponentRef, ElementRef, OnDestroy, OnInit, OnChanges, ViewContainerRe
 import { CpsColumnFilterCategoryOption, CpsColumnFilterMatchMode, CpsColumnFilterType } from '../cps-column-filter-types';
 import { TableColumnFilterComponent } from '../components/internal/table-column-filter/table-column-filter.component';
 import * as i0 from "@angular/core";
+/**
+ * CpsTableColumnFilterDirective is a filtering directive used to filter single or multiple columns in table.
+ * @group Directives
+ */
 export declare class CpsTableColumnFilterDirective implements OnInit, OnChanges, OnDestroy {
     private elementRef;
     private viewContainerRef;
+    /**
+     * Name of the column to be filtered.
+     * @group Props
+     */
     field: string | undefined;
+    /**
+     * Type of a filter in table, 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;
+    /**
+     * Maximum number of constraints.
+     * @group Props
+     */
     filterMaxConstraints: number;
+    /**
+     * 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-table/directives/cps-table-column-sortable.directive.d.ts

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

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

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

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

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

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

@@ -1,15 +1,48 @@
 import { EventEmitter, OnChanges } from '@angular/core';
 import { ControlValueAccessor, NgControl } from '@angular/forms';
 import * as i0 from "@angular/core";
+/**
+ * CpsTagComponent is used to categorize content.
+ * @group Components
+ */
 export declare class CpsTagComponent implements ControlValueAccessor, OnChanges {
     private _control;
+    /**
+     * Type of the tag. It can be security, classification or custom, has higher precedence over color.
+     * @group Props
+     */
     type: 'security' | 'classification' | 'custom';
+    /**
+     * Label of the tag.
+     * @group Props
+     */
     label: string;
+    /**
+     * Color of the tag.
+     * @group Props
+     */
     color: string;
+    /**
+     * Whether the tag should be disabled.
+     * @group Props
+     */
     disabled: boolean;
+    /**
+     * Whether the tag should be selectable.
+     * @group Props
+     */
     selectable: boolean;
+    /**
+     * Tag value.
+     * @group Props
+     */
     set value(value: boolean);
     get value(): boolean;
+    /**
+     * Callback to invoke on value change.
+     * @param {boolean} boolean - value change.
+     * @group Emits
+     */
     valueChanged: EventEmitter<boolean>;
     classesList: string[];
     tagColor: string;

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

@@ -2,32 +2,132 @@ import { ElementRef, EventEmitter, OnDestroy, OnInit } from '@angular/core';
 import { ControlValueAccessor, NgControl } from '@angular/forms';
 import { CpsTooltipPosition } from '../../directives/cps-tooltip.directive';
 import * as i0 from "@angular/core";
+/**
+ * CpsTextareaComponent is a textarea component.
+ * @group Components
+ */
 export declare class CpsTextareaComponent implements ControlValueAccessor, OnInit, OnDestroy {
     private _control;
     private _elementRef;
+    /**
+     * Label of the textarea.
+     * @group Props
+     */
     label: string;
+    /**
+     * Placeholder text for the textarea.
+     * @group Props
+     */
     placeholder: string;
+    /**
+     * Number of rows in the textarea.
+     * @group Props
+     */
     rows: number;
+    /**
+     * The cols attribute specifies the visible width of a textarea.
+     * @group Props
+     */
     cols: number;
+    /**
+     * Whether the textarea can auto focus.
+     * @group Props
+     */
     autofocus: boolean;
+    /**
+     * Bottom hint text for the textarea.
+     * @group Props
+     */
     hint: string;
+    /**
+     * Whether the textarea is disabled.
+     * @group Props
+     */
     disabled: boolean;
+    /**
+     * Width of the textarea, it can be of type number denoting pixels or string.
+     * @group Props
+     */
     width: number | string;
+    /**
+     * When enabled, a clear icon is displayed to clear the value.
+     * @group Props
+     */
     clearable: boolean;
+    /**
+     * Hides hint and validation errors.
+     * @group Props
+     */
     hideDetails: boolean;
+    /**
+     * Whether the textarea should have persistent clear icon.
+     * @group Props
+     */
     persistentClear: boolean;
+    /**
+     * Error message.
+     * @group Props
+     */
     error: string;
+    /**
+     * Whether the component can be resized vertically or not.
+     * @group Props
+     */
     resizable: 'vertical' | 'none';
+    /**
+     * 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;
+    /**
+     * Value of the textarea.
+     * @group Props
+     */
     set value(value: string);
     get value(): string;
+    /**
+     * Callback to invoke on value change.
+     * @param {string} string - value changed.
+     * @group Emits
+     */
     valueChanged: EventEmitter<string>;
+    /**
+     * Callback to invoke when the component receives focus.
+     * @param {any}
+     * @group Emits
+     */
     focused: EventEmitter<any>;
+    /**
+     * Callback to invoke when the prefixIcon is clicked.
+     * @param {any}
+     * @group Emits
+     */
     prefixIconClicked: EventEmitter<any>;
+    /**
+     * Callback to invoke when the component loses focus.
+     * @param {any}
+     * @group Emits
+     */
     blurred: EventEmitter<any>;
     private _statusChangesSubscription;
     private _value;

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

@@ -4,11 +4,27 @@ import { TreeNode } from 'primeng/api';
 import { CpsBaseTreeDropdownComponent } from '../internal/cps-base-tree-dropdown/cps-base-tree-dropdown.component';
 import * as i0 from "@angular/core";
 export type CpsTreeAutocompleteAppearanceType = 'outlined' | 'underlined' | 'borderless';
+/**
+ * CpsTreeAutocompleteComponent allows to choose items from hierarchical data dropdown and provides real-time suggestions when being typed.
+ * @group Components
+ */
 export declare class CpsTreeAutocompleteComponent extends CpsBaseTreeDropdownComponent implements OnInit, AfterViewInit, OnDestroy {
     control: NgControl;
     cdRef: ChangeDetectorRef;
+    /**
+     * Message if array of items is empty.
+     * @group Props
+     */
     emptyMessage: string;
+    /**
+     * Styling appearance of tree autocomplete, it can be 'outlined', 'underlined' or 'borderless'.
+     * @group Props
+     */
     appearance: CpsTreeAutocompleteAppearanceType;
+    /**
+     * Placeholder text.
+     * @group Props
+     */
     placeholder: string;
     inputText: string;
     backspaceClickedOnce: boolean;

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

@@ -3,10 +3,22 @@ import { NgControl } from '@angular/forms';
 import { CpsBaseTreeDropdownComponent } from '../internal/cps-base-tree-dropdown/cps-base-tree-dropdown.component';
 import * as i0 from "@angular/core";
 export type CpsTreeSelectAppearanceType = 'outlined' | 'underlined' | 'borderless';
+/**
+ * CpsTreeSelectComponent allows to select items from hierarchical data dropdown.
+ * @group Components
+ */
 export declare class CpsTreeSelectComponent extends CpsBaseTreeDropdownComponent implements OnInit, AfterViewInit, OnDestroy {
     control: NgControl;
     cdRef: ChangeDetectorRef;
+    /**
+     * Styling appearance of tree select, it can be "outlined", "underlined" or "borderless".
+     * @group Props
+     */
     appearance: CpsTreeSelectAppearanceType;
+    /**
+     * Placeholder text.
+     * @group Props
+     */
     placeholder: string;
     constructor(control: NgControl, cdRef: ChangeDetectorRef);
     ngOnInit(): void;