@material/web 1.0.0-pre.13 → 1.0.0-pre.15

package/select/internal/select.d.ts

@@ -0,0 +1,201 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import '../../menu/menu.js';
+import { LitElement, PropertyValues } from 'lit';
+import { StaticValue } from 'lit/static-html.js';
+import { SelectOption } from './shared.js';
+declare const VALUE: unique symbol;
+/**
+ * @fires input Fired when a selection is made by the user via mouse or keyboard
+ * interaction.
+ * @fires change Fired when a selection is made by the user via mouse or
+ * keyboard interaction.
+ */
+export declare abstract class Select extends LitElement {
+    /**
+     * Opens the menu synchronously with no animation.
+     */
+    quick: boolean;
+    /**
+     * Whether or not the select is required.
+     */
+    required: boolean;
+    /**
+     * Disables the select.
+     */
+    disabled: boolean;
+    /**
+     * The error message that replaces supporting text when `error` is true. If
+     * `errorText` is an empty string, then the supporting text will continue to
+     * show.
+     *
+     * Calling `reportValidity()` will automatically update `errorText` to the
+     * native `validationMessage`.
+     */
+    errorText: string;
+    /**
+     * The floating label for the field.
+     */
+    label: string;
+    /**
+     * Conveys additional information below the text field, such as how it should
+     * be used.
+     */
+    supportingText: string;
+    /**
+     * Gets or sets whether or not the text field is in a visually invalid state.
+     *
+     * Calling `reportValidity()` will automatically update `error`.
+     */
+    error: boolean;
+    /**
+     * Whether or not the underlying md-menu should be position: fixed to display
+     * in a top-level manner.
+     */
+    menuFixed: boolean;
+    /**
+     * The max time between the keystrokes of the typeahead select / menu behavior
+     * before it clears the typeahead buffer.
+     */
+    typeaheadDelay: number;
+    /**
+     * Whether or not the text field has a leading icon. Used for SSR.
+     */
+    hasLeadingIcon: boolean;
+    /**
+     * Text to display in the field. Only set for SSR.
+     */
+    displayText: string;
+    private focused;
+    private open;
+    private readonly field;
+    private readonly menu;
+    private readonly leadingIcons;
+    /**
+     * The value of the currently selected option.
+     *
+     * Note: For SSR, set `[selected]` on the requested option and `displayText`
+     * rather than setting `value` setting `value` will incur a DOM query.
+     */
+    get value(): string;
+    set value(value: string);
+    [VALUE]: string;
+    get options(): SelectOption[];
+    /**
+     * The index of the currently selected option.
+     *
+     * Note: For SSR, set `[selected]` on the requested option and `displayText`
+     * rather than setting `selectedIndex` setting `selectedIndex` will incur a
+     * DOM query.
+     */
+    get selectedIndex(): number;
+    set selectedIndex(index: number);
+    /**
+     * Returns an array of selected options.
+     *
+     * NOTE: md-select only suppoprts single selection.
+     */
+    get selectedOptions(): SelectOption[];
+    protected abstract readonly fieldTag: StaticValue;
+    /**
+     * Used for initializing select when the user sets the `value` directly.
+     */
+    private lastUserSetValue;
+    /**
+     * Used for initializing select when the user sets the `selectedIndex`
+     * directly.
+     */
+    private lastUserSetSelectedIndex;
+    /**
+     * Used for `input` and `change` event change detection.
+     */
+    private lastSelectedOption;
+    private lastSelectedOptionRecords;
+    protected render(): import("lit-html").TemplateResult<1>;
+    private getRenderClasses;
+    private renderField;
+    private renderFieldContent;
+    private renderLeadingIcon;
+    private renderTrailingIcon;
+    private renderLabel;
+    private renderMenu;
+    private renderMenuContent;
+    /**
+     * Handles opening the select on keydown and typahead selection when the menu
+     * is closed.
+     */
+    private handleKeydown;
+    private handleClick;
+    private handleFocus;
+    private handleBlur;
+    /**
+     * Handles closing the menu when the focus leaves the select's subtree.
+     */
+    private handleFocusout;
+    /**
+     * Gets a list of all selected select options as a list item record array.
+     *
+     * @return An array of selected list option records.
+     */
+    private getSelectedOptions;
+    getUpdateComplete(): Promise<boolean>;
+    /**
+     * Gets the selected options from the DOM, and updates the value and display
+     * text to the first selected option's value and headline respectively.
+     *
+     * @return Whether or not the selected option has changed since last update.
+     */
+    private updateValueAndDisplayText;
+    protected update(changed: PropertyValues<this>): void;
+    protected firstUpdated(changed: PropertyValues<this>): Promise<void>;
+    /**
+     * Focuses and activates the last selected item upon opening, and resets other
+     * active items.
+     */
+    private handleOpening;
+    private handleClosing;
+    /**
+     * Determines the reason for closing, and updates the UI accordingly.
+     */
+    private handleCloseMenu;
+    /**
+     * Selects a given option, deselects other options, and updates the UI.
+     *
+     * @return Whether the last selected option has changed.
+     */
+    private selectItem;
+    /**
+     * Handles updating selection when an option element requests selection via
+     * property / attribute change.
+     */
+    private handleRequestSelection;
+    /**
+     * Handles updating selection when an option element requests deselection via
+     * property / attribute change.
+     */
+    private handleRequestDeselection;
+    /**
+     * Selects an option given the value of the option, and updates MdSelect's
+     * value.
+     */
+    select(value: string): void;
+    /**
+     * Selects an option given the index of the option, and updates MdSelect's
+     * value.
+     */
+    selectIndex(index: number): void;
+    /**
+     * Attempts to initialize the selected option from user-settable values like
+     * SSR, setting `value`, or `selectedIndex` at startup.
+     */
+    private initUserSelection;
+    private handleIconChange;
+    /**
+     * Dispatches the `input` and `change` events.
+     */
+    private dispatchInteractionEvents;
+}
+export {};