cax-design-system 2.8.0 → 2.8.2

package/checkbox/index.d.ts

@@ -1,5 +1,206 @@
+import * as i0 from '@angular/core';
+import { TemplateRef, ChangeDetectorRef, EventEmitter, ElementRef, QueryList, Injector } from '@angular/core';
+import { ControlValueAccessor, FormControl } from '@angular/forms';
+import * as i4 from 'cax-design-system/api';
+import { caxConfig, CaxTemplate } from 'cax-design-system/api';
+import { Nullable } from 'cax-design-system/ts-helpers';
+import * as i2 from '@angular/common';
+import * as i3 from 'cax-design-system/autofocus';
+
 /**
- * Generated bundle index. Do not edit.
+ * Custom change event.
+ * @see {@link Checkbox.onChange}
+ * @group Events
  */
-/// <amd-module name="cax-design-system/checkbox" />
-export * from './public_api';
+interface CheckboxChangeEvent {
+    /**
+     * Checked value.
+     */
+    checked?: any;
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+}
+/**
+ * Defines valid templates in Checkbox.
+ * @group Templates
+ */
+interface CheckboxTemplates {
+    /**
+     * Custom checkbox icon template
+     */
+    icon(): TemplateRef<any>;
+}
+
+declare const CHECKBOX_VALUE_ACCESSOR: any;
+/**
+ * Checkbox is an extension to standard checkbox element with theming.
+ * @group Components
+ */
+declare class Checkbox implements ControlValueAccessor {
+    cd: ChangeDetectorRef;
+    private readonly injector;
+    config: caxConfig;
+    size: 'sm' | 'md' | 'lg';
+    /**
+     * Value of the checkbox.
+     * @group Props
+     */
+    value: any;
+    /**
+     * Name of the checkbox group.
+     * @group Props
+     */
+    name: string | undefined;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * Allows to select a boolean value instead of multiple values.
+     * @group Props
+     */
+    binary: boolean | undefined;
+    /**
+     * Label of the checkbox.
+     * @group Props
+     */
+    label: 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;
+    /**
+     * Used to define a string that labels the input element.
+     * @group Props
+     */
+    ariaLabel: string | undefined;
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
+    tabindex: number | undefined;
+    /**
+     * Identifier of the focus input to match a label defined for the component.
+     * @group Props
+     */
+    inputId: 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;
+    /**
+     * Style class of the label.
+     * @group Props
+     */
+    labelStyleClass: string | undefined;
+    /**
+     * Form control value.
+     * @group Props
+     */
+    formControl: FormControl | undefined;
+    /**
+     * Icon class of the checkbox icon.
+     * @group Props
+     */
+    checkboxIcon: string | undefined;
+    /**
+     * When present, it specifies that the component cannot be edited.
+     * @group Props
+     */
+    readonly: boolean | undefined;
+    /**
+     * When present, it specifies that checkbox must be checked before submitting the form.
+     * @group Props
+     */
+    required: boolean | undefined;
+    /**
+     * When present, it specifies that the component should automatically get focus on load.
+     * @group Props
+     */
+    autofocus: boolean | undefined;
+    /**
+     * Value in checked state.
+     * @group Props
+     */
+    trueValue: any;
+    /**
+     * Value in unchecked state.
+     * @group Props
+     */
+    falseValue: any;
+    /**
+     * Specifies the input variant of the component.
+     * @group Props
+     */
+    variant: 'filled' | 'outlined';
+    /**
+     * Callback to invoke on value change.
+     * @param {CheckboxChangeEvent} event - Custom value change event.
+     * @group Emits
+     */
+    indeterminate: boolean;
+    indeterminateChange: EventEmitter<boolean>;
+    onChange: EventEmitter<CheckboxChangeEvent>;
+    /**
+     * Callback to invoke when the receives focus.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onFocus: EventEmitter<Event>;
+    /**
+     * Callback to invoke when the loses focus.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onBlur: EventEmitter<Event>;
+    inputViewChild: Nullable<ElementRef>;
+    templates: Nullable<QueryList<CaxTemplate>>;
+    checkboxIconTemplate: TemplateRef<any>;
+    model: any;
+    onModelChange: Function;
+    onModelTouched: Function;
+    focused: boolean;
+    constructor(cd: ChangeDetectorRef, injector: Injector, config: caxConfig);
+    ngAfterContentInit(): void;
+    onClick(event: any, checkbox: any, focus: boolean): void;
+    updateModel(event: any): void;
+    handleChange(event: any): void;
+    onInputFocus(event: any): void;
+    onInputBlur(event: any): void;
+    focus(): void;
+    writeValue(model: any): void;
+    registerOnChange(fn: Function): void;
+    registerOnTouched(fn: Function): void;
+    setDisabledState(val: boolean): void;
+    checked(): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<Checkbox, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Checkbox, "cax-checkbox", never, { "size": { "alias": "size"; "required": false; }; "value": { "alias": "value"; "required": false; }; "name": { "alias": "name"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "binary": { "alias": "binary"; "required": false; }; "label": { "alias": "label"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "inputId": { "alias": "inputId"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "labelStyleClass": { "alias": "labelStyleClass"; "required": false; }; "formControl": { "alias": "formControl"; "required": false; }; "checkboxIcon": { "alias": "checkboxIcon"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "required": { "alias": "required"; "required": false; }; "autofocus": { "alias": "autofocus"; "required": false; }; "trueValue": { "alias": "trueValue"; "required": false; }; "falseValue": { "alias": "falseValue"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; "indeterminate": { "alias": "indeterminate"; "required": false; }; "model": { "alias": "model"; "required": false; }; }, { "indeterminateChange": "indeterminateChange"; "onChange": "onChange"; "onFocus": "onFocus"; "onBlur": "onBlur"; }, ["templates"], never, false, never>;
+    static ngAcceptInputType_disabled: unknown;
+    static ngAcceptInputType_binary: unknown;
+    static ngAcceptInputType_tabindex: unknown;
+    static ngAcceptInputType_readonly: unknown;
+    static ngAcceptInputType_required: unknown;
+    static ngAcceptInputType_autofocus: unknown;
+    static ngAcceptInputType_indeterminate: unknown;
+}
+
+declare class CheckboxModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CheckboxModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<CheckboxModule, [typeof Checkbox], [typeof i2.CommonModule, typeof i3.AutoFocusModule, typeof i4.SharedModule], [typeof Checkbox, typeof i4.SharedModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<CheckboxModule>;
+}
+
+export { CHECKBOX_VALUE_ACCESSOR, Checkbox, CheckboxModule };
+export type { CheckboxChangeEvent, CheckboxTemplates };

package/chip/index.d.ts

@@ -1,5 +1,65 @@
+import * as i0 from '@angular/core';
+import { AfterContentInit, EventEmitter, TemplateRef, QueryList } from '@angular/core';
+import * as i4 from 'cax-design-system/api';
+import { caxConfig, CaxTemplate } from 'cax-design-system/api';
+import * as i2 from '@angular/common';
+import * as i3 from 'cax-design-system/icons/timescircle';
+
+type ChipSeverity = 'primary' | 'secondary' | 'success' | 'warning' | 'error';
+declare class Chip implements AfterContentInit {
+    label: string | undefined;
+    icon: string | undefined;
+    image: string | undefined;
+    alt: string | undefined;
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    styleClass: string | undefined;
+    removable: boolean | undefined;
+    removeIcon: string | undefined;
+    size: 'sm' | 'md' | 'lg';
+    severity: ChipSeverity;
+    onRemove: EventEmitter<MouseEvent>;
+    onImageError: EventEmitter<Event>;
+    config: caxConfig;
+    visible: boolean;
+    removeIconTemplate: TemplateRef<any> | undefined;
+    get removeAriaLabel(): any;
+    templates: QueryList<CaxTemplate> | undefined;
+    ngAfterContentInit(): void;
+    containerClass(): {
+        [x: string]: boolean;
+        'cax-chip cax-component': boolean;
+        'cax-chip-image': boolean;
+    };
+    close(event: Event): void;
+    onKeydown(event: KeyboardEvent): void;
+    imageError(event: Event): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<Chip, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Chip, "cax-chip", never, { "label": { "alias": "label"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "image": { "alias": "image"; "required": false; }; "alt": { "alias": "alt"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "removable": { "alias": "removable"; "required": false; }; "removeIcon": { "alias": "removeIcon"; "required": false; }; "size": { "alias": "size"; "required": false; }; "severity": { "alias": "severity"; "required": false; }; }, { "onRemove": "onRemove"; "onImageError": "onImageError"; }, ["templates"], ["*"], false, never>;
+    static ngAcceptInputType_removable: unknown;
+}
+
 /**
- * Generated bundle index. Do not edit.
+ * Defines valid templates in Chip.
+ * @group Templates
  */
-/// <amd-module name="cax-design-system/chip" />
-export * from './public_api';
+interface ChipTemplates {
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+    /**
+     * Custom template of remove icon.
+     */
+    removeicon(): TemplateRef<any>;
+}
+
+declare class ChipModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<ChipModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<ChipModule, [typeof Chip], [typeof i2.CommonModule, typeof i3.TimesCircleIcon, typeof i4.SharedModule], [typeof Chip, typeof i4.SharedModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<ChipModule>;
+}
+
+export { Chip, ChipModule };
+export type { ChipTemplates };

package/chips/index.d.ts

@@ -1,5 +1,307 @@
+import * as i0 from '@angular/core';
+import { TemplateRef, AfterContentInit, ElementRef, ChangeDetectorRef, EventEmitter, QueryList } from '@angular/core';
+import { ControlValueAccessor } from '@angular/forms';
+import * as i3 from 'cax-design-system/api';
+import { caxConfig } 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/inputtext';
+import * as i4 from 'cax-design-system/autofocus';
+import * as i5 from 'cax-design-system/icons/timescircle';
+import * as i6 from 'cax-design-system/icons/times';
+import * as i8 from 'cax-design-system/chip';
+
 /**
- * Generated bundle index. Do not edit.
+ * Custom add event.
+ * @see {@link Chips.onAdd}
+ * @group Events
  */
-/// <amd-module name="cax-design-system/chips" />
-export * from './public_api';
+interface ChipsAddEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Added/Removed item value.
+     */
+    value: any;
+}
+/**
+ * Custom remove event.
+ * @see {@link Chips.onRemove}
+ * @extends {ChipsAddEvent}
+ * @group Events
+ */
+interface ChipsRemoveEvent extends ChipsAddEvent {
+}
+/**
+ * Custom click event.
+ * @see {@link Chips.onChipClick}
+ * @extends {ChipsAddEvent}
+ * @group Events
+ */
+interface ChipsClickEvent extends ChipsAddEvent {
+}
+/**
+ * Defines valid templates in Chips.
+ * @group Templates
+ */
+interface ChipsTemplates {
+    /**
+     * Custom item template.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Value of the chip element.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom remove icon template.
+     */
+    removetokenicon(): TemplateRef<any>;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+}
+
+declare const CHIPS_VALUE_ACCESSOR: any;
+/**
+ * Chips groups a collection of contents in tabs.
+ * @group Components
+ */
+declare class Chips implements AfterContentInit, ControlValueAccessor {
+    private document;
+    el: ElementRef;
+    cd: ChangeDetectorRef;
+    config: caxConfig;
+    leftIconClass: string;
+    leftIcon?: boolean;
+    rightIconClass: string;
+    rightIcon?: boolean;
+    chipIcon: string | undefined;
+    label: string | undefined;
+    chipsScrollable: ElementRef;
+    isTyping: boolean;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * Name of the property to display on a chip.
+     * @group Props
+     */
+    field: string | undefined;
+    /**
+     * Advisory information to display on input.
+     * @group Props
+     */
+    placeholder: string | undefined;
+    /**
+     * Maximum number of entries allowed.
+     * @group Props
+     */
+    max: number | undefined;
+    /**
+     * Maximum length of a chip.
+     * @group Props
+     */
+    maxLength: number | 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;
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
+    tabindex: number | undefined;
+    /**
+     * Identifier of the focus input to match a label defined for the component.
+     * @group Props
+     */
+    inputId: string | undefined;
+    /**
+     * Whether to allow duplicate values or not.
+     * @group Props
+     */
+    allowDuplicate: boolean;
+    /**
+     * Defines whether duplication check should be case-sensitive
+     * @group Props
+     */
+    caseSensitiveDuplication: boolean;
+    /**
+     * Inline style of the input field.
+     * @group Props
+     */
+    inputStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the input field.
+     * @group Props
+     */
+    inputStyleClass: string | undefined;
+    /**
+     * Whether to add an item on tab key press.
+     * @group Props
+     */
+    addOnTab: boolean | undefined;
+    /**
+     * Whether to add an item when the input loses focus.
+     * @group Props
+     */
+    addOnBlur: boolean | undefined;
+    /**
+     * Separator char to add an item when pressed in addition to the enter key.
+     * @group Props
+     */
+    separator: string | RegExp | undefined;
+    /**
+     * When enabled, a clear icon is displayed to clear the value.
+     * @group Props
+     */
+    showClear: boolean;
+    /**
+     * When present, it specifies that the component should automatically get focus on load.
+     * @group Props
+     */
+    autofocus: boolean | undefined;
+    /**
+     * Specifies the input variant of the component.
+     * @group Props
+     */
+    variant: 'filled' | 'outlined';
+    /**
+     * Size of the component.
+     * @group Props
+     */
+    size: 'sm' | 'md' | 'lg';
+    /**
+     * Callback to invoke on chip add.
+     * @param {ChipsAddEvent} event - Custom chip add event.
+     * @group Emits
+     */
+    onAdd: EventEmitter<ChipsAddEvent>;
+    /**
+     * Callback to invoke on chip remove.
+     * @param {ChipsRemoveEvent} event - Custom chip remove event.
+     * @group Emits
+     */
+    onRemove: EventEmitter<ChipsRemoveEvent>;
+    /**
+     * Callback to invoke on focus of input field.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onFocus: EventEmitter<Event>;
+    /**
+     * Callback to invoke on blur of input field.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onBlur: EventEmitter<Event>;
+    /**
+     * Callback to invoke on chip clicked.
+     * @param {ChipsClickEvent} event - Custom chip click event.
+     * @group Emits
+     */
+    onChipClick: EventEmitter<ChipsClickEvent>;
+    /**
+     * Callback to invoke on clear token clicked.
+     * @group Emits
+     */
+    onClear: EventEmitter<any>;
+    inputViewChild: ElementRef;
+    containerViewChild: ElementRef;
+    templates: QueryList<any>;
+    itemTemplate: Nullable<TemplateRef<any>>;
+    removeTokenIconTemplate: Nullable<TemplateRef<any>>;
+    clearIconTemplate: Nullable<TemplateRef<any>>;
+    value: any;
+    severity: ChipSeverity;
+    onModelChange: Function;
+    onModelTouched: Function;
+    valueChanged: Nullable<boolean>;
+    id: string;
+    focused: Nullable<boolean>;
+    focusedIndex: Nullable<number>;
+    filled: Nullable<boolean>;
+    get focusedOptionId(): string;
+    get isMaxedOut(): boolean;
+    constructor(document: Document, el: ElementRef, cd: ChangeDetectorRef, config: caxConfig);
+    ngAfterContentInit(): void;
+    onWrapperClick(): void;
+    onContainerFocus(): void;
+    onContainerBlur(): void;
+    onContainerKeyDown(event: any): void;
+    onArrowLeftKeyOn(): void;
+    onArrowRightKeyOn(): void;
+    onBackspaceKeyOn(event: any): void;
+    onInput(): void;
+    scrollToLastChip(): void;
+    onPaste(event: any): void;
+    updateFilledState(): void;
+    onItemClick(event: Event, item: any): void;
+    writeValue(value: any): void;
+    registerOnChange(fn: Function): void;
+    registerOnTouched(fn: Function): void;
+    setDisabledState(val: boolean): void;
+    resolveFieldData(data: any, field: string): any;
+    onInputFocus(event: FocusEvent): void;
+    onInputBlur(event: FocusEvent): void;
+    removeItem(event: Event, index: number): void;
+    addItem(event: Event, item: string, preventDefault: boolean): void;
+    /**
+     * Callback to invoke on filter reset.
+     * @group Method
+     */
+    clear(): void;
+    onKeyDown(event: any): void;
+    updateMaxedOut(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<Chips, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Chips, "cax-chips", never, { "leftIconClass": { "alias": "leftIconClass"; "required": false; }; "leftIcon": { "alias": "leftIcon"; "required": false; }; "rightIconClass": { "alias": "rightIconClass"; "required": false; }; "rightIcon": { "alias": "rightIcon"; "required": false; }; "chipIcon": { "alias": "chipIcon"; "required": false; }; "label": { "alias": "label"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "field": { "alias": "field"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "max": { "alias": "max"; "required": false; }; "maxLength": { "alias": "maxLength"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "inputId": { "alias": "inputId"; "required": false; }; "allowDuplicate": { "alias": "allowDuplicate"; "required": false; }; "caseSensitiveDuplication": { "alias": "caseSensitiveDuplication"; "required": false; }; "inputStyle": { "alias": "inputStyle"; "required": false; }; "inputStyleClass": { "alias": "inputStyleClass"; "required": false; }; "addOnTab": { "alias": "addOnTab"; "required": false; }; "addOnBlur": { "alias": "addOnBlur"; "required": false; }; "separator": { "alias": "separator"; "required": false; }; "showClear": { "alias": "showClear"; "required": false; }; "autofocus": { "alias": "autofocus"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; "size": { "alias": "size"; "required": false; }; "value": { "alias": "value"; "required": false; }; "severity": { "alias": "severity"; "required": false; }; }, { "onAdd": "onAdd"; "onRemove": "onRemove"; "onFocus": "onFocus"; "onBlur": "onBlur"; "onChipClick": "onChipClick"; "onClear": "onClear"; }, ["templates"], never, true, never>;
+    static ngAcceptInputType_disabled: unknown;
+    static ngAcceptInputType_max: unknown;
+    static ngAcceptInputType_tabindex: unknown;
+    static ngAcceptInputType_allowDuplicate: unknown;
+    static ngAcceptInputType_caseSensitiveDuplication: unknown;
+    static ngAcceptInputType_addOnTab: unknown;
+    static ngAcceptInputType_addOnBlur: unknown;
+    static ngAcceptInputType_showClear: unknown;
+    static ngAcceptInputType_autofocus: unknown;
+}
+type ChipSeverity = 'primary' | 'secondary' | 'success' | 'warning' | 'error';
+
+declare class ChipsModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<ChipsModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<ChipsModule, never, [typeof i1.CommonModule, typeof i2.InputTextModule, typeof i3.SharedModule, typeof i4.AutoFocusModule, typeof i5.TimesCircleIcon, typeof i6.TimesIcon, typeof Chips, typeof i8.ChipModule], [typeof Chips, typeof i2.InputTextModule, typeof i3.SharedModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<ChipsModule>;
+}
+
+export { CHIPS_VALUE_ACCESSOR, Chips, ChipsModule };
+export type { ChipSeverity, ChipsAddEvent, ChipsClickEvent, ChipsRemoveEvent, ChipsTemplates };