cps-ui-kit 0.140.0 → 0.141.0

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

@@ -4,40 +4,170 @@ import { IconType, iconSizeType } from '../cps-icon/cps-icon.component';
 import { CpsTooltipPosition } from '../../directives/cps-tooltip.directive';
 import * as i0 from "@angular/core";
 export type CpsInputAppearanceType = 'outlined' | 'underlined' | 'borderless';
+/**
+ * CpsInputComponent is used to enter values in a certain formats such as numeric, text or password.
+ * @group Components
+ */
 export declare class CpsInputComponent implements ControlValueAccessor, OnInit, AfterViewInit, OnDestroy {
     private _control;
     elementRef: ElementRef<HTMLElement>;
     private cdRef;
+    /**
+     * Label of the input element.
+     * @group Props
+     */
     label: string;
+    /**
+     * Bottom hint text for the input field.
+     * @group Props
+     */
     hint: string;
+    /**
+     * Placeholder text for the input field.
+     * @group Props
+     */
     placeholder: string;
+    /**
+     * Whether input is disabled.
+     * @group Props
+     */
     disabled: boolean;
+    /**
+     * Whether input is readonly.
+     * @group Props
+     */
     readonly: boolean;
+    /**
+     * Width of the input field, of type number denoting pixels or string.
+     * @group Props
+     */
     width: number | string;
+    /**
+     * Type of the input of type 'text', 'number' or 'password'.
+     * @group Props
+     */
     type: 'text' | 'number' | 'password';
+    /**
+     * When enabled, a loading bar is displayed.
+     * @group Props
+     */
     loading: boolean;
+    /**
+     * When enabled, a clear icon is displayed to clear the value.
+     * @group Props
+     */
     clearable: boolean;
+    /**
+     * Icon before input value.
+     * @group Props
+     */
     prefixIcon: IconType;
+    /**
+     * When enabled, prefixIcon is clickable.
+     * @group Props
+     */
     prefixIconClickable: boolean;
+    /**
+     * Size of icon before input value, of type number or string or it can be a value 'fill', 'xsmall', 'small', 'normal' or 'large'.
+     * @group Props
+     */
     prefixIconSize: iconSizeType;
+    /**
+     * Text before input value.
+     * @group Props
+     */
     prefixText: string;
+    /**
+     * Hides hint and validation errors.
+     * @group Props
+     */
     hideDetails: boolean;
+    /**
+     * Whether the component should have persistent clear icon.
+     * @group Props
+     */
     persistentClear: boolean;
+    /**
+     * Error message.
+     * @group Props
+     */
     error: string;
+    /**
+     * When it is not an empty string, an info icon is displayed to show text for more info.
+     * @group Props
+     */
     infoTooltip: string;
+    /**
+     * InfoTooltip 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;
+    /**
+     * Styling appearance of input field, it can be "outlined" or "underlined" or "borderless".
+     * @group Props
+     */
     appearance: CpsInputAppearanceType;
+    /**
+     * Readonly value to display inside of input field.
+     * @group Props
+     */
     valueToDisplay: string;
+    /**
+     * Value of the input.
+     * @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 prefix icon is clicked.
+     * @param {any}
+     * @group Emits
+     */
     prefixIconClicked: EventEmitter<any>;
+    /**
+     * Callback to invoke when the component loses focus.
+     * @param {any}
+     * @group Emits
+     */
     blurred: EventEmitter<any>;
+    /**
+     * Callback to invoke when x icon is clicked.
+     * @param {any}
+     * @group Emits
+     */
     cleared: EventEmitter<any>;
+    /**
+     * Callback to invoke when enter is clicked.
+     * @param {any}
+     * @group Emits
+     */
     enterClicked: EventEmitter<any>;
     prefixTextSpan: ElementRef | undefined;
     currentType: string;

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

@@ -1,9 +1,29 @@
 import { OnInit } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * CpsLoaderComponent is a fetch data indicator.
+ * @group Components
+ */
 export declare class CpsLoaderComponent implements OnInit {
+    /**
+     * Option for loader component to take up the whole screen.
+     * @group Props
+     */
     fullScreen: boolean;
+    /**
+     * Option to control the transparency of the loader component, of type number or string.
+     * @group Props
+     */
     opacity: number | string;
+    /**
+     * Color of the label.
+     * @group Props
+     */
     labelColor: string;
+    /**
+     * Whether to show 'Loading...' label.
+     * @group Props
+     */
     showLabel: boolean;
     backgroundColor: string;
     ngOnInit(): void;

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

@@ -16,6 +16,10 @@ export type CpsMenuItem = {
     disabled?: boolean;
 };
 export type CpsMenuAttachPosition = 'tr' | 'br' | 'tl' | 'bl' | 'default';
+/**
+ * CpsMenuComponent is a popup element, that contains menu items or arbitrary content.
+ * @group Components
+ */
 export declare class CpsMenuComponent implements OnInit, AfterViewInit, OnDestroy {
     private document;
     private platformId;
@@ -25,18 +29,70 @@ export declare class CpsMenuComponent implements OnInit, AfterViewInit, OnDestro
     private zone;
     config: PrimeNGConfig;
     overlayService: OverlayService;
+    /**
+     * Header title of the menu.
+     * @group Props
+     */
     header: string;
+    /**
+     * An array of menu items.
+     * @group Props
+     */
     items: CpsMenuItem[];
+    /**
+     * Whether to include top pointing arrow on the menu.
+     * @group Props
+     */
     withArrow: boolean;
+    /**
+     * Menu with prepared-colored items, without header and items description.
+     * @group Props
+     */
     compressed: boolean;
+    /**
+     * Whether the menu should show on target element focus.
+     * @group Props
+     */
     focusOnShow: boolean;
+    /**
+     * Whether the menu should be persistent.
+     * @group Props
+     */
     persistent: boolean;
+    /**
+     * Styling class of the menu container.
+     * @group Props
+     */
     containerClass: string;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     */
     hideTransitionOptions: string;
+    /**
+     * Callback to invoke when menu is shown.
+     * @group Emits
+     */
     menuShown: EventEmitter<any>;
+    /**
+     * Callback to invoke when menu is hidden.
+     * @group Emits
+     */
     menuHidden: EventEmitter<any>;
+    /**
+     * Callback to invoke before menu is hidden.
+     * @group Emits
+     */
     beforeMenuHidden: EventEmitter<any>;
+    /**
+     * Callback to invoke when content is clicked.
+     * @group Emits
+     */
     contentClicked: EventEmitter<any>;
     withIcons: boolean;
     autoZIndex: boolean;

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

@@ -1,14 +1,51 @@
 import { EventEmitter, OnInit } from '@angular/core';
 import { Paginator } from 'primeng/paginator';
 import * as i0 from "@angular/core";
+/**
+ * CpsPaginatorComponent is a generic component to display content in paged format.
+ * @group Components
+ */
 export declare class CpsPaginatorComponent implements OnInit {
+    /**
+     * Zero-relative number of the first row to be displayed.
+     * @group Props
+     */
     first: number;
+    /**
+     * Rows count to display per page.
+     * @group Props
+     */
     rows: number;
+    /**
+     * Number of total records.
+     * @group Props
+     */
     totalRecords: number;
+    /**
+     * Array of integer values to display inside rows per page dropdown.
+     * @group Props
+     */
     rowsPerPageOptions: number[];
+    /**
+     * Whether to show it even there is only one page.
+     * @group Props
+     */
     alwaysShow: boolean;
+    /**
+     * Color of paginator background.
+     * @group Props
+     */
     backgroundColor: string;
+    /**
+     * Whether to reset page index when the number of rows per page changes.
+     * @group Props
+     */
     resetPageOnRowsChange: boolean;
+    /**
+     * Callback to invoke when page changes, the event object contains information about the new state.
+     * @param {any} any - page changed.
+     * @group Emits
+     */
     pageChanged: EventEmitter<any>;
     paginator: Paginator;
     rowOptions: {

package/lib/components/cps-paginator/pipes/cps-paginate.pipe.d.ts

@@ -1,5 +1,9 @@
 import { PipeTransform } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * The CpsPaginatePipe is a pipe designed to provide a set of items in batches, taking into account specified pagination parameters.
+ * @group Pipes
+ */
 export declare class CpsPaginatePipe implements PipeTransform {
     transform(items: any[], config: {
         first: number;

package/lib/components/cps-progress-circular/cps-progress-circular.component.d.ts

@@ -1,8 +1,24 @@
 import { OnInit } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * CpsProgressCircularComponent is a process status indicator in a form of a spinner.
+ * @group Components
+ */
 export declare class CpsProgressCircularComponent implements OnInit {
+    /**
+     * Diameter of the progress bar, of type number denoting pixels or string.
+     * @group Props
+     */
     diameter: number | string;
+    /**
+     * Thickness of the progress bar, of type number denoting pixels or string.
+     * @group Props
+     */
     strokeWidth: number | string;
+    /**
+     * Color of the progress bar.
+     * @group Props
+     */
     color: string;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<CpsProgressCircularComponent, never>;

package/lib/components/cps-progress-linear/cps-progress-linear.component.d.ts

@@ -1,11 +1,39 @@
 import { OnInit } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * CpsProgressLinearComponent is a process status indicator of a rectangular form.
+ * @group Components
+ */
 export declare class CpsProgressLinearComponent implements OnInit {
+    /**
+     * Width of the progress bar, of type number denoting pixels or string.
+     * @group Props
+     */
     width: number | string;
+    /**
+     * Height of the progress bar, of type number denoting pixels or string.
+     * @group Props
+     */
     height: number | string;
+    /**
+     * Color of the progress bar.
+     * @group Props
+     */
     color: string;
+    /**
+     * Background color of the progress bar.
+     * @group Props
+     */
     bgColor: string;
+    /**
+     * Option to control the transparency of the progress bar, of type number or string.
+     * @group Props
+     */
     opacity: number | string;
+    /**
+     * Border radius of the progress bar, of type number or string.
+     * @group Props
+     */
     radius: number | string;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<CpsProgressLinearComponent, never>;

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

@@ -1,7 +1,15 @@
 import { OnInit } from '@angular/core';
 import { CpsRadioGroupComponent, CpsRadioOption } from '../cps-radio-group.component';
 import * as i0 from "@angular/core";
+/**
+ * CpsRadioComponent is a radio button with arbitrary content.
+ * @group Components
+ */
 export declare class CpsRadioComponent implements OnInit {
+    /**
+     * An option.
+     * @group Props
+     */
     option: CpsRadioOption;
     radioGroup?: CpsRadioGroupComponent;
     groupDisabled: boolean;

package/lib/components/cps-radio-group/cps-radio-button/cps-radio-button.component.d.ts

@@ -1,11 +1,32 @@
 import { EventEmitter } from '@angular/core';
 import { CpsRadioOption } from '../cps-radio-group.component';
 import * as i0 from "@angular/core";
+/**
+ * CpsRadioButtonComponent is an internal radio button component.
+ * @group Components
+ */
 export declare class CpsRadioButtonComponent {
     private _uniqueId;
+    /**
+     * An option.
+     * @group Props
+     */
     option: CpsRadioOption;
+    /**
+     * Whether the radio button is checked.
+     * @group Props
+     */
     checked: boolean;
+    /**
+     * Whether the radio button is disabled.
+     * @group Props
+     */
     groupDisabled: boolean;
+    /**
+     * Callback to invoke on value update.
+     * @param {Event} event - Custom update value event.
+     * @group Emits
+     */
     updateValueEvent: EventEmitter<Event>;
     get inputId(): string;
     updateValue(event: Event): void;

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

@@ -9,19 +9,68 @@ export type CpsRadioOption = {
     tooltip?: string;
 };
 export declare const CPS_RADIO_GROUP: InjectionToken<CpsRadioGroupComponent>;
+/**
+ * CpsRadioGroupComponent is a radio buttons group.
+ * @group Components
+ */
 export declare class CpsRadioGroupComponent implements ControlValueAccessor {
     private _control;
+    /**
+     * An array of options.
+     * @group Props
+     */
     options: CpsRadioOption[];
+    /**
+     * Label of the radio group.
+     * @group Props
+     */
     groupLabel: string;
+    /**
+     * Whether the radio group should be vertical.
+     * @group Props
+     */
     vertical: boolean;
+    /**
+     * Whether the radio group is disabled.
+     * @group Props
+     */
     disabled: boolean;
+    /**
+     * When it is not an empty string, an info icon is displayed to show text for more info.
+     * @group Props
+     */
     infoTooltip: string;
+    /**
+     * InfoTooltip class for styling.
+     * @group Props
+     */
     infoTooltipClass: string;
+    /**
+     * Size 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 radio group.
+     * @group Props
+     */
     set value(value: any);
     get value(): any;
+    /**
+     * Callback to invoke on value change.
+     * @param {boolean} boolean - value changed.
+     * @group Emits
+     */
     valueChanged: EventEmitter<boolean>;
     private _value;
     constructor(_control: NgControl);

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

@@ -6,41 +6,174 @@ import { CpsTooltipPosition } from '../../directives/cps-tooltip.directive';
 import { CpsMenuComponent } from '../cps-menu/cps-menu.component';
 import * as i0 from "@angular/core";
 export type CpsSelectAppearanceType = 'outlined' | 'underlined' | 'borderless';
+/**
+ * CpsSelectComponent is used to select items from a collection.
+ * @group Components
+ */
 export declare class CpsSelectComponent implements ControlValueAccessor, OnInit, AfterViewInit, OnDestroy {
     private _control;
+    /**
+     * The label of the select component.
+     * @group Props
+     */
     label: string;
+    /**
+     * Placeholder text for the select component.
+     * @group Props
+     */
     placeholder: string;
+    /**
+     * Bottom hint text for the select component.
+     * @group Props
+     */
     hint: string;
+    /**
+     * Returns the object directly rather than the value specified with optionValue.
+     * @group Props
+     */
     returnObject: boolean;
+    /**
+     * Specifies if multiple values can be selected.
+     * @group Props
+     */
     multiple: boolean;
+    /**
+     * Specifies whether the component is disabled.
+     * @group Props
+     */
     disabled: boolean;
+    /**
+     * Width of the select component, of type number denoting pixels or string.
+     * @group Props
+     */
     width: number | string;
+    /**
+     * Option for selecting all elements. Doesn't work with virtual scroll.
+     * @group Props
+     */
     selectAll: boolean;
+    /**
+     * When selecting elements, they 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 list should open on clear.
+     * @group Props
+     */
     openOnClear: boolean;
+    /**
+     * An array of options.
+     * @group Props
+     */
     options: any[];
+    /**
+     * Name of the label field of an option.
+     * @group Props
+     */
     optionLabel: string;
+    /**
+     * Name of the value field of an option. Needed only if returnObject prop is false.
+     * @group Props
+     */
     optionValue: string;
+    /**
+     * Name of the info field of an option, shows the additional information text.
+     * @group Props
+     */
     optionInfo: string;
+    /**
+     * Hides hint and validation errors.
+     * @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 or string or value '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;
+    /**
+     * InfoTooltip 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;
+    /**
+     * Class for additional styling of the dropdown list.
+     * @group Props
+     */
     optionsClass: string;
+    /**
+     * Styling appearance of select input, it can be 'outlined', 'underlined' or 'borderless'.
+     * @group Props
+     */
     appearance: CpsSelectAppearanceType;
+    /**
+     * Value of the select 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>;
     selectBox: ElementRef;
     selectContainer: ElementRef;