cps-ui-kit 17.9.0 → 17.10.0

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

@@ -6,6 +6,10 @@ import { VirtualScroller } from 'primeng/virtualscroller';
 import { CpsTooltipPosition } from '../../directives/cps-tooltip/cps-tooltip.directive';
 import { CpsMenuComponent } from '../cps-menu/cps-menu.component';
 import * as i0 from "@angular/core";
+/**
+ * CpsAutocompleteAppearanceType is used to define the border of the autocomplete input.
+ * @group Types
+ */
 export type CpsAutocompleteAppearanceType = 'outlined' | 'underlined' | 'borderless';
 /**
  * CpsAutocompleteComponent is an input component that provides real-time suggestions when being typed.

package/lib/components/cps-button-toggle/cps-button-toggle.component.d.ts

@@ -2,6 +2,10 @@ import { EventEmitter, OnInit, Renderer2 } from '@angular/core';
 import { ControlValueAccessor, NgControl } from '@angular/forms';
 import { CpsTooltipPosition } from '../../directives/cps-tooltip/cps-tooltip.directive';
 import * as i0 from "@angular/core";
+/**
+ * CpsButtonToggleOption is used to define the options of the CpsButtonToggleComponent.
+ * @group Types
+ */
 export type CpsButtonToggleOption = {
     value: any;
     label?: string;

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

@@ -4,6 +4,10 @@ import { CpsInputComponent } from '../cps-input/cps-input.component';
 import { CpsTooltipPosition } from '../../directives/cps-tooltip/cps-tooltip.directive';
 import { CpsMenuComponent } from '../cps-menu/cps-menu.component';
 import * as i0 from "@angular/core";
+/**
+ * CpsDatepickerAppearanceType is used to define the border of the datepicker input.
+ * @group Types
+ */
 export type CpsDatepickerAppearanceType = 'outlined' | 'underlined' | 'borderless';
 /**
  * CpsDatepickerComponent is an input component to provide date input.

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

@@ -1,7 +1,15 @@
 import { OnChanges } from '@angular/core';
 import * as i0 from "@angular/core";
 export declare const iconNames: string[];
+/**
+ * IconType is used to define the type of the icon.
+ * @group Types
+ */
 export type IconType = (typeof iconNames)[number];
+/**
+ * iconSizeType is used to define the size of the icon.
+ * @group Types
+ */
 export type iconSizeType = number | string | 'fill' | 'xsmall' | 'small' | 'normal' | 'large';
 /**
  * CpsIconComponent is a component that is used for icons.

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

@@ -3,6 +3,10 @@ import { ControlValueAccessor, NgControl } from '@angular/forms';
 import { IconType, iconSizeType } from '../cps-icon/cps-icon.component';
 import { CpsTooltipPosition } from '../../directives/cps-tooltip/cps-tooltip.directive';
 import * as i0 from "@angular/core";
+/**
+ * CpsInputAppearanceType is used to define the border of the input field.
+ * @group Types
+ */
 export type CpsInputAppearanceType = 'outlined' | 'underlined' | 'borderless';
 /**
  * CpsInputComponent is used to enter values in a certain formats such as numeric, text or password.

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

@@ -6,6 +6,10 @@ import { Subscription } from 'rxjs';
 import * as i0 from "@angular/core";
 type Nullable<T = void> = T | null | undefined;
 type VoidListener = () => void | null | undefined;
+/**
+ * CpsMenuItem is used to define the items of the CpsMenuComponent.
+ * @group Types
+ */
 export type CpsMenuItem = {
     title?: string;
     action?: (event?: any) => void;
@@ -16,6 +20,10 @@ export type CpsMenuItem = {
     disabled?: boolean;
     loading?: boolean;
 };
+/**
+ * CpsMenuAttachPosition is used to define attachment position of the CpsMenuComponent.
+ * @group Types
+ */
 export type CpsMenuAttachPosition = 'tr' | 'br' | 'tl' | 'bl' | 'default';
 /**
  * CpsMenuComponent is a popup element, that contains menu items or arbitrary content.

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

@@ -2,6 +2,10 @@ import { EventEmitter, InjectionToken, OnDestroy, OnInit } from '@angular/core';
 import { ControlValueAccessor, NgControl } from '@angular/forms';
 import { CpsTooltipPosition } from '../../directives/cps-tooltip/cps-tooltip.directive';
 import * as i0 from "@angular/core";
+/**
+ * CpsRadioOption is used to define the options of the CpsRadioGroupComponent.
+ * @group Types
+ */
 export type CpsRadioOption = {
     value: any;
     label?: string;

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

@@ -5,6 +5,10 @@ import { VirtualScroller } from 'primeng/virtualscroller';
 import { CpsTooltipPosition } from '../../directives/cps-tooltip/cps-tooltip.directive';
 import { CpsMenuComponent } from '../cps-menu/cps-menu.component';
 import * as i0 from "@angular/core";
+/**
+ * CpsSelectAppearanceType is used to define the border of the select input.
+ * @group Types
+ */
 export type CpsSelectAppearanceType = 'outlined' | 'underlined' | 'borderless';
 /**
  * CpsSelectComponent is used to select items from a collection.

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

@@ -2,6 +2,10 @@ import { OnInit, QueryList } from '@angular/core';
 import { Router } from '@angular/router';
 import { CpsMenuComponent, CpsMenuItem } from '../cps-menu/cps-menu.component';
 import * as i0 from "@angular/core";
+/**
+ * CpsSidebarMenuItem is used to define the items of the CpsSidebarMenuComponent.
+ * @group Types
+ */
 export type CpsSidebarMenuItem = {
     title: string;
     icon: string;

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

@@ -2,11 +2,29 @@ import { AfterContentInit, AfterViewInit, ChangeDetectorRef, ElementRef, EventEm
 import { CpsTabComponent } from './cps-tab/cps-tab.component';
 import { Subscription } from 'rxjs';
 import * as i0 from "@angular/core";
+/**
+ * CpsTabChangeEvent is used to define the tab change event.
+ * @group Interface
+ */
 export interface CpsTabChangeEvent {
+    /**
+     * Index of the previous tab.
+     */
     previousIndex: number;
+    /**
+     * Index of the new tab.
+     */
     newIndex: number;
 }
+/**
+ * CpsTabsAnimationType is used to define the transition options of how content appears.
+ * @group Types
+ */
 export type CpsTabsAnimationType = 'slide' | 'fade';
+/**
+ * CpsTabsAlignmentType is used to define the horizontal alignment of tabs.
+ * @group Types
+ */
 export type CpsTabsAlignmentType = 'left' | 'center' | 'right';
 /**
  * CpsTabGroupComponent is a navigation component that displays items as tab headers.

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

@@ -20,6 +20,10 @@ export declare enum CpsColumnFilterMatchMode {
     DATE_BEFORE = "dateBefore",
     DATE_AFTER = "dateAfter"
 }
+/**
+ * CpsColumnFilterCategoryOption is used to define the options of the CpsColumnFilterCategoryComponent.
+ * @group Types
+ */
 export type CpsColumnFilterCategoryOption = {
     value: any;
     label?: string;
@@ -27,4 +31,8 @@ export type CpsColumnFilterCategoryOption = {
     disabled?: boolean;
     tooltip?: string;
 };
+/**
+ * CpsColumnFilterType is used to define the type of the column filter.
+ * @group Types
+ */
 export type CpsColumnFilterType = 'text' | 'number' | 'date' | 'boolean' | 'category';

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

@@ -6,9 +6,25 @@ import { CpsMenuComponent, CpsMenuItem } from '../cps-menu/cps-menu.component';
 import { TableUnsortDirective } from './directives/internal/table-unsort.directive';
 import * as i0 from "@angular/core";
 export declare function tableFactory(tableComponent: CpsTableComponent): Table;
+/**
+ * CpsTableExportFormat is used to define the format of the exported file.
+ * @group Types
+ */
 export type CpsTableExportFormat = 'csv' | 'xlsx';
+/**
+ * CpsTableAppearanceType is used to define the border of the table.
+ * @group Types
+ */
 export type CpsTableSize = 'small' | 'normal' | 'large';
+/**
+ * CpsTableToolbarSize is used to define the size of the toolbar.
+ * @group Types
+ */
 export type CpsTableToolbarSize = 'small' | 'normal';
+/**
+ * CpsTableSortMode is used to define the sorting mode of the table.
+ * @group Types
+ */
 export type CpsTableSortMode = 'single' | 'multiple';
 /**
  * CpsTableComponent displays data in tabular format.

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

@@ -4,6 +4,10 @@ import { CpsButtonToggleOption } from '../cps-button-toggle/cps-button-toggle.co
 import { CpsAutocompleteComponent } from '../cps-autocomplete/cps-autocomplete.component';
 import { CpsTooltipPosition } from '../../directives/cps-tooltip/cps-tooltip.directive';
 import * as i0 from "@angular/core";
+/**
+ * CpsTime is used to define the time format.
+ * @group Interface
+ */
 export interface CpsTime {
     hours: string;
     minutes: string;

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

@@ -3,6 +3,10 @@ import { NgControl } from '@angular/forms';
 import { TreeNode } from 'primeng/api';
 import { CpsBaseTreeDropdownComponent } from '../internal/cps-base-tree-dropdown/cps-base-tree-dropdown.component';
 import * as i0 from "@angular/core";
+/**
+ * CpsTreeAutocompleteAppearanceType is used to define the border of the tree autocomplete input field.
+ * @group Types
+ */
 export type CpsTreeAutocompleteAppearanceType = 'outlined' | 'underlined' | 'borderless';
 /**
  * CpsTreeAutocompleteComponent allows to choose items from hierarchical data dropdown and provides real-time suggestions when being typed.

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

@@ -2,6 +2,10 @@ import { AfterViewInit, ChangeDetectorRef, OnDestroy, OnInit } from '@angular/co
 import { NgControl } from '@angular/forms';
 import { CpsBaseTreeDropdownComponent } from '../internal/cps-base-tree-dropdown/cps-base-tree-dropdown.component';
 import * as i0 from "@angular/core";
+/**
+ * CpsTreeSelectAppearanceType is used to define the border of the tree select input field.
+ * @group Types
+ */
 export type CpsTreeSelectAppearanceType = 'outlined' | 'underlined' | 'borderless';
 /**
  * CpsTreeSelectComponent allows to select items from hierarchical data dropdown.

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

@@ -5,8 +5,20 @@ import { CpsInputComponent } from '../cps-input/cps-input.component';
 import { CpsMenuComponent } from '../cps-menu/cps-menu.component';
 import * as i0 from "@angular/core";
 export declare function treeTableFactory(tableComponent: CpsTreeTableComponent): TreeTable;
+/**
+ * CpsTreeTableSize is used to define the size of the tree table.
+ * @group Types
+ */
 export type CpsTreeTableSize = 'small' | 'normal' | 'large';
+/**
+ * CpsTreeTableToolbarSize is used to define the size of the tree table toolbar.
+ * @group Types
+ */
 export type CpsTreeTableToolbarSize = 'small' | 'normal';
+/**
+ * CpsTreeTableSortMode is used to define the sorting mode of the tree table.
+ * @group Types
+ */
 export type CpsTreeTableSortMode = 'single' | 'multiple';
 /**
  * CpsTreeTableComponent is used to display hierarchical data in tabular format.

package/lib/directives/cps-tooltip/cps-tooltip.directive.d.ts

@@ -1,6 +1,14 @@
 import { ElementRef, OnDestroy } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * CpsTooltipPosition is used to define the position of the tooltip.
+ * @group Types
+ */
 export type CpsTooltipPosition = 'top' | 'bottom' | 'left' | 'right';
+/**
+ * CpsTooltipOpenOn is used to define the event on which the tooltip should open.
+ * @group Types
+ */
 export type CpsTooltipOpenOn = 'hover' | 'click' | 'focus';
 /**
  * CpsTooltipDirective provides advisory information for a target element.

package/lib/services/cps-notification/utils/cps-notification-config.d.ts

@@ -19,6 +19,10 @@ export declare enum CpsNotificationPosition {
     BOTTOMLEFT = "bottom-left",
     BOTTOMRIGHT = "bottom-right"
 }
+/**
+ * Configuration for the notification service.
+ * @group Interface
+ */
 export interface CpsNotificationConfig {
     /**
      * Position of the notification, options are "center", "top", "bottom", "left", "right", "top-left", "top-right", "bottom-left" or "bottom-right".

package/lib/services/cps-notification/utils/internal/cps-notification-data.d.ts

@@ -7,6 +7,10 @@ export declare enum CpsNotificationType {
     WARNING = "warning",
     INFO = "info"
 }
+/**
+ * Defines data type for the notification data.
+ * @group Interface
+ */
 export interface CpsNotificationData {
     /**
      * Message to be displayed in the notification.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cps-ui-kit",
-  "version": "17.9.0",
+  "version": "17.10.0",
   "peerDependencies": {
     "@angular/common": "^17.1.2",
     "@angular/core": "^17.1.2",