cax-design-system 2.8.2 → 2.8.4

package/api/lazyloadevent.d.ts

@@ -0,0 +1,47 @@
+import { FilterMetadata } from './filtermetadata';
+import { SortMeta } from './sortmeta';
+/**
+ * Represents an event object for lazy loading data.
+ * @group Interface
+ */
+export interface LazyLoadEvent {
+    /**
+     * The index of the first record to be loaded.
+     */
+    first?: number;
+    /**
+     * The index of the last record to be loaded.
+     */
+    last?: number;
+    /**
+     * The number of rows to load.
+     */
+    rows?: number;
+    /**
+     * The field to be used for sorting.
+     */
+    sortField?: string;
+    /**
+     * The sort order for the field.
+     */
+    sortOrder?: number;
+    /**
+     * An array of sort metadata objects for multiple column sorting.
+     */
+    multiSortMeta?: SortMeta[];
+    /**
+     * An object containing filter metadata for filtering the data.
+     * The keys represent the field names, and the values represent the corresponding filter metadata.
+     */
+    filters?: {
+        [s: string]: FilterMetadata;
+    };
+    /**
+     * The global filter value for filtering across all columns.
+     */
+    globalFilter?: any;
+    /**
+     * A function that can be called to force an update in the lazy loaded data.
+     */
+    forceUpdate?: () => void;
+}

package/api/lazyloadmeta.d.ts

@@ -0,0 +1,19 @@
+import { FilterMetadata } from './filtermetadata';
+import { SortMeta } from './sortmeta';
+/**
+ * Meta data for lazy load event.
+ * @group Interface
+ */
+export interface LazyLoadMeta {
+    first?: number | undefined | null;
+    rows?: number | undefined | null;
+    sortField?: string | string[] | null | undefined;
+    sortOrder?: number | undefined | null;
+    filters?: {
+        [s: string]: FilterMetadata | FilterMetadata[] | undefined;
+    };
+    globalFilter?: string | string[] | undefined | null;
+    multiSortMeta?: SortMeta[] | undefined | null;
+    forceUpdate?: Function;
+    last?: number | undefined | null;
+}

package/api/megamenuitem.d.ts

@@ -0,0 +1,130 @@
+import { QueryParamsHandling } from '@angular/router';
+import { MenuItem } from './menuitem';
+/**
+ * MegaMenuItem API provides the following properties.
+ * @group Interface
+ */
+export interface MegaMenuItem {
+    /**
+     * Text of the item.
+     */
+    label?: string;
+    /**
+     * Icon of the item.
+     */
+    icon?: string;
+    /**
+     * Callback to execute when item is clicked.
+     */
+    command?: (event?: any) => void;
+    /**
+     * External link to navigate when item is clicked.
+     */
+    url?: string;
+    /**
+     * An array of children menuitems.
+     */
+    items?: MenuItem[][];
+    /**
+     * Specifies whether the mega menu item is expanded.
+     */
+    expanded?: boolean;
+    /**
+     * When set as true, disables the menuitem.
+     */
+    disabled?: boolean;
+    /**
+     * Whether the dom element of menuitem is created or not.
+     */
+    visible?: boolean;
+    /**
+     * Specifies where to open the linked document.
+     */
+    target?: string;
+    /**
+     * Configuration for active router link.
+     */
+    routerLinkActiveOptions?: any;
+    /**
+     * Defines the item as a separator.
+     */
+    separator?: boolean;
+    /**
+     * Value of the badge.
+     */
+    badge?: string;
+    /**
+     * Style class of the badge.
+     */
+    badgeStyleClass?: string;
+    /**
+     * Inline style of the menuitem.
+     */
+    style?: any;
+    /**
+     * Style class of the menuitem.
+     */
+    styleClass?: string;
+    /**
+     * Inline style of the item's icon.
+     */
+    iconStyle?: any;
+    /**
+     * Tooltip text of the item.
+     */
+    title?: string;
+    /**
+     * Identifier of the element.
+     */
+    id?: string;
+    /**
+     * Value of HTML data-* attribute.
+     */
+    automationId?: any;
+    /**
+     * Specifies tab order of the item.
+     */
+    tabindex?: string;
+    /**
+     * RouterLink definition for internal navigation.
+     */
+    routerLink?: any;
+    /**
+     * Query parameters for internal navigation via routerLink.
+     */
+    queryParams?: {
+        [k: string]: any;
+    };
+    /**
+     * Sets the hash fragment for the URL.
+     */
+    fragment?: string;
+    /**
+     *  How to handle query parameters in the router link for the next navigation. One of:
+        merge : Merge new with current parameters.
+        preserve : Preserve current parameters.k.
+     */
+    queryParamsHandling?: QueryParamsHandling;
+    /**
+     * When true, preserves the URL fragment for the next navigation.
+     */
+    preserveFragment?: boolean;
+    /**
+     * When true, navigates without pushing a new state into history.
+     */
+    skipLocationChange?: boolean;
+    /**
+     * When true, navigates while replacing the current state in history.
+     */
+    replaceUrl?: boolean;
+    /**
+     * Developer-defined state that can be passed to any navigation.
+     */
+    state?: {
+        [k: string]: any;
+    };
+    /**
+     * Optional
+     */
+    [key: string]: any;
+}

package/api/menuitem.d.ts

@@ -0,0 +1,176 @@
+import { QueryParamsHandling } from '@angular/router';
+import { MegaMenuItem } from './megamenuitem';
+import { TooltipOptions } from './tooltipoptions';
+/**
+ * MenuItem provides the following properties. Note that not all of them may be utilized by the tabmenu component.
+ * @group Interface
+ */
+export interface MenuItem {
+    /**
+     * Text of the item.
+     */
+    label?: string;
+    /**
+     * Icon of the item.
+     */
+    icon?: string;
+    /**
+     * Callback to execute when item is clicked.
+     */
+    command?(event: MenuItemCommandEvent): void;
+    /**
+     * External link to navigate when item is clicked.
+     */
+    url?: string;
+    /**
+     * An array of children menuitems.
+     */
+    items?: MenuItem[];
+    /**
+     * Visibility of submenu.
+     */
+    expanded?: boolean;
+    /**
+     * When set as true, disables the menuitem.
+     */
+    disabled?: boolean;
+    /**
+     * Whether the dom element of menuitem is created or not.
+     */
+    visible?: boolean;
+    /**
+     * Specifies where to open the linked document.
+     */
+    target?: string;
+    /**
+     * Whether to escape the label or not. Set to false to display html content.
+     */
+    escape?: boolean;
+    /**
+     * Configuration for active router link.
+     */
+    routerLinkActiveOptions?: any;
+    /**
+     * Defines the item as a separator.
+     */
+    separator?: boolean;
+    /**
+     * Value of the badge.
+     */
+    badge?: string;
+    /**
+     * Tooltip of the item.
+     */
+    tooltip?: string;
+    /**
+     * Position of the tooltip item.
+     */
+    tooltipPosition?: string;
+    /**
+     * Style class of the badge.
+     */
+    badgeStyleClass?: string;
+    /**
+     * Inline style of the menuitem.
+     */
+    style?: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the menuitem.
+     */
+    styleClass?: string;
+    /**
+     * Tooltip text of the item.
+     */
+    title?: string;
+    /**
+     * Identifier of the element.
+     */
+    id?: string;
+    /**
+     * Value of HTML data-* attribute.
+     */
+    automationId?: any;
+    /**
+     * Specifies tab order of the item.
+     */
+    tabindex?: string;
+    /**
+     * RouterLink definition for internal navigation.
+     */
+    routerLink?: any;
+    /**
+     * Query parameters for internal navigation via routerLink.
+     */
+    queryParams?: {
+        [k: string]: any;
+    };
+    /**
+     * Sets the hash fragment for the URL.
+     */
+    fragment?: string;
+    /**
+     *  How to handle query parameters in the router link for the next navigation. One of:
+        merge : Merge new with current parameters.
+        preserve : Preserve current parameters.k.
+     */
+    queryParamsHandling?: QueryParamsHandling;
+    /**
+     * When true, preserves the URL fragment for the next navigation.
+     */
+    preserveFragment?: boolean;
+    /**
+     * When true, navigates without pushing a new state into history.
+     */
+    skipLocationChange?: boolean;
+    /**
+     * When true, navigates while replacing the current state in history.
+     */
+    replaceUrl?: boolean;
+    /**
+     * Inline style of the item's icon.
+     */
+    iconStyle?: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the item's icon.
+     */
+    iconClass?: string;
+    /**
+     * Developer-defined state that can be passed to any navigation.
+     * @see {MenuItemState}
+     */
+    state?: {
+        [k: string]: any;
+    };
+    /**
+     * Options of the item's tooltip.
+     * @see {TooltipOptions}
+     */
+    tooltipOptions?: TooltipOptions;
+    /**
+     * Optional
+     */
+    [key: string]: any;
+}
+/**
+ * Custom command event
+ * @see {@link MenuItem.command}
+ * @group Events
+ */
+export interface MenuItemCommandEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected menu item.
+     */
+    item?: MenuItem | MegaMenuItem;
+    /**
+     * Index of the selected item.
+     */
+    index?: number;
+}

package/api/message.d.ts

@@ -0,0 +1,30 @@
+import { MenuItemCommandEvent } from './menuitem';
+/**
+ * Deines valid options for the message.
+ * @group Interface
+ */
+export interface ActionButtonItem {
+    label?: string;
+    disabled?: boolean;
+    command?(event: MenuItemCommandEvent): void;
+    outlined?: boolean;
+}
+export interface Message {
+    severity?: string;
+    summary?: string;
+    detail?: string;
+    id?: any;
+    key?: string;
+    life?: number;
+    sticky?: boolean;
+    closable?: boolean;
+    data?: any;
+    icon?: string;
+    contentStyleClass?: string;
+    styleClass?: string;
+    closeIcon?: string;
+    size?: 'sm' | 'md' | 'lg';
+    displayIcon?: boolean;
+    actionButtons?: ActionButtonItem[];
+    action?: ActionButtonItem;
+}

package/api/messageservice.d.ts

@@ -0,0 +1,32 @@
+import { Message } from './message';
+import * as i0 from "@angular/core";
+/**
+ * Message service used in messages and toast components.
+ * @group Service
+ */
+export declare class MessageService {
+    private messageSource;
+    private clearSource;
+    messageObserver: import("rxjs").Observable<Message | Message[]>;
+    clearObserver: import("rxjs").Observable<string>;
+    /**
+     * Inserts single message.
+     * @param {Message} message - Message to be added.
+     * @group Method
+     */
+    add(message: Message): void;
+    /**
+     * Inserts new messages.
+     * @param {Message[]} messages - Messages to be added.
+     * @group Method
+     */
+    addAll(messages: Message[]): void;
+    /**
+     * Clears the message with the given key.
+     * @param {string} key - Key of the message to be cleared.
+     * @group Method
+     */
+    clear(key?: string): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MessageService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<MessageService>;
+}

package/api/overlayoptions.d.ts

@@ -0,0 +1,188 @@
+import { AnimationEvent } from '@angular/animations';
+/**
+ * Represents the type of overlay mode, which can be 'modal', 'overlay', or undefined.
+ * @group Types
+ */
+export type OverlayModeType = 'modal' | 'overlay' | undefined;
+/**
+ * Represents the type of direction for a responsive overlay, which can be one of the specified values or undefined.
+ * @group Types
+ */
+export type ResponsiveOverlayDirectionType = 'center' | 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end' | undefined;
+/**
+ * Represents the options for an overlay listener.
+ * @group Interface
+ */
+export interface OverlayListenerOptions {
+    /**
+     * The type of listener, which can be 'scroll', 'outside', 'resize', or undefined.
+     */
+    type?: 'scroll' | 'outside' | 'resize' | undefined;
+    /**
+     * The mode of the overlay listener.
+     */
+    mode?: OverlayModeType;
+    /**
+     * Indicates whether the overlay listener is valid.
+     */
+    valid?: boolean;
+}
+/**
+ * Represents the options for a responsive overlay.
+ * @group Events
+ */
+export interface ResponsiveOverlayOptions {
+    /**
+     * The inline style for the responsive overlay.
+     */
+    style?: any;
+    /**
+     * The CSS class for the responsive overlay.
+     */
+    styleClass?: string;
+    /**
+     * The inline style for the content of the responsive overlay.
+     */
+    contentStyle?: any;
+    /**
+     * The CSS class for the content of the responsive overlay.
+     */
+    contentStyleClass?: string;
+    /**
+     * The breakpoint for the responsive overlay.
+     */
+    breakpoint?: string;
+    /**
+     * The media query for the responsive overlay.
+     */
+    media?: string;
+    /**
+     * The direction for the responsive overlay.
+     */
+    direction?: ResponsiveOverlayDirectionType;
+}
+/**
+ * Represents an event that occurs when an overlay is shown.
+ * @group Events
+ */
+export interface OverlayOnShowEvent {
+    /**
+     * The overlay element.
+     */
+    overlay?: HTMLElement | undefined;
+    /**
+     * The target element.
+     */
+    target?: HTMLElement | undefined;
+    /**
+     * The mode of the overlay.
+     */
+    mode?: OverlayModeType;
+}
+/**
+ * Represents an event that occurs before an overlay is shown.
+ * @extends {OverlayOnShowEvent}
+ * @group Events
+ */
+export interface OverlayOnBeforeShowEvent extends OverlayOnShowEvent {
+}
+/**
+ * Represents an event that occurs before an overlay is hidden.
+ * @extends {OverlayOnBeforeShowEvent}
+ * @group Events
+ */
+export interface OverlayOnBeforeHideEvent extends OverlayOnBeforeShowEvent {
+}
+/**
+ * Represents an event that occurs when an overlay is hidden.
+ * @extends {OverlayOnShowEvent}
+ * @group Events
+ */
+export interface OverlayOnHideEvent extends OverlayOnShowEvent {
+}
+/**
+ * Represents the options for an overlay.
+ * @group Interface
+ */
+export interface OverlayOptions {
+    /**
+     * The mode of the overlay.
+     */
+    mode?: OverlayModeType;
+    /**
+     * The inline style for the overlay.
+     */
+    style?: any;
+    /**
+     * The CSS class for the overlay.
+     */
+    styleClass?: string;
+    /**
+     * The inline style for the content of the overlay.
+     */
+    contentStyle?: any;
+    /**
+     * The CSS class for the content of the overlay.
+     */
+    contentStyleClass?: string;
+    /**
+     * The target element.
+     */
+    target?: any;
+    /**
+     * The element or location where the overlay should be appended.
+     */
+    appendTo?: 'body' | HTMLElement | undefined;
+    /**
+     * Indicates whether the overlay should have an auto-generated z-index.
+     */
+    autoZIndex?: boolean;
+    /**
+     * The base z-index value for the overlay.
+     */
+    baseZIndex?: number;
+    /**
+     * The transition options for showing the overlay.
+     */
+    showTransitionOptions?: string;
+    /**
+     * The transition options for hiding the overlay.
+     */
+    hideTransitionOptions?: string;
+    /**
+     * Indicates whether the overlay should be hidden when the escape key is pressed.
+     */
+    hideOnEscape?: boolean;
+    /**
+     * A listener function for handling events related to the overlay.
+     */
+    listener?: (event: Event, options?: OverlayListenerOptions) => boolean | void;
+    /**
+     * The options for a responsive overlay.
+     */
+    responsive?: ResponsiveOverlayOptions | undefined;
+    /**
+     * A callback function that is invoked before the overlay is shown.
+     */
+    onBeforeShow?: (event?: OverlayOnBeforeShowEvent) => void;
+    /**
+     * A callback function that is invoked when the overlay is shown.
+     */
+    onShow?: (event?: OverlayOnShowEvent) => void;
+    /**
+     * A callback function that is invoked before the overlay is hidden.
+     */
+    onBeforeHide?: (event?: OverlayOnBeforeHideEvent) => void;
+    /**
+     * A callback function that is invoked when the overlay is hidden.
+     */
+    onHide?: (event?: OverlayOnHideEvent) => void;
+    /**
+     * A callback function that is invoked when the overlay's animation starts.
+     */
+    onAnimationStart?: (event?: AnimationEvent) => void;
+    /**
+     * A callback function that is invoked when the overlay's animation is done.
+     */
+    onAnimationDone?: (event?: AnimationEvent) => void;
+}

package/api/overlayservice.d.ts

@@ -0,0 +1,9 @@
+import { Message } from './message';
+import * as i0 from "@angular/core";
+export declare class OverlayService {
+    private clickSource;
+    clickObservable: import("rxjs").Observable<Message | Message[]>;
+    add(event: any): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OverlayService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<OverlayService>;
+}