cax-design-system 3.0.0 → 3.0.2

package/treeselect/index.d.ts

@@ -1,5 +1,519 @@
+import { AnimationEvent } from '@angular/animations';
+import * as i0 from '@angular/core';
+import { TemplateRef, AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, QueryList } from '@angular/core';
+import * as i5 from 'cax-design-system/api';
+import { TreeNode, caxConfig, OverlayService, OverlayOptions, ScrollerOptions, CaxTemplate } from 'cax-design-system/api';
+import * as i3 from 'cax-design-system/overlay';
+import { Overlay } from 'cax-design-system/overlay';
+import * as i6 from 'cax-design-system/tree';
+import { TreeFilterEvent, TreeNodeUnSelectEvent, TreeNodeSelectEvent, Tree } from 'cax-design-system/tree';
+import { Nullable } from 'cax-design-system/ts-helpers';
+import * as i2 from '@angular/common';
+import * as i4 from 'cax-design-system/ripple';
+import * as i7 from 'cax-design-system/autofocus';
+import * as i8 from 'cax-design-system/icons/search';
+import * as i9 from 'cax-design-system/icons/times';
+import * as i10 from 'cax-design-system/icons/chevrondown';
+
 /**
- * Generated bundle index. Do not edit.
+ * Custom node collapse event.
+ * @see {@link TreeSelect.onNodeCollapse}
+ * @group Events
  */
-/// <amd-module name="cax-design-system/treeselect" />
-export * from './public_api';
+interface TreeSelectNodeCollapseEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Node instance.
+     */
+    node: TreeNode;
+}
+/**
+ * Custom node expand event.
+ * @see {@link TreeSelect.onNodeExpand}
+ * @group Events
+ */
+interface TreeSelectNodeExpandEvent extends TreeSelectNodeCollapseEvent {
+}
+/**
+ * Defines valid templates in TreeSelect.
+ * @group Templates
+ */
+interface TreeSelectTemplates {
+    /**
+     * Custom value template.
+     * @param {Object} context - value data.
+     */
+    value(context: {
+        /**
+         * Value of the component.
+         */
+        $implicit: TreeNode<any> | null;
+        /**
+         * Placeholder of the component.
+         */
+        placeholder: string;
+    }): TemplateRef<{
+        $implicit: TreeNode<any> | null;
+        placeholder: string;
+    }>;
+    /**
+     * Custom header template.
+     * @param {Object} context - header data.
+     */
+    header(context: {
+        /**
+         * Value of the component.
+         */
+        $implicit: TreeNode<any> | null | undefined;
+        /**
+         * Placeholder of the component.
+         */
+        options: TreeNode<any>[] | undefined;
+    }): TemplateRef<{
+        $implicit: TreeNode<any> | null;
+        options: TreeNode[] | null | undefined;
+    }>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom dropdown trigger icon template.
+     */
+    triggericon(): TemplateRef<any>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<any>;
+    /**
+     * Custom close icon template.
+     */
+    closeicon(): TemplateRef<any>;
+    /**
+     * Custom node toggler template.
+     * @param {Object} context - toggler icon data.
+     */
+    itemtogglericon(context: {
+        /**
+         * Expanded state of the node.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: TreeNode<any> | null;
+    }>;
+    /**
+     * Custom node checkbox icon template.
+     */
+    itemcheckboxicon(): TemplateRef<any>;
+    /**
+     * Custom loading icon template.
+     */
+    itemloadingicon(): TemplateRef<any>;
+}
+
+declare const TREESELECT_VALUE_ACCESSOR: any;
+/**
+ * TreeSelect is a form component to choose from hierarchical data.
+ * @group Components
+ */
+declare class TreeSelect implements AfterContentInit {
+    config: caxConfig;
+    cd: ChangeDetectorRef;
+    el: ElementRef;
+    overlayService: OverlayService;
+    showRightIcon: boolean;
+    /**
+     * Identifier of the underlying input element.
+     * @group Props
+     */
+    inputId: string | undefined;
+    /**
+     * Height of the viewport, a scrollbar is defined if height of list exceeds this value.
+     * @group Props
+     */
+    scrollHeight: string;
+    /**
+     * When present, it specifies that the component should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * Defines how multiple items can be selected, 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;
+    /**
+     * Specifies the input variant of the component.
+     * @group Props
+     */
+    labelText: string | undefined;
+    labelTextClass: string;
+    variant: 'filled' | 'outlined';
+    /**
+     * Defines how the selected items are displayed.
+     * @group Props
+     */
+    display: 'comma' | 'chip';
+    /**
+     * Defines the selection mode.
+     * @group Props
+     */
+    selectionMode: 'single' | 'multiple' | 'checkbox';
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
+    tabindex: string | undefined;
+    /**
+     * Defines a string that labels the input for accessibility.
+     * @group Props
+     */
+    ariaLabel: string | undefined;
+    /**
+     * Establishes relationships between the component and label(s) where its value should be one or more element IDs.
+     * @group Props
+     */
+    ariaLabelledBy: string | undefined;
+    /**
+     * Label to display when there are no selections.
+     * @group Props
+     */
+    placeholder: string | undefined;
+    /**
+     * Style class of the overlay panel.
+     * @group Props
+     */
+    panelClass: string | string[] | Set<string> | {
+        [klass: string]: any;
+    } | undefined;
+    /**
+     * Inline style of the panel element.
+     * @group Props
+     */
+    panelStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the panel element.
+     * @group Props
+     */
+    panelStyleClass: string | undefined;
+    /**
+     * Inline style of the container element.
+     * @group Props
+     */
+    containerStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the container element.
+     * @group Props
+     */
+    containerStyleClass: string | undefined;
+    /**
+     * Inline style of the label element.
+     * @group Props
+     */
+    labelStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the label element.
+     * @group Props
+     */
+    labelStyleClass: string | undefined;
+    /**
+     * Specifies the options for the overlay.
+     * @group Props
+     */
+    overlayOptions: OverlayOptions | undefined;
+    /**
+     * Text to display when there are no options available. Defaults to value from cax locale configuration.
+     * @group Props
+     */
+    emptyMessage: string;
+    /**
+     * A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are "body" for document body and "self" for the element itself.
+     * @group Props
+     */
+    appendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * When specified, displays an input field to filter the items.
+     * @group Props
+     */
+    filter: boolean;
+    /**
+     * When filtering is enabled, filterBy decides which field or fields (comma separated) to search against.
+     * @group Props
+     */
+    filterBy: string;
+    /**
+     * Mode for filtering valid values are "lenient" and "strict". Default is lenient.
+     * @group Props
+     */
+    filterMode: string;
+    /**
+     * Placeholder text to show when filter input is empty.
+     * @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;
+    /**
+     * Determines whether the filter input should be automatically focused when the component is rendered.
+     * @group Props
+     */
+    filterInputAutoFocus: boolean;
+    /**
+     * Whether checkbox selections propagate to descendant nodes.
+     * @group Props
+     */
+    propagateSelectionDown: boolean;
+    /**
+     * Whether checkbox selections propagate to ancestor nodes.
+     * @group Props
+     */
+    propagateSelectionUp: boolean;
+    /**
+     * When enabled, a clear icon is displayed to clear the value.
+     * @group Props
+     */
+    showClear: boolean;
+    /**
+     * Clears the filter value when hiding the dropdown.
+     * @group Props
+     */
+    resetFilterOnHide: boolean;
+    /**
+     * Whether the data should be loaded on demand during scroll.
+     * @group Props
+     */
+    virtualScroll: boolean | undefined;
+    /**
+     * Height of an item in the list for VirtualScrolling.
+     * @group Props
+     */
+    virtualScrollItemSize: number | undefined;
+    /**
+     * Whether to use the scroller feature. The properties of scroller component can be used like an object in it.
+     * @group Props
+     */
+    virtualScrollOptions: ScrollerOptions | undefined;
+    /**
+     * When present, it specifies that the component should automatically get focus on load.
+     * @group Props
+     */
+    autofocus: boolean | undefined;
+    /**
+     * An array of treenodes.
+     * @defaultValue undefined
+     * @group Props
+     */
+    get options(): TreeNode[] | undefined;
+    set options(options: TreeNode[] | undefined);
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     * @deprecated since v14.2.0 use overlayOptions property instead.
+     */
+    get showTransitionOptions(): string | undefined;
+    set showTransitionOptions(val: string | undefined);
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     * @deprecated since v14.2.0 use overlayOptions property instead.
+     */
+    get hideTransitionOptions(): string | undefined;
+    set hideTransitionOptions(val: string | undefined);
+    /**
+     * Displays a loader to indicate data load is in progress.
+     * @group Props
+     */
+    loading: boolean | undefined;
+    /**
+     * Callback to invoke when a node is expanded.
+     * @param {TreeSelectNodeExpandEvent} event - Custom node expand event.
+     * @group Emits
+     */
+    onNodeExpand: EventEmitter<TreeSelectNodeExpandEvent>;
+    /**
+     * Callback to invoke when a node is collapsed.
+     * @param {TreeSelectNodeCollapseEvent} event - Custom node collapse event.
+     * @group Emits
+     */
+    onNodeCollapse: EventEmitter<TreeSelectNodeCollapseEvent>;
+    /**
+     * Callback to invoke when the overlay is shown.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onShow: EventEmitter<Event>;
+    /**
+     * Callback to invoke when the overlay is hidden.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onHide: EventEmitter<Event>;
+    /**
+     * Callback to invoke when input field is cleared.
+     * @group Emits
+     */
+    onClear: EventEmitter<any>;
+    /**
+     * Callback to invoke when data is filtered.
+     * @group Emits
+     */
+    onFilter: EventEmitter<TreeFilterEvent>;
+    /**
+     * Callback to invoke when treeselect gets focus.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onFocus: EventEmitter<Event>;
+    /**
+     * Callback to invoke when treeselect loses focus.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onBlur: EventEmitter<Event>;
+    /**
+     * Callback to invoke when a node is unselected.
+     * @param {TreeNodeUnSelectEvent} event - node unselect event.
+     * @group Emits
+     */
+    onNodeUnselect: EventEmitter<TreeNodeUnSelectEvent>;
+    /**
+     * Callback to invoke when a node is selected.
+     * @param {TreeNodeSelectEvent} event - node select event.
+     * @group Emits
+     */
+    onNodeSelect: EventEmitter<TreeNodeSelectEvent>;
+    _showTransitionOptions: string | undefined;
+    _hideTransitionOptions: string | undefined;
+    templates: Nullable<QueryList<CaxTemplate>>;
+    containerEl: Nullable<ElementRef>;
+    focusInput: Nullable<ElementRef>;
+    filterViewChild: Nullable<ElementRef>;
+    treeViewChild: Nullable<Tree>;
+    panelEl: Nullable<ElementRef>;
+    overlayViewChild: Nullable<Overlay>;
+    firstHiddenFocusableElementOnOverlay: Nullable<ElementRef>;
+    lastHiddenFocusableElementOnOverlay: Nullable<ElementRef>;
+    filteredNodes: TreeNode[] | undefined | null;
+    filterValue: Nullable<string>;
+    serializedValue: Nullable<any[]>;
+    valueTemplate: Nullable<TemplateRef<any>>;
+    headerTemplate: Nullable<TemplateRef<any>>;
+    emptyTemplate: Nullable<TemplateRef<any>>;
+    footerTemplate: Nullable<TemplateRef<any>>;
+    clearIconTemplate: Nullable<TemplateRef<any>>;
+    triggerIconTemplate: Nullable<TemplateRef<any>>;
+    filterIconTemplate: Nullable<TemplateRef<any>>;
+    closeIconTemplate: Nullable<TemplateRef<any>>;
+    itemTogglerIconTemplate: Nullable<TemplateRef<any>>;
+    itemCheckboxIconTemplate: Nullable<TemplateRef<any>>;
+    itemLoadingIconTemplate: Nullable<TemplateRef<any>>;
+    focused: Nullable<boolean>;
+    overlayVisible: Nullable<boolean>;
+    selfChange: Nullable<boolean>;
+    value: any | undefined;
+    expandedNodes: any[];
+    _options: TreeNode[] | undefined;
+    templateMap: any;
+    onModelChange: Function;
+    onModelTouched: Function;
+    listId: string;
+    constructor(config: caxConfig, cd: ChangeDetectorRef, el: ElementRef, overlayService: OverlayService);
+    ngOnInit(): void;
+    ngAfterContentInit(): void;
+    onOverlayAnimationStart(event: AnimationEvent): void;
+    onOverlayBeforeHide(event: Event): void;
+    onSelectionChange(event: Event): void;
+    onClick(event: Event): void;
+    onKeyDown(event: KeyboardEvent): void;
+    onFilterInput(event: Event): void;
+    onArrowDown(event: KeyboardEvent): void;
+    onFirstHiddenFocus(event: any): void;
+    onLastHiddenFocus(event: any): void;
+    show(): void;
+    hide(event?: any): void;
+    clear(event: Event): void;
+    checkValue(): boolean;
+    onTabKey(event: any, pressedInInputText?: boolean): void;
+    hasFocusableElements(): boolean;
+    resetFilter(): void;
+    updateTreeState(): void;
+    updateTreeBranchState(node: TreeNode | null, path: any, selectedNodes: TreeNode[]): void;
+    expandPath(expandedNodes: TreeNode[]): void;
+    nodeExpand(event: {
+        originalEvent: Event;
+        node: TreeNode;
+    }): void;
+    nodeCollapse(event: {
+        originalEvent: Event;
+        node: TreeNode;
+    }): void;
+    resetExpandedNodes(): void;
+    resetPartialSelected(nodes?: TreeNode<any>[]): void;
+    findSelectedNodes(node: TreeNode, keys: any[], selectedNodes: TreeNode[]): void;
+    isSelected(node: TreeNode): boolean;
+    findIndexInSelection(node: TreeNode): number;
+    onSelect(event: TreeNodeSelectEvent): void;
+    onUnselect(event: TreeNodeUnSelectEvent): void;
+    onInputFocus(event: Event): void;
+    onInputBlur(event: Event): void;
+    writeValue(value: any): void;
+    registerOnChange(fn: Function): void;
+    registerOnTouched(fn: Function): void;
+    setDisabledState(val: boolean): void;
+    containerClass(): {
+        'cax-treeselect cax-component cax-inputwrapper': boolean;
+        'cax-treeselect-chip': boolean;
+        'cax-disabled': boolean;
+        'cax-focus': boolean;
+        'cax-variant-filled': boolean;
+    };
+    labelClass(): {
+        'cax-treeselect-label': boolean;
+        'cax-placeholder': boolean;
+        'cax-treeselect-label-empty': boolean;
+    };
+    get emptyValue(): boolean;
+    get emptyOptions(): boolean;
+    get label(): any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TreeSelect, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TreeSelect, "cax-treeSelect", never, { "showRightIcon": { "alias": "showRightIcon"; "required": false; }; "inputId": { "alias": "inputId"; "required": false; }; "scrollHeight": { "alias": "scrollHeight"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "metaKeySelection": { "alias": "metaKeySelection"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; "display": { "alias": "display"; "required": false; }; "selectionMode": { "alias": "selectionMode"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "panelClass": { "alias": "panelClass"; "required": false; }; "panelStyle": { "alias": "panelStyle"; "required": false; }; "panelStyleClass": { "alias": "panelStyleClass"; "required": false; }; "containerStyle": { "alias": "containerStyle"; "required": false; }; "containerStyleClass": { "alias": "containerStyleClass"; "required": false; }; "labelStyle": { "alias": "labelStyle"; "required": false; }; "labelStyleClass": { "alias": "labelStyleClass"; "required": false; }; "overlayOptions": { "alias": "overlayOptions"; "required": false; }; "emptyMessage": { "alias": "emptyMessage"; "required": false; }; "appendTo": { "alias": "appendTo"; "required": false; }; "filter": { "alias": "filter"; "required": false; }; "filterBy": { "alias": "filterBy"; "required": false; }; "filterMode": { "alias": "filterMode"; "required": false; }; "filterPlaceholder": { "alias": "filterPlaceholder"; "required": false; }; "filterLocale": { "alias": "filterLocale"; "required": false; }; "filterInputAutoFocus": { "alias": "filterInputAutoFocus"; "required": false; }; "propagateSelectionDown": { "alias": "propagateSelectionDown"; "required": false; }; "propagateSelectionUp": { "alias": "propagateSelectionUp"; "required": false; }; "showClear": { "alias": "showClear"; "required": false; }; "resetFilterOnHide": { "alias": "resetFilterOnHide"; "required": false; }; "virtualScroll": { "alias": "virtualScroll"; "required": false; }; "virtualScrollItemSize": { "alias": "virtualScrollItemSize"; "required": false; }; "virtualScrollOptions": { "alias": "virtualScrollOptions"; "required": false; }; "autofocus": { "alias": "autofocus"; "required": false; }; "options": { "alias": "options"; "required": false; }; "showTransitionOptions": { "alias": "showTransitionOptions"; "required": false; }; "hideTransitionOptions": { "alias": "hideTransitionOptions"; "required": false; }; "loading": { "alias": "loading"; "required": false; }; }, { "onNodeExpand": "onNodeExpand"; "onNodeCollapse": "onNodeCollapse"; "onShow": "onShow"; "onHide": "onHide"; "onClear": "onClear"; "onFilter": "onFilter"; "onFocus": "onFocus"; "onBlur": "onBlur"; "onNodeUnselect": "onNodeUnselect"; "onNodeSelect": "onNodeSelect"; }, ["templates"], never, false, never>;
+    static ngAcceptInputType_disabled: unknown;
+    static ngAcceptInputType_metaKeySelection: unknown;
+    static ngAcceptInputType_filter: unknown;
+    static ngAcceptInputType_filterInputAutoFocus: unknown;
+    static ngAcceptInputType_propagateSelectionDown: unknown;
+    static ngAcceptInputType_propagateSelectionUp: unknown;
+    static ngAcceptInputType_showClear: unknown;
+    static ngAcceptInputType_resetFilterOnHide: unknown;
+    static ngAcceptInputType_autofocus: unknown;
+    static ngAcceptInputType_loading: unknown;
+}
+
+declare class TreeSelectModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<TreeSelectModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<TreeSelectModule, [typeof TreeSelect], [typeof i2.CommonModule, typeof i3.OverlayModule, typeof i4.RippleModule, typeof i5.SharedModule, typeof i6.TreeModule, typeof i7.AutoFocusModule, typeof i8.SearchIcon, typeof i9.TimesIcon, typeof i10.ChevronDownIcon], [typeof TreeSelect, typeof i3.OverlayModule, typeof i5.SharedModule, typeof i6.TreeModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<TreeSelectModule>;
+}
+
+export { TREESELECT_VALUE_ACCESSOR, TreeSelect, TreeSelectModule };
+export type { TreeSelectNodeCollapseEvent, TreeSelectNodeExpandEvent, TreeSelectTemplates };