@aquera/nile-elements 0.1.46-beta-1.9 → 0.1.46-beta-2.0

package/dist/types/src/nile-input/nile-input.d.ts

@@ -0,0 +1,171 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { TemplateResult } from 'lit';
+import '../nile-icon';
+import type { CSSResultGroup } from 'lit';
+import NileElement, { NileFormControl } from '../internal/nile-element';
+/**
+ * Nile icon component.
+ *
+ * @tag nile-input
+ *
+ */
+export declare class NileInput extends NileElement implements NileFormControl {
+    static styles: CSSResultGroup;
+    private readonly formControlController;
+    private readonly hasSlotController;
+    input: HTMLInputElement;
+    private hasFocus;
+    title: string;
+    /**
+     * The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults
+     * to `text`.
+     */
+    type: 'date' | 'datetime-local' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'text' | 'time' | 'url';
+    /** The name of the input, submitted as a name/value pair with form data. */
+    name: string;
+    /** The current value of the input, submitted as a name/value pair with form data. */
+    value: string;
+    checkNonPrintableChar: boolean;
+    /** The default value of the form control. Primarily used for resetting the form control. */
+    defaultValue: string;
+    /** The input's size. */
+    size: 'small' | 'medium' | 'large';
+    /** Draws a filled input. */
+    filled: boolean;
+    /** Sets the input to a warning state, changing its visual appearance. */
+    warning: boolean;
+    /** Sets the input to an error state, changing its visual appearance. */
+    error: boolean;
+    /** Sets the input to a success state, changing its visual appearance. */
+    success: boolean;
+    /** Sets the input to a Destructive state, changing its visual appearance. */
+    destructive: boolean;
+    /** Draws a pill-style input with rounded edges. */
+    pill: boolean;
+    /** The input's label. If you need to display HTML, use the `label` slot instead. */
+    label: string;
+    helpText: string;
+    errorMessage: string;
+    /** Adds a clear button when the input is not empty. */
+    clearable: boolean;
+    /** Disables the input. */
+    disabled: boolean;
+    /** Placeholder text to show as a hint when the input is empty. */
+    placeholder: string;
+    /** Makes the input readonly. */
+    readonly: boolean;
+    /** Adds a button to toggle the password's visibility. Only applies to password types. */
+    passwordToggle: boolean;
+    /** Determines whether or not the password is currently visible. Only applies to password input types. */
+    passwordVisible: boolean;
+    /** Hides the browser's built-in increment/decrement spin buttons for number inputs. */
+    noSpinButtons: boolean;
+    /**
+     * By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you
+     * to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
+     * the same document or shadow root for this to work.
+     */
+    form: string;
+    /** Makes the input a required field. */
+    required: boolean;
+    /** A regular expression pattern to validate input against. */
+    pattern: string;
+    /** The minimum length of input that will be considered valid. */
+    minlength: number;
+    /** The maximum length of input that will be considered valid. */
+    maxlength: number;
+    /** The input's minimum value. Only applies to date and number input types. */
+    min: number | string;
+    /** The input's maximum value. Only applies to date and number input types. */
+    max: number | string;
+    /**
+     * Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is
+     * implied, allowing any numeric value. Only applies to date and number input types.
+     */
+    step: number | 'any';
+    /** Controls whether and how text input is automatically capitalized as it is entered by the user. */
+    autocapitalize: 'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters';
+    /** Indicates whether the browser's autocorrect feature is on or off. */
+    autocorrect: 'off' | 'on';
+    /**
+     * Specifies what permission the browser has to provide assistance in filling out form field values. Refer to
+     * [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.
+     */
+    autocomplete: string;
+    /** Indicates that the input should receive focus on page load. */
+    autofocus: boolean;
+    /** Used to customize the label or icon of the Enter key on virtual keyboards. */
+    enterkeyhint: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
+    /** Enables spell checking on the input. */
+    spellcheck: boolean;
+    canSavePassword: boolean;
+    /**
+     * Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual
+     * keyboard on supportive devices.
+     */
+    inputmode: 'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url';
+    hasPrintableCharacters: boolean;
+    markedValue: string;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    /** Gets or sets the current value as a `Date` object. Returns `null` if the value can't be converted. */
+    get valueAsDate(): Date | null;
+    set valueAsDate(newValue: Date | null);
+    /** Gets or sets the current value as a number. Returns `NaN` if the value can't be converted. */
+    get valueAsNumber(): number;
+    set valueAsNumber(newValue: number);
+    /** Gets the validity state object */
+    get validity(): ValidityState;
+    /** Gets the validation message */
+    get validationMessage(): string;
+    firstUpdated(): void;
+    private handleBlur;
+    private handleChange;
+    private handleClearClick;
+    private handleFocus;
+    private handleInput;
+    private handleInvalid;
+    private handleKeyDown;
+    private handlePasswordToggle;
+    handleDisabledChange(): void;
+    handleStepChange(): void;
+    handleValueChange(): Promise<void>;
+    /** checks non printable characters in the value. */
+    markNonPrintableCharacters(): void;
+    /** Removes all non printable characters from the value. */
+    removeAllNonPrintableCharacters(): void;
+    /** Sets focus on the input. */
+    focus(options?: FocusOptions): void;
+    /** Removes focus from the input. */
+    blur(): void;
+    /** Selects all the text in the input. */
+    select(): void;
+    /** Sets the start and end positions of the text selection (0-based). */
+    setSelectionRange(selectionStart: number, selectionEnd: number, selectionDirection?: 'forward' | 'backward' | 'none'): void;
+    /** Replaces a range of text with a new string. */
+    setRangeText(replacement: string, start?: number, end?: number, selectMode?: 'select' | 'start' | 'end' | 'preserve'): void;
+    /** Increments the value of a numeric input type by the value of the step attribute. */
+    stepUp(): void;
+    /** Decrements the value of a numeric input type by the value of the step attribute. */
+    stepDown(): void;
+    /** Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid. */
+    checkValidity(): boolean;
+    /** Gets the associated form, if one exists. */
+    getForm(): HTMLFormElement | null;
+    /** Checks for validity and shows the browser's validation message if the control is invalid. */
+    reportValidity(): boolean;
+    /** Sets a custom validation message. Pass an empty string to restore validity. */
+    setCustomValidity(message: string): void;
+    render(): TemplateResult<1>;
+}
+export default NileInput;
+declare global {
+    interface HTMLElementTagNameMap {
+        'nile-input': NileInput;
+    }
+}

package/dist/types/src/nile-input/nile-input.test.d.ts

@@ -0,0 +1 @@
+import './nile-input';

package/dist/types/src/nile-link/index.d.ts

@@ -0,0 +1 @@
+export { NileLink } from './nile-link';

package/dist/types/src/nile-link/nile-link.css.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Link CSS
+ */
+export declare const styles: import("lit").CSSResult;
+declare const _default: import("lit").CSSResult[];
+export default _default;

package/dist/types/src/nile-link/nile-link.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { CSSResultArray, TemplateResult } from 'lit';
+import NileElement from '../internal/nile-element';
+/**
+ * Nile icon component.
+ *
+ * @tag nile-link
+ *
+ */
+export declare class NileLink extends NileElement {
+    /**
+     * The styles for Link
+     * @remarks If you are extending this class you can extend the base styles with super. Eg `return [super(), myCustomStyles]`
+     */
+    static get styles(): CSSResultArray;
+    private readonly hasSlotController;
+    private hasFocus;
+    /** Disables the button. */
+    disabled: boolean;
+    button: boolean;
+    href: string;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private handleHostClick;
+    private handleBlur;
+    private handleFocus;
+    handleClick(e: MouseEvent): void;
+    /**
+     * Render method
+     * @slot This is a slot test
+     */
+    render(): TemplateResult;
+}
+export default NileLink;
+declare global {
+    interface HTMLElementTagNameMap {
+        'nile-link': NileLink;
+    }
+}

package/dist/types/src/nile-link/nile-link.test.d.ts

@@ -0,0 +1 @@
+import './nile-link';

package/dist/types/src/nile-list/index.d.ts

@@ -0,0 +1 @@
+export { NileList } from './nile-list';

package/dist/types/src/nile-list/nile-list.css.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * List CSS
+ */
+export declare const styles: import("lit").CSSResult;
+declare const _default: import("lit").CSSResult[];
+export default _default;

package/dist/types/src/nile-list/nile-list.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { CSSResultArray, TemplateResult } from 'lit';
+import NileElement from '../internal/nile-element';
+/**
+ * Nile list component.
+ *
+ * @tag nile-list
+ *
+ */
+export declare class NileList extends NileElement {
+    /**
+     * The styles for nile-list
+     * @remarks If you are extending this class you can extend the base styles with super. Eg `return [super(), myCustomStyles]`
+     */
+    static get styles(): CSSResultArray;
+    /**
+     * Render method
+     * @slot This is a slot test
+     */
+    handleListItemClick(e: any): void;
+    render(): TemplateResult;
+}
+export default NileList;
+declare global {
+    interface HTMLElementTagNameMap {
+        'nile-list': NileList;
+    }
+}

package/dist/types/src/nile-list-item/index.d.ts

@@ -0,0 +1 @@
+export { NileListItem } from './nile-list-item';

package/dist/types/src/nile-list-item/nile-list-item.css.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * ListItem CSS
+ */
+export declare const styles: import("lit").CSSResult;
+declare const _default: import("lit").CSSResult[];
+export default _default;

package/dist/types/src/nile-list-item/nile-list-item.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { CSSResultArray, TemplateResult } from 'lit';
+import NileElement from '../internal/nile-element';
+/**
+ * Nile list-item component.
+ *
+ * @tag nile-list-item
+ *
+ */
+export declare class NileListItem extends NileElement {
+    /**
+     * The styles for nile-list-item
+     * @remarks If you are extending this class you can extend the base styles with super. Eg `return [super(), myCustomStyles]`
+     */
+    private readonly hasSlotController;
+    static get styles(): CSSResultArray;
+    iconName: string;
+    iconSize: number;
+    heading: string;
+    subHeading: string;
+    /**
+     * Render method
+     * @slot This is a slot test
+     */
+    handleClick(e: any): void;
+    render(): TemplateResult;
+}
+export default NileListItem;
+declare global {
+    interface HTMLElementTagNameMap {
+        'nile-list-item': NileListItem;
+    }
+}

package/dist/types/src/nile-loader/index.d.ts

@@ -0,0 +1 @@
+export { NileLoader } from './nile-loader';

package/dist/types/src/nile-loader/nile-loader.css.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("lit").CSSResult;
+export default _default;

package/dist/types/src/nile-loader/nile-loader.d.ts

@@ -0,0 +1,25 @@
+import { CSSResultGroup } from 'lit';
+import { LitElement, TemplateResult } from 'lit';
+export declare class NileLoader extends LitElement {
+    propHeight: string;
+    propWidth: string;
+    label: string;
+    size: 'sm' | 'md' | 'lg' | 'xl';
+    margin: string;
+    variant: string;
+    color: string;
+    private height;
+    private width;
+    connectedCallback(): void;
+    static styles: CSSResultGroup;
+    /**
+     * Sets circular loader's dimension.
+     * If either height or width is absent the dimensions defaults to dimension based on size variant
+     */
+    setSvgDimensions(): void;
+    render(): TemplateResult<1>;
+    private getVariant;
+    private renderV1;
+    private renderV2;
+    private renderV3;
+}

package/dist/types/src/nile-loader/nile-loader.test.d.ts

@@ -0,0 +1 @@
+import './nile-loader';

package/dist/types/src/nile-menu/index.d.ts

@@ -0,0 +1 @@
+export { NileMenu } from './nile-menu';

package/dist/types/src/nile-menu/nile-menu.css.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Menu CSS
+ */
+export declare const styles: import("lit").CSSResult;
+declare const _default: import("lit").CSSResult[];
+export default _default;

package/dist/types/src/nile-menu/nile-menu.d.ts

@@ -0,0 +1,52 @@
+import NileElement from '../internal/nile-element';
+import type { CSSResultGroup } from 'lit';
+import type NileMenuItem from '../nile-menu-item/nile-menu-item';
+/**
+ * An nile-menu element.
+ * @summary Menus provide a list of options for the user to choose from.
+ *
+ * @slot - The menu's content, including menu items, menu labels, and dividers.
+ *
+ * @event nile-select - Emitted when a menu item is selected.
+ * @fires count-changed - Indicates when the count changes
+ * @slot - This element has a slot
+ * @csspart button - The button
+ */
+export declare class NileMenu extends NileElement {
+    static styles: CSSResultGroup;
+    searchValue: string;
+    searchWidth: number;
+    searchEnabled: boolean;
+    customSearch: boolean;
+    showNoResults: boolean;
+    allowSpaceKey: boolean;
+    noResultsMessage: string;
+    defaultSlot: HTMLSlotElement;
+    private readonly hasSlotController;
+    connectedCallback(): void;
+    private handleClick;
+    private handleKeyDown;
+    private handleMouseDown;
+    private handleSlotChange;
+    private isMenuItem;
+    /** @internal Gets all slotted menu items, ignoring dividers, headers, and other elements. */
+    getAllItems(): NileMenuItem[];
+    /**
+     * @internal Gets the current menu item, which is the menu item that has `tabindex="0"` within the roving tab index.
+     * The menu item may or may not have focus, but for keyboard interaction purposes it's considered the "active" item.
+     */
+    getCurrentItem(): NileMenuItem | undefined;
+    /**
+     * @internal Sets the current menu item to the specified element. This sets `tabindex="0"` on the target element and
+     * `tabindex="-1"` to all other items. This method must be called prior to setting focus on a menu item.
+     */
+    setCurrentItem(item: NileMenuItem): void;
+    private handleSearchChange;
+    render(): import("lit-html").TemplateResult<1>;
+}
+export default NileMenu;
+declare global {
+    interface HTMLElementTagNameMap {
+        'nile-menu': NileMenu;
+    }
+}

package/dist/types/src/nile-menu-item/index.d.ts

@@ -0,0 +1 @@
+export { NileMenuItem } from './nile-menu-item';

package/dist/types/src/nile-menu-item/nile-menu-item.css.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * MenuItem CSS
+ */
+export declare const styles: import("lit").CSSResult;
+declare const _default: import("lit").CSSResult[];
+export default _default;

package/dist/types/src/nile-menu-item/nile-menu-item.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { TemplateResult } from 'lit';
+import '../nile-icon';
+import NileElement from '../internal/nile-element';
+import type { CSSResultGroup } from 'lit';
+/**
+ * Nile icon component.
+ *
+ * @tag nile-menu-item
+ *
+ * @summary Menu items provide options for the user to pick from in a menu.
+ * @status stable
+ * @since 2.0
+ *
+ * @dependency nile-icon
+ *
+ * @slot - The menu item's label.
+ * @slot prefix - Used to prepend an icon or similar element to the menu item.
+ * @slot suffix - Used to append an icon or similar element to the menu item.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart checked-icon - The checked icon, which is only visible when the menu item is checked.
+ * @csspart prefix - The prefix container.
+ * @csspart label - The menu item label.
+ * @csspart suffix - The suffix container.
+ * @csspart submenu-icon - The submenu icon, visible only when the menu item has a submenu (not yet implemented).
+ */
+export declare class NileMenuItem extends NileElement {
+    static styles: CSSResultGroup;
+    private cachedTextLabel;
+    defaultSlot: HTMLSlotElement;
+    menuItem: HTMLElement;
+    /** The type of menu item to render. To use `checked`, this value must be set to `checkbox`. */
+    type: 'normal' | 'checkbox';
+    /** Draws the item in a checked state. */
+    checked: boolean;
+    /** A unique value to store in the menu item. This can be used as a way to identify menu items when selected. */
+    value: string;
+    /** Draws the menu item in a disabled state, preventing selection. */
+    disabled: boolean;
+    /** Draws the item in a checked state. */
+    hasSubMenu: boolean;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private handleDefaultSlotChange;
+    private handleHostClick;
+    handleCheckedChange(): void;
+    handleDisabledChange(): void;
+    handleTypeChange(): void;
+    /** Returns a text label based on the contents of the menu item's default slot. */
+    getTextLabel(): string;
+    render(): TemplateResult<1>;
+}
+export default NileMenuItem;
+declare global {
+    interface HTMLElementTagNameMap {
+        'nile-menu-item': NileMenuItem;
+    }
+}

package/dist/types/src/nile-option/index.d.ts

@@ -0,0 +1 @@
+export { NileOption } from './nile-option';

package/dist/types/src/nile-option/nile-option.css.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Option_2 CSS
+ */
+export declare const styles: import("lit").CSSResult;
+declare const _default: import("lit").CSSResult[];
+export default _default;

package/dist/types/src/nile-option/nile-option.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { TemplateResult } from 'lit';
+import '../nile-icon';
+import type { CSSResultGroup } from 'lit';
+import NileElement from '../internal/nile-element';
+import '../nile-checkbox';
+/**
+ * Nile icon component.
+ *
+ * @tag nile-option
+ *
+ */
+/**
+ * @summary Options define the selectable items within various form controls such as [select](/components/select).
+ * @status stable
+ *
+ * @dependency nile-icon
+ *
+ * @slot - The option's label.
+ * @slot prefix - Used to prepend an icon or similar element to the menu item.
+ * @slot suffix - Used to append an icon or similar element to the menu item.
+ *
+ * @csspart checked-icon - The checked icon, an `<nile-icon>` element.
+ * @csspart base - The component's base wrapper.
+ * @csspart label - The option's label.
+ * @csspart prefix - The container that wraps the prefix.
+ * @csspart suffix - The container that wraps the suffix.
+ */
+export declare class NileOption extends NileElement {
+    static styles: CSSResultGroup;
+    private cachedTextLabel;
+    defaultSlot: HTMLSlotElement;
+    current: boolean;
+    selected: boolean;
+    hasHover: boolean;
+    hidden: boolean;
+    isMultipleSelect: boolean;
+    /**
+     * The option's value. When selected, the containing form control will receive this value. The value must be unique
+     * from other options in the same group. Values may not contain spaces, as spaces are used as delimiters when listing
+     * multiple values.
+     */
+    value: string;
+    /** Draws the option in a disabled state, preventing selection. */
+    disabled: boolean;
+    connectedCallback(): void;
+    private handleDefaultSlotChange;
+    private handleMouseEnter;
+    private handleMouseLeave;
+    handleDisabledChange(): void;
+    handleSelectedChange(): void;
+    handleValueChange(): void;
+    /** Returns a plain text label based on the option's content. */
+    getTextLabel(): string;
+    render(): TemplateResult<1>;
+}
+export default NileOption;
+declare global {
+    interface HTMLElementTagNameMap {
+        'nile-option': NileOption;
+    }
+}

package/dist/types/src/nile-page-header/index.d.ts

@@ -0,0 +1 @@
+export { NilePageHeader } from './nile-page-header';

package/dist/types/src/nile-page-header/nile-page-header.css.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * PageHeader CSS
+ */
+export declare const styles: import("lit").CSSResult;
+declare const _default: import("lit").CSSResult[];
+export default _default;

package/dist/types/src/nile-page-header/nile-page-header.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright Aquera Inc 2023
+ *
+ * This source code is licensed under the BSD-3-Clause license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { CSSResultArray, TemplateResult } from 'lit';
+import NileElement from '../internal/nile-element';
+/**
+ * Nile page-header component.
+ *
+ * @tag nile-page-header
+ *
+ */
+export declare class NilePageHeader extends NileElement {
+    /**
+     * The styles for nile-page-header
+     * @remarks If you are extending this class you can extend the base styles with super. Eg `return [super(), myCustomStyles]`
+     */
+    static get styles(): CSSResultArray;
+    heading: string;
+    subHeading: string;
+    /**
+     * Render method
+     * @slot This is a slot test
+     */
+    render(): TemplateResult;
+}
+export default NilePageHeader;
+declare global {
+    interface HTMLElementTagNameMap {
+        'nile-page-header': NilePageHeader;
+    }
+}