q2-tecton-elements 1.46.1 → 1.46.3

package/dist/types/components/q2-dropdown-item/q2-dropdown-item.d.ts

@@ -0,0 +1,45 @@
+import { ComponentInterface } from '../../stencil-public-runtime';
+import { JSX } from '../../components';
+export declare class Q2DropdownItem implements ComponentInterface {
+    /** Disables interaction with the item and blocks its click event. */
+    disabled: boolean;
+    /**
+     * The text that appears within the dropdown item.
+     * @localizable
+     */
+    label: string;
+    /**
+     * Renders an icon button in the item.
+     * Clicking on this button will change the `type` emitting on the item's click event detail to "remove".
+     */
+    removable: boolean;
+    /**
+     * Renders a line in the item instead of text.
+     * Click events from these items will not have details provided.
+     * A `separator` allows for quick visual grouping of items, so interactions should not be bound to these options.
+     */
+    separator: boolean;
+    /** A static reference value for the item. This value is returned in the click event detail. */
+    value: string;
+    /** @deprecated */
+    ariaLabel: string;
+    hostElement: HTMLElement;
+    componentWillLoad(): void;
+    ariaLabelObserver(): void;
+    get removeLabel(): string;
+    get dropdownItemBtn(): HTMLQ2BtnElement;
+    get innerLabel(): string;
+    get removeBtn(): HTMLQ2BtnElement;
+    onHostElementFocus(): void;
+    focusItem(): void;
+    focusRemoveBtn(): void;
+    onItemClick: (event: MouseEvent) => void;
+    onItemKeydown: (event: KeyboardEvent) => void;
+    onItemFocus: (event: FocusEvent) => void;
+    onRemoveBtnClick: (event: MouseEvent) => void;
+    onRemoveBtnKeydown: (event: KeyboardEvent) => void;
+    onRemoveBtnFocus: (event: FocusEvent) => void;
+    render(): JSX.IntrinsicElements;
+    separatorDOM(): JSX.IntrinsicElements;
+    itemDOM(): JSX.IntrinsicElements;
+}

package/dist/types/components/q2-editable-field/q2-editable-field.d.ts

@@ -0,0 +1,136 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { IEventDetail, Q2InputCustomEvent } from "../../components";
+import { Q2Input } from '../q2-input/q2-input';
+export declare class Q2EditableField {
+    /** If `true`, component expands to fill the width of its parent element. */
+    block: boolean;
+    /** Disables the edit button and field. */
+    disabled: boolean;
+    /** Controls the edit state of the element. */
+    editing: boolean;
+    /**
+     * Determines the `errors` applied to the `q2-input` element.
+     *
+     * See [q2-input](https://tecton.q2developer.com/ui/q2-input/) for more information.
+     */
+    errors: string[];
+    /**
+     * Determines the `formatModifier` applied to the `q2-input` element.
+     * @info
+     * Only applicable when `type="currency"`.
+     *
+     * See [q2-input](https://tecton.q2developer.com/ui/q2-input/) for more information.
+     */
+    formatModifier: string;
+    /** Hide's the field's `<label>` element from view. */
+    hideLabel: boolean;
+    /**
+     * Determines the `hints` applied to the `q2-input` element.
+     *
+     * See [q2-input](https://tecton.q2developer.com/ui/q2-input/) for more information.
+     */
+    hints: string[];
+    /**
+     * The visible descriptor for the element.
+     * Serves as the input label while in the edit state and as a decorative label for the read state when `persistentLabel` is `true`.
+     * @localizable
+     */
+    label: string;
+    /**
+     * Determines the `maxLength` applied to the `q2-input`.
+     *
+     * See [q2-input](https://tecton.q2developer.com/ui/q2-input/) for more information.
+     */
+    maxlength: number;
+    /** Displays the provided label in the read state. */
+    persistentLabel: boolean;
+    /** Shortens long values with ellipses instead of splitting into multiple lines. */
+    truncated: boolean;
+    /**
+     * Determines the `type` applied to the `q2-input` element.
+     *
+     * See [q2-input](https://tecton.q2developer.com/ui/q2-input/) for all `type` values.
+     */
+    type: Q2Input['type'];
+    /** Serves as the visible text while in the read state, and the default value of the input while in the edit state. */
+    value: string;
+    /** @deprecated */
+    ariaLabel: string;
+    scheduledAfterRender: (() => void)[];
+    hostElement: HTMLElement;
+    inputElement: HTMLQ2InputElement;
+    editBtnElement: HTMLQ2BtnElement;
+    cancelBtnElement: HTMLQ2BtnElement;
+    saveBtnElement: HTMLQ2BtnElement;
+    formattedValue: string;
+    innerValue: string;
+    defaultValue: string;
+    get locLabel(): string;
+    componentWillLoad(): void;
+    componentDidRender(): void;
+    componentDidLoad(): void;
+    errorsObserver(): void;
+    ariaLabelObserver(): void;
+    observesEditing(newValue: boolean, oldValue: boolean): void;
+    get wrapperClass(): string;
+    onHostElementChange(event: CustomEvent): void;
+    delegateFocus(event: FocusEvent): void;
+    /**
+     * Emitted when the user updates the `q2-input` element in the editing state.
+     */
+    input: EventEmitter<{
+        formattedValue: string;
+        value: string;
+    }>;
+    /**
+     * Emitted when the 'Edit', 'Cancel', or 'Save' buttons are clicked.
+     *
+     * The event detail will not include a `value` or `formattedValue` if the event name is 'edit' or 'cancel'.
+     */
+    change: EventEmitter<{
+        editing: boolean;
+        name: 'edit' | 'cancel' | 'save';
+        value?: string;
+        formattedValue?: string;
+    }>;
+    /**
+     * Emulates clicking the edit button, which will display the `<q2-input>` field.
+     *
+     * @testOnly
+     */
+    clickEdit(): void;
+    /**
+     * Emulates clicking the cancel button, which will hide the `<q2-input>` field.
+     *
+     * @testOnly
+     */
+    clickCancel(): void;
+    /**
+     * Emulates clicking the save button, saving value in the `<q2-input>` field, and emitting a `change` event.
+     *
+     * @testOnly
+     */
+    clickSave(): void;
+    /**
+     * Emulates clicking the edit button, and setting the value of the `<q2-input>` field.
+     *
+     * If the `clickSave` argument is `true` (default), the save button will be clicked after the value is set, and a\
+     * `change` event will be emitted.
+     *
+     * @testOnly
+     */
+    setValue(value: string, options?: {
+        clickSave?: boolean;
+    }): Promise<void>;
+    inputInput: (event: Q2InputCustomEvent<IEventDetail> & InputEvent) => void;
+    inputChange: (e: CustomEvent) => void;
+    inputKeyDown: (e: KeyboardEvent) => void;
+    inputClick: (event: MouseEvent) => void;
+    saveClick: (event?: MouseEvent) => void;
+    editClick: (event: MouseEvent) => void;
+    cancelClick: (event?: MouseEvent) => void;
+    render(): any;
+    generateEditStateDOM(): any;
+    generateReadStateDOM(): any;
+    generateEditBtn(): any;
+}

package/dist/types/components/q2-loading/skeleton/shapes.d.ts

@@ -1,3 +1,4 @@
+import { JSX } from './../../../components';
 interface AtomOptions {
     width?: string;
     height?: string;

package/dist/types/components/q2-optgroup/q2-optgroup.d.ts

@@ -12,7 +12,7 @@ export declare class Q2Optgroup implements ComponentInterface {
     disconnectedCallback(): void;
     setHidden: () => void;
     get headerId(): string;
-    get options(): Element[];
+    get options(): HTMLQ2OptionElement[];
     disabledWatcher(disabled: boolean): void;
     render(): any;
 }

package/dist/types/components/q2-option-list/q2-option-list.d.ts

@@ -0,0 +1,99 @@
+import { ComponentInterface, EventEmitter } from '../../stencil-public-runtime';
+export interface IOptionValue {
+    value: string;
+    display?: string;
+}
+export declare class Q2OptionList implements ComponentInterface {
+    align: 'left' | 'right';
+    /** Indicates a custom search is being implemented for the option list. */
+    customSearch: boolean;
+    /** Disables the option list. */
+    disabled: boolean;
+    /** Determines the label that is applied to the option list for accessibility purposes. */
+    label: string;
+    /**
+     * Enables the multi-select ability for the option list.
+     * @info
+     * Only applicable when options are provided.
+     */
+    multiple: boolean;
+    /** Disables the logic that handles selecting and focusing an option in the option list. */
+    noSelect: boolean;
+    /** A list of the selected options on the element. */
+    selectedOptions: IOptionValue[];
+    /** Applies focus to the selected option. */
+    showSelected: boolean;
+    /** Translates to the role of the option list */
+    type: 'menu' | 'listbox';
+    /**
+     * Emitted when an option is selected or deselected.
+     *
+     * When the multi-select is enabled, the `value` property will be `undefined` and the `selectedOptions` property
+     * will contain the selected option values.
+     */
+    change: EventEmitter<{
+        value: string;
+        values: IOptionValue[];
+    }>;
+    /**
+     * Emitted to indicate the intended state of the popover.
+     * @private
+     */
+    popoverState: EventEmitter<{
+        open: boolean;
+        action: 'close' | 'select' | 'open';
+    }>;
+    /**
+     * Emitted when the component has finished rendering.
+     * @private
+     */
+    ready: EventEmitter<undefined>;
+    hasOptions: boolean;
+    contentElement: HTMLElement;
+    activeIndex: number;
+    pivotIndex: number;
+    scheduledAfterRender: (() => void)[];
+    searchString: string;
+    searchStringTimer: number;
+    keyStore: {
+        queue: string[];
+        lastPressedAt: Date;
+    };
+    hostElement: HTMLElement;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentDidRender(): void;
+    get allContents(): (HTMLQ2OptgroupElement | HTMLQ2OptionElement)[];
+    get allOptions(): HTMLQ2OptionElement[];
+    get allVisibleOptions(): HTMLQ2OptionElement[];
+    checkOptions(): Promise<void>;
+    getRootSlot(element: Element): Element[];
+    scrollToActiveOption(): void;
+    openDropdownWithActiveElement(activeIndex: number): Promise<void>;
+    getDefaultActiveIndex(): number;
+    updateSingleOptionAttrs(): void;
+    updateMultipleOptionAttrs(): void;
+    setActiveOption(): void;
+    setFocusedOption(): void;
+    getNextVisibleIndex(direction: any): number;
+    focusSelectedSibling(option: HTMLQ2OptionElement): void;
+    selectOption(selectedOption: HTMLQ2OptionElement): void;
+    adjustActiveOptionAndScroll(numToAdd: number): void;
+    resetTimer(): void;
+    searchAndFocus: (keyValue: string, shouldSelect: boolean) => void;
+    searchOptions(key: string, shouldSelect?: boolean): void;
+    showSelectedUpdated(showSelected: boolean): void;
+    selectedOptionsUpdated(): void;
+    delegateFocus(event: FocusEvent): void;
+    handleClick(event: MouseEvent): void;
+    setDefaultActiveElement(): Promise<void>;
+    setActiveElement(index: number): Promise<void>;
+    handleExternalKeydown(event: KeyboardEvent): Promise<void>;
+    getContents(): Promise<(HTMLQ2OptgroupElement | HTMLQ2OptionElement)[]>;
+    getOptions(): Promise<HTMLQ2OptionElement[]>;
+    externalKeydownHandler: (event: KeyboardEvent) => void;
+    internalKeydownHandler: (event: KeyboardEvent) => void;
+    focusoutHandler: (event: FocusEvent) => void;
+    clickHandler: (event: Event) => void;
+    render(): any;
+}

package/dist/types/components/q2-pagination/q2-pagination.d.ts

@@ -0,0 +1,60 @@
+import { ComponentInterface, EventEmitter } from '../../stencil-public-runtime';
+export declare class Q2Pagination implements ComponentInterface {
+    /** Determines whether the component uses the dynamic resizing behavior. */
+    autoSize: boolean;
+    /** The total number of records to paginate. */
+    total: number;
+    /** The current page that is being displayed. */
+    page: number;
+    /**
+     * The number of pages that can be displayed.
+     * @info
+     * Only referenced when `pagesOnly` is true.
+     */
+    pages: number;
+    /** Indicates to only display the current and total pages. */
+    pagesOnly: boolean;
+    /** The total number of records displayed on each page. */
+    perPage: number;
+    /** The list of perPage to operate pagination. e.g.) [10, 25, 50] */
+    perPageIncrements: number[];
+    /** Indicates to only display the current and total records. */
+    recordsOnly: boolean;
+    /** Description of the record type to be displayed alongside the record count. */
+    recordType: string;
+    /** Indicates the horizontal alignment of children elements */
+    alignment: string;
+    hostElement: HTMLElement;
+    /**
+     * Emitted when the page is changed.
+     * @legacyEvent
+     */
+    change: EventEmitter<{
+        page: number;
+    }>;
+    isSmall: boolean;
+    inputField: HTMLQ2InputElement;
+    containerElement: HTMLElement;
+    containerWidth: number;
+    resizeObserver: ResizeObserver;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    disconnectedCallback(): void;
+    manageResizeObserver(): void;
+    onHostElementFocus(event: any): void;
+    get isFullViewHidden(): boolean;
+    get pageWithDefault(): number;
+    get perPageWithDefault(): number;
+    get totalWithDefault(): number;
+    get recordTypeWithDefault(): string;
+    get currentRange(): string;
+    get nextRange(): string;
+    get prevRange(): string;
+    get totalPages(): number;
+    removeResizeObserver(): void;
+    handlePageChange: (page: number) => void;
+    handlePerPageChange: (event: CustomEvent) => void;
+    checkSize: () => void;
+    renderPerPage(): any;
+    render(): any;
+}

package/dist/types/components/q2-pill/q2-pill.d.ts

@@ -0,0 +1,102 @@
+import { ComponentInterface, EventEmitter } from '../../stencil-public-runtime';
+import { IOptionValue } from '../q2-option-list/q2-option-list';
+export declare class Q2Pill implements ComponentInterface {
+    /** Determine if the elements is in the selected state, with values. */
+    active: boolean;
+    /** Indicates the pill cannot be focused or interacted with. */
+    disabled: boolean;
+    /** Indicates that the pill has no border */
+    borderless: boolean;
+    /**
+     * Instructs the component to use the action sheet workflow for displaying its options.
+     *
+     * For more information, see [Action Sheets](https://tecton.q2developer.com/guides/action-sheets/).
+     */
+    hoist: boolean;
+    /**
+     * The text that populates the label.
+     * @localizable
+     */
+    label: string;
+    /**
+     * The maximum number of characters to display before ellipcizing.
+     * @info
+     * Limitless by default.
+     */
+    maxLength: number;
+    /**
+     * Enables the multi-select ability for the dropdown.
+     * @info
+     * Only applicable when options are provided.
+     */
+    multiple: boolean;
+    /** Determine whether the popover is open or closed. */
+    open: boolean;
+    /** Determines the label that is applied to the option list for accessibility purposes. */
+    optionListLabel: string;
+    /**
+     * Force the direction of the popover dropdown when it opens.
+     * If no value is passed, the component will auto-detect the direction based on available space.
+     */
+    popoverDirection: 'up' | 'down';
+    /** Aligns the popover dropdown to the left or right side of the input field. */
+    popoverAlignment: 'left' | 'right';
+    /** @deprecated */
+    popoverMinHeight: number;
+    /** A list of the selected options on the element. */
+    selectedOptions: IOptionValue[];
+    /** The color of the element when in the active state. */
+    theme: 'primary' | 'secondary' | 'tertiary';
+    /** The value emitted when the component is selected. */
+    value: string;
+    optionCount: number;
+    selectedOptionElements: HTMLQ2OptionElement[];
+    hostElement: HTMLElement;
+    /**
+     * Emitted when the pill is clicked or the selected options change.
+     * @legacyEvent
+     */
+    change: EventEmitter<{
+        value: string;
+        values: IOptionValue[];
+        active: boolean;
+    }>;
+    scheduledAfterRender: (() => void)[];
+    primaryBtn: HTMLButtonElement;
+    primaryBtnWrapper: HTMLElement;
+    optionList: HTMLQ2OptionListElement;
+    mutationObserver: MutationObserver;
+    popoverElement: HTMLQ2PopoverElement;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentDidRender(): void;
+    disconnectedCallback(): void;
+    get buttonContent(): string;
+    get truncatedButtonContent(): string;
+    syncValueProperties: () => void;
+    getOption: (value: string) => Promise<HTMLQ2OptionElement>;
+    updateSelectedOptionElements: () => Promise<void>;
+    determineOptionCount: () => void;
+    executeActionSheet(event: MouseEvent | KeyboardEvent): Promise<void>;
+    handleSelectionChanges(changeDetails: {
+        value?: string;
+        values?: IOptionValue[];
+    }): Promise<void>;
+    clearSelectedOptions: () => void;
+    valueChanged(newValue: any): Promise<void>;
+    selectedOptionsChanged(newValue: any): void;
+    delegateFocus(event: FocusEvent): void;
+    popoverStateHandler({ detail: { open } }: CustomEvent<{
+        open: boolean;
+    }>): void;
+    handleSelectedDisplay(): void;
+    handleClick: (event: MouseEvent) => Promise<void>;
+    handleKeydown: (event: KeyboardEvent) => Promise<void>;
+    handleButtonFocusout: (event: FocusEvent) => Promise<void>;
+    handleChange: (event: any) => void;
+    handleWrapperClick: () => void;
+    onClickElsewhere: (event: CustomEvent) => void;
+    generateIcon(): any;
+    generateHiddenElement(): any;
+    render(): any;
+}

package/dist/types/components/q2-popover/q2-popover.d.ts

@@ -31,8 +31,8 @@ export declare class Q2Popover implements ComponentInterface {
      * The number of pixels to leave between the popover and the edge of the viewport
      */
     displayBuffer: number;
-    /** remove when Popover API is supported in iOS */
     orientationChanged: boolean;
+    componentWillLoad(): void;
     componentDidLoad(): void;
     disconnectedCallback(): void;
     toggle(): Promise<void>;
@@ -42,14 +42,16 @@ export declare class Q2Popover implements ComponentInterface {
     popoverStateHandler(event: CustomEvent<{
         open: boolean;
     }>): void;
-    get actualDirection(): 'up' | 'down' | undefined;
+    get providedDirection(): 'up' | 'down' | undefined;
     get isModule(): boolean;
+    get supportsPopoverAPI(): boolean;
     handleMinHeight: () => void;
+    handlePopoverToggleEvent: (event: ToggleEvent) => void;
     viewPortChanged: () => void;
     viewPortOrientationChanged: () => void;
     addViewportListeners(): void;
     removeViewportListeners(): void;
-    setFixedCSSProperties: () => Promise<void>;
+    setPopoverAPICSSProperties: () => Promise<void>;
     setAbsoluteCSSProperties: () => Promise<void>;
     clearCSSProperties(): void;
     setDirectionAndShow(direction: 'up' | 'down'): void;