cax-design-system 3.0.0 → 3.0.2

package/navigation/index.d.ts

@@ -1,5 +1,110 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="cax-design-system/navigation" />
-export * from './public_api';
+import * as i0 from '@angular/core';
+import { OnChanges, AfterViewInit, ChangeDetectorRef, EventEmitter, ElementRef, QueryList } from '@angular/core';
+import { MenuItemCommandEvent } from 'cax-design-system/api';
+
+interface NavListItem {
+    label?: string;
+    icon?: string;
+    image?: string;
+    command?(event: MenuItemCommandEvent): void;
+    disabled?: boolean;
+    active?: boolean;
+    style?: {
+        [klass: string]: any;
+    } | null | undefined;
+    tabindex?: string;
+}
+interface TabIndexType {
+    position: 'top' | 'bottom';
+    index: number;
+}
+interface SubscriptionList {
+    name: string;
+    subscription: string[];
+    check?: boolean;
+}
+interface ActiveSubscription {
+    name: string;
+    selected: string;
+}
+
+declare class Navigation implements OnChanges, AfterViewInit {
+    private cd;
+    header: string | undefined;
+    topNavList: NavListItem[];
+    bottomNavList: NavListItem[];
+    activeTab: TabIndexType | 'notifications' | 'help-centre' | undefined;
+    notifications: boolean;
+    helpCentre: boolean;
+    privacyPolicy: boolean;
+    copyrightYear: number | undefined;
+    version: string | undefined;
+    logout: boolean;
+    myAccount: boolean;
+    userName: string | undefined;
+    userImage: string | undefined;
+    headerLogo: {
+        expanded: string;
+        collapsed: string;
+    } | undefined;
+    headerInitials: string | undefined;
+    subscriptions: (string | SubscriptionList)[];
+    selectedSubscription: string | ActiveSubscription | undefined;
+    displaySubscriptionName: string | undefined;
+    notificationCount: number;
+    isAdvance(item: any): boolean;
+    constructor(cd: ChangeDetectorRef);
+    onNavListItemChange: EventEmitter<{
+        activeTab: TabIndexType | 'notifications' | 'help-centre' | undefined;
+    }>;
+    onNotificationClick: EventEmitter<any>;
+    onHelpCentreClick: EventEmitter<any>;
+    onPrivacyPolicyClick: EventEmitter<any>;
+    onLogoutClick: EventEmitter<any>;
+    onMyAccountClick: EventEmitter<any>;
+    onLogoClick: EventEmitter<any>;
+    onSubscriptionChange: EventEmitter<any>;
+    onNavExpanded: EventEmitter<boolean>;
+    isHovered: boolean;
+    isNavExpanded: boolean;
+    notificationActive: boolean;
+    helpCentreActive: boolean;
+    accountDetailsActive: boolean;
+    checkRadio: number;
+    expandedIndex: number;
+    flyoutTop: number;
+    bottomContainer: ElementRef<HTMLDivElement>;
+    headerContainer: ElementRef<HTMLDivElement>;
+    subscriptionItems: QueryList<ElementRef>;
+    ngOnChanges(): void;
+    ngAfterViewInit(): void;
+    onItemClick(e: MouseEvent, item: NavListItem, index: number, position: 'top' | 'bottom'): void;
+    getInitials(name: string): string;
+    emitNotification(): void;
+    emitHelpCentre(): void;
+    emitPrivacyPolicy(): void;
+    emitLogout(): void;
+    emitMyAccount(): void;
+    emitLogoClick(): void;
+    onResize(): void;
+    adjustUpDivHeight(): number;
+    onMouseEnter(): void;
+    onMouseLeave(): void;
+    onAccountOverlayShow(): void;
+    hideAccountDetails(): void;
+    changeActiveSusbcription(item: string): void;
+    updateSubscription(item: SubscriptionList, child: string): void;
+    toggleSubscriptionList(index: number, event?: MouseEvent): void;
+    onSubscriptionListScroll(event: Event): void;
+    private updateFlyoutPosition;
+    static ɵfac: i0.ɵɵFactoryDeclaration<Navigation, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Navigation, "cax-navigation", never, { "header": { "alias": "header"; "required": false; }; "topNavList": { "alias": "topNavList"; "required": false; }; "bottomNavList": { "alias": "bottomNavList"; "required": false; }; "activeTab": { "alias": "activeTab"; "required": false; }; "notifications": { "alias": "notifications"; "required": false; }; "helpCentre": { "alias": "helpCentre"; "required": false; }; "privacyPolicy": { "alias": "privacyPolicy"; "required": false; }; "copyrightYear": { "alias": "copyrightYear"; "required": false; }; "version": { "alias": "version"; "required": false; }; "logout": { "alias": "logout"; "required": false; }; "myAccount": { "alias": "myAccount"; "required": false; }; "userName": { "alias": "userName"; "required": false; }; "userImage": { "alias": "userImage"; "required": false; }; "headerLogo": { "alias": "headerLogo"; "required": false; }; "headerInitials": { "alias": "headerInitials"; "required": false; }; "subscriptions": { "alias": "subscriptions"; "required": false; }; "selectedSubscription": { "alias": "selectedSubscription"; "required": false; }; "displaySubscriptionName": { "alias": "displaySubscriptionName"; "required": false; }; "notificationCount": { "alias": "notificationCount"; "required": false; }; }, { "onNavListItemChange": "onNavListItemChange"; "onNotificationClick": "onNotificationClick"; "onHelpCentreClick": "onHelpCentreClick"; "onPrivacyPolicyClick": "onPrivacyPolicyClick"; "onLogoutClick": "onLogoutClick"; "onMyAccountClick": "onMyAccountClick"; "onLogoClick": "onLogoClick"; "onSubscriptionChange": "onSubscriptionChange"; "onNavExpanded": "onNavExpanded"; }, never, never, true, never>;
+}
+
+declare class NavigationModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<NavigationModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NavigationModule, never, [typeof Navigation], [typeof Navigation]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NavigationModule>;
+}
+
+export { Navigation, NavigationModule };

package/orderlist/index.d.ts

@@ -1,5 +1,383 @@
+import * as i5 from '@angular/cdk/drag-drop';
+import { CdkDragDrop } from '@angular/cdk/drag-drop';
+import * as i0 from '@angular/core';
+import { TemplateRef, AfterViewChecked, AfterContentInit, ElementRef, ChangeDetectorRef, EventEmitter, QueryList, Renderer2 } from '@angular/core';
+import * as i3 from 'cax-design-system/api';
+import { FilterService, caxConfig, CaxTemplate } from 'cax-design-system/api';
+import { Nullable } from 'cax-design-system/ts-helpers';
+import * as i1 from '@angular/common';
+import * as i2 from 'cax-design-system/button';
+import * as i4 from 'cax-design-system/ripple';
+import * as i6 from 'cax-design-system/icons/angledoubledown';
+import * as i7 from 'cax-design-system/icons/angledoubleup';
+import * as i8 from 'cax-design-system/icons/angleup';
+import * as i9 from 'cax-design-system/icons/angledown';
+import * as i10 from 'cax-design-system/icons/search';
+
 /**
- * Generated bundle index. Do not edit.
+ * Callbacks to invoke on filter.
+ * @group Interface
  */
-/// <amd-module name="cax-design-system/orderlist" />
-export * from './public_api';
+interface OrderListFilterOptions {
+    filter?: (value?: any) => void;
+    reset?: () => void;
+}
+/**
+ * Custom change event.
+ * @see {@link OrderList.selectionChange}
+ * @group Events
+ */
+interface OrderListSelectionChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Current selected values.
+     */
+    value: any[];
+}
+/**
+ * Custom change event.
+ * @see {@link OrderList.selectionChange}
+ * @group Events
+ */
+interface OrderListFilterEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Filtered options.
+     */
+    value: any[];
+}
+/**
+ * Defines valid templates in OrderList.
+ * @group Templates
+ */
+interface OrderListTemplates {
+    /**
+     * Custom header template.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+        /**
+         * Index of the item.
+         */
+        index: number;
+    }): TemplateRef<{
+        $implicit: any;
+        index: number;
+    }>;
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom filter template.
+     * @param {OrderListFilterOptions} options - filter options.
+     */
+    filter(context: {
+        /**
+         * Filter options.
+         */
+        options: OrderListFilterOptions;
+    }): TemplateRef<{
+        options: OrderListFilterOptions;
+    }>;
+    /**
+     * Custom empty filter template.
+     */
+    emptyfilter(): TemplateRef<any>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<any>;
+    /**
+     * Custom move up icon template.
+     */
+    moveupicon(): TemplateRef<any>;
+    /**
+     * Custom move top icon template.
+     */
+    movetopicon(): TemplateRef<any>;
+    /**
+     * Custom move down icon template.
+     */
+    movedownicon(): TemplateRef<any>;
+    /**
+     * Custom move bottom icon template.
+     */
+    movebottomicon(): TemplateRef<any>;
+}
+
+/**
+ * OrderList is used to managed the order of a collection.
+ * @group Components
+ */
+declare class OrderList implements AfterViewChecked, AfterContentInit {
+    private document;
+    private platformId;
+    private renderer;
+    el: ElementRef;
+    cd: ChangeDetectorRef;
+    filterService: FilterService;
+    config: caxConfig;
+    /**
+     * Text for the caption.
+     * @group Props
+     */
+    header: string | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
+    tabindex: number | undefined;
+    /**
+     * Defines a string that labels the input for accessibility.
+     * @group Props
+     */
+    ariaLabel: string | undefined;
+    /**
+     * Specifies one or more IDs in the DOM that labels the input field.
+     * @group Props
+     */
+    ariaLabelledBy: string | undefined;
+    /**
+     * Inline style of the list element.
+     * @group Props
+     */
+    listStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * A boolean value that indicates whether the component should be responsive.
+     * @group Props
+     */
+    responsive: boolean | undefined;
+    /**
+     * When specified displays an input field to filter the items on keyup and decides which fields to search against.
+     * @group Props
+     */
+    filterBy: string | undefined;
+    /**
+     * Placeholder of the filter input.
+     * @group Props
+     */
+    filterPlaceholder: string | undefined;
+    /**
+     * Locale to use in filtering. The default locale is the host environment's current locale.
+     * @group Props
+     */
+    filterLocale: string | undefined;
+    /**
+     * When true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.
+     * @group Props
+     */
+    metaKeySelection: boolean;
+    /**
+     * Whether to enable dragdrop based reordering.
+     * @group Props
+     */
+    dragdrop: boolean;
+    /**
+     * Defines the location of the buttons with respect to the list.
+     * @group Props
+     */
+    controlsPosition: 'left' | 'right';
+    /**
+     * Defines a string that labels the filter input.
+     * @group Props
+     */
+    ariaFilterLabel: string | undefined;
+    /**
+     * Defines how the items are filtered.
+     * @group Props
+     */
+    filterMatchMode: 'contains' | 'startsWith' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte';
+    /**
+     * Indicates the width of the screen at which the component should change its behavior.
+     * @group Props
+     */
+    breakpoint: string;
+    /**
+     * Whether to displays rows with alternating colors.
+     * @group Props
+     */
+    stripedRows: boolean | undefined;
+    /**
+     * When present, it specifies that the component should be disabled.
+     * @group Props
+     */
+    disabled: boolean;
+    /**
+     * Function to optimize the dom operations by delegating to ngForTrackBy, default algorithm checks for object identity.
+     * @group Props
+     */
+    trackBy: Function;
+    /**
+     * A list of values that are currently selected.
+     * @group Props
+     */
+    set selection(val: any[]);
+    get selection(): any[];
+    /**
+     * Array of values to be displayed in the component.
+     * It represents the data source for the list of items.
+     * @group Props
+     */
+    set value(val: any[] | undefined);
+    get value(): any[] | undefined;
+    /**
+     * Callback to invoke on selection change.
+     * @param {*} any - selection instance.
+     * @group Emits
+     */
+    selectionChange: EventEmitter<any>;
+    /**
+     * Callback to invoke when list is reordered.
+     * @param {*} any - list instance.
+     * @group Emits
+     */
+    onReorder: EventEmitter<any>;
+    /**
+     * Callback to invoke when selection changes.
+     * @param {OrderListSelectionChangeEvent} event - Custom change event.
+     * @group Emits
+     */
+    onSelectionChange: EventEmitter<OrderListSelectionChangeEvent>;
+    /**
+     * Callback to invoke when filtering occurs.
+     * @param {OrderListFilterEvent} event - Custom filter event.
+     * @group Emits
+     */
+    onFilterEvent: EventEmitter<OrderListFilterEvent>;
+    /**
+     * Callback to invoke when the list is focused
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onFocus: EventEmitter<Event>;
+    /**
+     * Callback to invoke when the list is blurred
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onBlur: EventEmitter<Event>;
+    listViewChild: Nullable<ElementRef>;
+    filterViewChild: Nullable<ElementRef>;
+    templates: Nullable<QueryList<CaxTemplate>>;
+    itemTemplate: Nullable<TemplateRef<any>>;
+    headerTemplate: Nullable<TemplateRef<any>>;
+    emptyMessageTemplate: Nullable<TemplateRef<any>>;
+    emptyFilterMessageTemplate: Nullable<TemplateRef<any>>;
+    filterTemplate: Nullable<TemplateRef<any>>;
+    get moveUpAriaLabel(): string;
+    get moveTopAriaLabel(): string;
+    get moveDownAriaLabel(): string;
+    get moveBottomAriaLabel(): string;
+    moveUpIconTemplate: Nullable<TemplateRef<any>>;
+    moveTopIconTemplate: Nullable<TemplateRef<any>>;
+    moveDownIconTemplate: Nullable<TemplateRef<any>>;
+    moveBottomIconTemplate: Nullable<TemplateRef<any>>;
+    filterIconTemplate: Nullable<TemplateRef<any>>;
+    filterOptions: Nullable<OrderListFilterOptions>;
+    d_selection: any[];
+    movedUp: Nullable<boolean>;
+    movedDown: Nullable<boolean>;
+    itemTouched: Nullable<boolean>;
+    styleElement: any;
+    id: string;
+    focused: boolean;
+    focusedOptionIndex: any;
+    focusedOption: any | undefined;
+    filterValue: Nullable<string>;
+    visibleOptions: Nullable<any[]>;
+    _value: any[] | undefined;
+    constructor(document: Document, platformId: any, renderer: Renderer2, el: ElementRef, cd: ChangeDetectorRef, filterService: FilterService, config: caxConfig);
+    ngOnInit(): void;
+    ngAfterContentInit(): void;
+    ngAfterViewChecked(): void;
+    onItemClick(event: any, item: any, index?: number, selectedId?: string): void;
+    onFilterKeyup(event: KeyboardEvent): void;
+    filter(): void;
+    /**
+     * Callback to invoke on filter reset.
+     * @group Method
+     */
+    resetFilter(): void;
+    isItemVisible(item: any): boolean | undefined;
+    onItemTouchEnd(): void;
+    isSelected(item: any): boolean;
+    isEmpty(): boolean;
+    moveUp(): void;
+    moveTop(): void;
+    moveDown(): void;
+    moveBottom(): void;
+    onDrop(event: CdkDragDrop<string[]>): void;
+    onListFocus(event: any): void;
+    onListBlur(event: any): void;
+    onItemKeydown(event: KeyboardEvent): void;
+    onOptionMouseDown(index: any): void;
+    onArrowDownKey(event: any): void;
+    onArrowUpKey(event: any): void;
+    onHomeKey(event: any): void;
+    onEndKey(event: any): void;
+    onEnterKey(event: any): void;
+    onSpaceKey(event: any): void;
+    findNextOptionIndex(index: any): number;
+    findPrevOptionIndex(index: any): number;
+    getLatestSelectedVisibleOptionIndex(visibleOptions: any[]): number;
+    getVisibleOptions(): any[];
+    getFocusedOption(index: number): any;
+    changeFocusedOptionIndex(index: any): void;
+    scrollInView(id: any): void;
+    findNextItem(item: any): HTMLElement | null;
+    findPrevItem(item: any): HTMLElement | null;
+    moveDisabled(): boolean;
+    focusedOptionId(): any;
+    createStyle(): void;
+    destroyStyle(): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OrderList, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<OrderList, "p-orderList", never, { "header": { "alias": "header"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "listStyle": { "alias": "listStyle"; "required": false; }; "responsive": { "alias": "responsive"; "required": false; }; "filterBy": { "alias": "filterBy"; "required": false; }; "filterPlaceholder": { "alias": "filterPlaceholder"; "required": false; }; "filterLocale": { "alias": "filterLocale"; "required": false; }; "metaKeySelection": { "alias": "metaKeySelection"; "required": false; }; "dragdrop": { "alias": "dragdrop"; "required": false; }; "controlsPosition": { "alias": "controlsPosition"; "required": false; }; "ariaFilterLabel": { "alias": "ariaFilterLabel"; "required": false; }; "filterMatchMode": { "alias": "filterMatchMode"; "required": false; }; "breakpoint": { "alias": "breakpoint"; "required": false; }; "stripedRows": { "alias": "stripedRows"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "trackBy": { "alias": "trackBy"; "required": false; }; "selection": { "alias": "selection"; "required": false; }; "value": { "alias": "value"; "required": false; }; }, { "selectionChange": "selectionChange"; "onReorder": "onReorder"; "onSelectionChange": "onSelectionChange"; "onFilterEvent": "onFilterEvent"; "onFocus": "onFocus"; "onBlur": "onBlur"; }, ["templates"], never, false, never>;
+    static ngAcceptInputType_tabindex: unknown;
+    static ngAcceptInputType_responsive: unknown;
+    static ngAcceptInputType_metaKeySelection: unknown;
+    static ngAcceptInputType_dragdrop: unknown;
+    static ngAcceptInputType_stripedRows: unknown;
+    static ngAcceptInputType_disabled: unknown;
+}
+declare class OrderListModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<OrderListModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<OrderListModule, [typeof OrderList], [typeof i1.CommonModule, typeof i2.ButtonModule, typeof i3.SharedModule, typeof i4.RippleModule, typeof i5.DragDropModule, typeof i6.AngleDoubleDownIcon, typeof i7.AngleDoubleUpIcon, typeof i8.AngleUpIcon, typeof i9.AngleDownIcon, typeof i10.SearchIcon], [typeof OrderList, typeof i3.SharedModule, typeof i5.DragDropModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<OrderListModule>;
+}
+
+export { OrderList, OrderListModule };
+export type { OrderListFilterEvent, OrderListFilterOptions, OrderListSelectionChangeEvent, OrderListTemplates };