@internetarchive/elements 0.1.1-webdev-8119.1 → 0.1.1-webdev-8151.2

package/dist/src/elements/ia-combo-box/ia-combo-box.d.ts

@@ -1,427 +0,0 @@
-import { LitElement, nothing, TemplateResult, CSSResultGroup, PropertyValues } from 'lit';
-import { type IAComboBoxBehavior, type IAComboBoxFilterOption, type IAComboBoxOption } from './models';
-/**
- * A flexible component combining the features of a dropdown menu and a text input,
- * allowing users to either select from a predefined list of options or type
- * freeform text to filter down & find specific options.
- */
-export declare class IAComboBox extends LitElement {
-    /**
-     * Array of options representing values that this combo box can take.
-     *
-     * If this combo box's `behavior` property is `select-only` or `list`, these options
-     * represent _all_ of the allowed values that the user may choose from.
-     *
-     * If this combo box's `behavior` property is `freeform`, this array simply represents
-     * a non-exhaustive list of _suggested_ values, which the user may either choose from
-     * or enter their own value.
-     * @see {@linkcode IAComboBox.behavior}
-     */
-    options: IAComboBoxOption[];
-    /**
-     * Optional placeholder text to display in the combo box when no option is selected.
-     */
-    placeholder?: string;
-    /**
-     * What style of behavior to use for the combo box.
-     *
-     * Currently, the options are
-     *  - `select-only` (behaving similar to a `<select>`, disallowing text entry and only
-     * allowing selection from the predefined, unfiltered options)
-     *  - `list` (the default, allowing text entry to filter the dropdown list, but still
-     * requiring values to be set from the predefined options)
-     *  - `freeform` (allows text entry to filter the dropdown list, and also allows setting
-     * custom values not included in the list)
-     */
-    behavior: IAComboBoxBehavior;
-    /**
-     * Maximum number of options to include in the autocomplete menu when filtering.
-     *
-     * Default value is `Infinity`, presenting all matching options regardless of count.
-     */
-    maxAutocompleteEntries: number;
-    /**
-     * Specifies how the options should be filtered when text is entered into the combo box.
-     * Has no effect if `behavior` is `select-only`, as the component is not text-editable.
-     *
-     * Default is `substring`, showing only options whose `text` contains the value entered
-     * as a substring at any position. The possible preset options are:
-     *  - `all`: Does not filter the dropdown entries. They will always all be shown (up to
-     * the limit specified by `maxAutocompleteEntries`).
-     *  - `prefix`: Only includes options whose text _starts_ with the entered value.
-     *  - `suffix`: Only includes options whose text _ends_ with the entered value.
-     *  - `substring`: Only includes options whose text contains the entered value as a
-     * contiguous substring.
-     *  - `subsequence`: Only shows options whose text has the characters of the entered
-     * value in order, though they do not need to be contiguous.
-     * E.g., `ace` is a subsequence of `archive` (but not a substring).
-     *
-     * If custom filtering outside of these presets is desired, an arbitrary filtering function
-     * may instead be bound to this property directly.
-     *
-     * @see {@link IAComboBox.caseSensitive} to enable case-sensitive filtering.
-     */
-    filter: IAComboBoxFilterOption;
-    /**
-     * Whether filtering should be case-sensitive. Default is `false`, performing only
-     * case-insensitive filtering.
-     */
-    caseSensitive: boolean;
-    /**
-     * Whether the filtered options should be listed in lexicographically-sorted order,
-     * respecting the current `caseSensitive` setting.
-     * Default is `false`, displaying them in the same order as the provided options array.
-     */
-    sort: boolean;
-    /**
-     * Whether the combo box allows multiple options to be selected at once.
-     * Default is `false`, allowing only a single option to be selected.
-     */
-    /**
-     * Whether pressing the Up/Down arrow keys should wrap focus back to the text input box
-     * while focus is already on the first/last option, respectively.
-     *
-     * Default is `false`, doing nothing upon such key presses.
-     */
-    wrapArrowKeys: boolean;
-    /**
-     * Whether the options list should remain open after an option is selected.
-     *
-     * Default is `false`, closing the options list when a selection is made.
-     */
-    stayOpen: boolean;
-    /**
-     * Whether the combo box shows a clear button when a value is selected.
-     * Default is `false`.
-     */
-    clearable: boolean;
-    /**
-     * Whether the combo box's option menu is currently expanded. Default is `false`.
-     */
-    open: boolean;
-    /**
-     * Whether the combo box should be rendered in its disabled state, preventing all
-     * interactions such as editing the text field or opening the options menu.
-     * Default is `false`.
-     */
-    disabled: boolean;
-    /**
-     * If used within a form, whether this combo box is required to have a value selected
-     * before the form may be submitted. Default is `false`.
-     */
-    required: boolean;
-    /**
-     * For `select-only` or `list` behavior, this value is the ID of the selected option,
-     * or `null` if there is no selection.
-     *
-     * For `freeform` behavior, this may be any string entered into the text field, and
-     * need not correspond to an option ID.
-     */
-    value: string | null;
-    /**
-     * Whether any part of this component currently has focus.
-     */
-    private hasFocus;
-    /**
-     * Which option in the dropdown menu is currently highlighted by the user. Not to be
-     * confused with the _selected_ option that has been committed, this field only
-     * represents the user's current navigation state within the menu, which they may
-     * subsequently select by, e.g., hitting Enter.
-     */
-    private highlightedOption;
-    /**
-     * The text than has been entered into the text input box.
-     */
-    private enteredText;
-    /**
-     * The text that we are currently using the filter the dropdown menu options.
-     */
-    private filterText;
-    private mainWidgetRow;
-    private textInput;
-    private optionsList;
-    static formAssociated: boolean;
-    static shadowRootOptions: ShadowRootInit;
-    private internals;
-    /**
-     * Set when part of the component blurs, and cleared when any part of it is focused.
-     * If still set on the next tick after a blur event, this serves as a signal that focus
-     * has moved away from the component as a whole and should be closed.
-     */
-    private losingFocus;
-    /**
-     * A cache of the mapping from option IDs to their corresponding options, so that
-     * we can more efficiently look up options by ID.
-     */
-    private optionsByID;
-    /**
-     * A cache of the values against which each option should be filtered, to minimize
-     * the work needed at filter time to handle case-insensitivity etc.
-     */
-    private optionFilteringValues;
-    /**
-     * A cache of the current set of options that is pre-sorted if the component's
-     * `sort` flag is set, or as provided otherwise. Just ensures we don't have to
-     * sort all the options again every time we filter them.
-     */
-    private optionsRespectingSortFlag;
-    /**
-     * A cache of the current set of filtered options, so that we don't have to
-     * recalculate it unnecessarily whenever the component is opened/closed/etc.
-     */
-    private filteredOptions;
-    constructor();
-    render(): TemplateResult | typeof nothing;
-    willUpdate(changed: PropertyValues): void;
-    updated(changed: PropertyValues): void;
-    /**
-     * Template for the main label for the combo box.
-     *
-     * Uses the contents of the `label` named slot as the label text.
-     */
-    private get labelTemplate();
-    /**
-     * Template for the text input field that users can edit to filter the available
-     * options or (if freeform behavior) to enter a custom value.
-     */
-    private get textInputTemplate();
-    /**
-     * Template for the clear button that is shown when the `clearable` property
-     * is true.
-     */
-    private get clearButtonTemplate();
-    /**
-     * Template for the caret open/closed icons to show beside the text input.
-     * The icons are wrapped in named slots to allow consumers to override them.
-     */
-    private get caretTemplate();
-    /**
-     * Template for the caret button to be shown beside the text input.
-     */
-    private get caretButtonTemplate();
-    /**
-     * Template for the options list that is displayed when the combo box is open.
-     */
-    private get optionsListTemplate();
-    /**
-     * Array of templates for all of the filtered options to be shown in the options menu.
-     */
-    private get optionTemplates();
-    /**
-     * Info message shown in the listbox when no options match the entered text.
-     * Renders within an `empty-options` named slot so that its content can be customized.
-     */
-    private get emptyOptionsTemplate();
-    /**
-     * Handler for when the pointer device enters an option element in the dropdown.
-     */
-    private handleOptionPointerEnter;
-    /**
-     * Handler for when the pointer device is moved within an option in the dropdown.
-     */
-    private handleOptionPointerMove;
-    /**
-     * Handler for when the user clicks on an option in the dropdown.
-     */
-    private handleOptionClick;
-    /**
-     * Handler for `keydown` events on various special keys.
-     */
-    private handleComboBoxKeyDown;
-    /**
-     * Handler for `input` events in the text input box.
-     */
-    private handleTextBoxInput;
-    /**
-     * Handler for when the Enter key is pressed
-     */
-    private handleEnterPressed;
-    /**
-     * Handler for when the Escape key is pressed
-     */
-    private handleEscapePressed;
-    /**
-     * Handler for when the Up Arrow key is pressed (without modifiers).
-     * @see {@linkcode handleAltUpArrowPressed()} for behavior under the Alt modifier.
-     */
-    private handleUpArrowPressed;
-    /**
-     * Handler for when the Down Arrow key is pressed (without modifiers).
-     * @see {@linkcode handleAltDownArrowPressed()} for behavior under the Alt modifier.
-     */
-    private handleDownArrowPressed;
-    /**
-     * Handler for when the Alt + Up Arrow key combo is pressed
-     */
-    private handleAltUpArrowPressed;
-    /**
-     * Handler for when the Alt + Down Arrow key combo is pressed
-     */
-    private handleAltDownArrowPressed;
-    /**
-     * Handler for when the Tab key is pressed
-     */
-    private handleTabPressed;
-    /**
-     * Handler for when the Space key is handleTabPressed
-     */
-    private handleSpacePressed;
-    /**
-     * Handler for clicks on the combo box input field or caret button.
-     */
-    private handleComboBoxClick;
-    /**
-     * Handler for when the clear button is clicked.
-     */
-    private handleClearButtonClick;
-    /**
-     * Handler for when any part of the combo box receives focus.
-     */
-    private handleFocus;
-    /**
-     * Handler for when any part of the combo box loses focus.
-     */
-    private handleBlur;
-    /**
-     * Handler for when the `value` of this component is changed externally
-     */
-    private handleValueChanged;
-    /**
-     * Highlights the first option shown in the filtered list.
-     */
-    private highlightFirstOption;
-    /**
-     * Highlights the last option shown in the filtered list.
-     */
-    private highlightLastOption;
-    /**
-     * Highlights the option before the currently highlighted one in the list, or the last one
-     * if none is highlighted.
-     */
-    private highlightPreviousOption;
-    /**
-     * Highlights the option after the currently highlighted one in the list, or the first one
-     * if none is highlighted.
-     */
-    private highlightNextOption;
-    /**
-     * Highlights the given option and scrolls it into view if necessary.
-     * If `null` is provided, any current highlight will be cleared.
-     */
-    private setHighlightedOption;
-    /**
-     * Changes this combo box's selected option to the one matching the specified ID.
-     *
-     * Throws a `RangeError` if given an ID that does not correspond to any option
-     * held by this combo box.
-     */
-    setSelectedOption(id: string): void;
-    /**
-     * Clears any currently selected option from this combo box, setting it to null
-     * and clearing any value in the text box.
-     */
-    clearSelectedOption(): void;
-    /**
-     * Set this combo box's value to the given string if possible.
-     *
-     * In `freeform` behavior, this always succeeds.
-     *
-     * In other behavior modes, this method is identical to `setSelectedOption`,
-     * interpreting the input as an option ID and throwing an error if no such
-     * option exists.
-     *
-     * @see {@linkcode IAComboBox.setSelectedOption}
-     */
-    private setValue;
-    /**
-     * Changes the value of the text input box, and updates the filter accordingly.
-     *
-     * @param setFilter Whether to also update the filter text against which options are
-     * matched. Defaults to `true`.
-     */
-    private setTextValue;
-    /**
-     * Sets the current filter text based on the provided string. The resulting filter
-     * text might not exactly match the provided value, depending on the current case
-     * sensitivity.
-     */
-    private setFilterText;
-    openOptionsMenu(): void;
-    closeOptionsMenu(): void;
-    toggleOptionsMenu(): void;
-    private updateFormValidity;
-    private emitChangeEvent;
-    private emitToggleEvent;
-    /**
-     * True iff no selection has been made and no text has been entered.
-     */
-    private get isEmpty();
-    /**
-     * We only show the clear button when the `clearable` property is set
-     * and the combo box is neither empty nor disabled.
-     */
-    private get shouldShowClearButton();
-    /**
-     * Sets the size and position of the options menu to match the size and position of
-     * the combo box widget. Prefers to position below the main widget, but will flip
-     * to the top if needed & if there's more room above.
-     */
-    private positionOptionsMenu;
-    /**
-     * A function to transform option & filter text based on the combo box's
-     * current case sensitivity.
-     */
-    private get caseTransform();
-    /**
-     * Returns the combo box option having the given ID, or null if none exists.
-     */
-    private getOptionFor;
-    /**
-     * Clears any previously-cached mapping of IDs to options, and rebuilds the
-     * map based on the current set of options.
-     */
-    private rebuildOptionIDMap;
-    /**
-     * Applies any required sort to the options and caches the result to be used
-     * at filter/display time.
-     */
-    private rebuildSortedOptions;
-    /**
-     * Clears any previously-cached option filtering values, and rebuilds the
-     * map based on the current component properties.
-     */
-    private rebuildOptionFilteringValues;
-    /**
-     * Returns the filtered array of options by applying the specified filter function
-     * with the current filter text, up to the limit specified by `maxAutocompleteEntries`.
-     */
-    private rebuildFilteredOptions;
-    /**
-     * The first option appearing in the filtered list, or null if there are none.
-     */
-    private get firstFilteredOption();
-    /**
-     * The last option appearing in the filtered list, or null if there are none.
-     */
-    private get lastFilteredOption();
-    /**
-     * The index of the last filtered option, or -1 if no options match the filter.
-     */
-    private get lastFilteredIndex();
-    /**
-     * The IAComboBoxOption that is currently selected, or null if none is selected.
-     */
-    get selectedOption(): IAComboBoxOption | null;
-    /**
-     * The index of the currently highlighted option in the filtered list, or -1 if
-     * no option is currently highlighted.
-     */
-    private get highlightedIndex();
-    /**
-     * The HTML element representing the currently-highlighted option, or null if
-     * no option is highlighted.
-     */
-    private get highlightedElement();
-    static get styles(): CSSResultGroup;
-}
-//# sourceMappingURL=ia-combo-box.d.ts.map

package/dist/src/elements/ia-combo-box/ia-combo-box.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ia-combo-box.d.ts","sourceRoot":"","sources":["../../../../src/elements/ia-combo-box/ia-combo-box.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,OAAO,EACP,cAAc,EACd,cAAc,EAEd,cAAc,EACf,MAAM,KAAK,CAAC;AAQb,OAAO,EAGL,KAAK,kBAAkB,EAEvB,KAAK,sBAAsB,EAE3B,KAAK,gBAAgB,EACtB,MAAM,UAAU,CAAC;AA0BlB;;;;GAIG;AACH,qBACa,UAAW,SAAQ,UAAU;IACxC;;;;;;;;;;OAUG;IACwB,OAAO,EAAE,gBAAgB,EAAE,CAAM;IAE5D;;OAEG;IACyB,WAAW,CAAC,EAAE,MAAM,CAAC;IAEjD;;;;;;;;;;OAUG;IACyB,QAAQ,EAAE,kBAAkB,CAAoB;IAE5E;;;;OAIG;IAEH,sBAAsB,SAA4B;IAElD;;;;;;;;;;;;;;;;;;;;OAoBG;IACyB,MAAM,EAAE,sBAAsB,CAClC;IAExB;;;OAGG;IAEH,aAAa,UAAS;IAEtB;;;;OAIG;IACyC,IAAI,UAAS;IAEzD;;;OAGG;IAGH;;;;;OAKG;IAEH,aAAa,UAAS;IAEtB;;;;OAIG;IAEH,QAAQ,UAAS;IAEjB;;;OAGG;IACyC,SAAS,UAAS;IAE9D;;OAEG;IACyC,IAAI,UAAS;IAEzD;;;;OAIG;IACyC,QAAQ,UAAS;IAE7D;;;OAGG;IACyC,QAAQ,UAAS;IAE7D;;;;;;OAMG;IACyB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAQ;IAExD;;OAEG;IACM,OAAO,CAAC,QAAQ,CAAS;IAElC;;;;;OAKG;IACM,OAAO,CAAC,iBAAiB,CAAiC;IAEnE;;OAEG;IACM,OAAO,CAAC,WAAW,CAAc;IAE1C;;OAEG;IACM,OAAO,CAAC,UAAU,CAAc;IAEd,OAAO,CAAC,aAAa,CAAkB;IAE5C,OAAO,CAAC,SAAS,CAAoB;IAEnC,OAAO,CAAC,WAAW,CAAoB;IAE/D,MAAM,CAAC,cAAc,UAAQ;IAE7B,MAAM,CAAC,iBAAiB,EAAE,cAAc,CAGtC;IAEF,OAAO,CAAC,SAAS,CAAmB;IAEpC;;;;OAIG;IACH,OAAO,CAAC,WAAW,CAAS;IAE5B;;;OAGG;IACH,OAAO,CAAC,WAAW,CAA4C;IAE/D;;;OAGG;IACH,OAAO,CAAC,qBAAqB,CAA4C;IAEzE;;;;OAIG;IACH,OAAO,CAAC,yBAAyB,CAA0B;IAE3D;;;OAGG;IACH,OAAO,CAAC,eAAe,CAA0B;;IAOjD,MAAM,IAAI,cAAc,GAAG,OAAO,OAAO;IAmBzC,UAAU,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IA+CzC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IA4BtC;;;;OAIG;IACH,OAAO,KAAK,aAAa,GAMxB;IAED;;;OAGG;IACH,OAAO,KAAK,iBAAiB,GA6B5B;IAED;;;OAGG;IACH,OAAO,KAAK,mBAAmB,GAsB9B;IAED;;;OAGG;IACH,OAAO,KAAK,aAAa,GAqBxB;IAED;;OAEG;IACH,OAAO,KAAK,mBAAmB,GAmB9B;IAED;;OAEG;IACH,OAAO,KAAK,mBAAmB,GAiB9B;IAED;;OAEG;IACH,OAAO,KAAK,eAAe,GA+B1B;IAED;;;OAGG;IACH,OAAO,KAAK,oBAAoB,GAM/B;IAMD;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAIhC;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAM/B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IASzB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAqC7B;;OAEG;YACW,kBAAkB;IAShC;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAmB1B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAW3B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAK5B;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAK9B;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAI/B;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAIjC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAM9B;;OAEG;IACH,OAAO,CAAC,WAAW;IASnB;;OAEG;IACH,OAAO,CAAC,UAAU;IAwBlB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA8B1B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAkB/B;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAkB3B;;;OAGG;YACW,oBAAoB;IAmBlC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAenC;;;OAGG;IACH,mBAAmB,IAAI,IAAI;IAQ3B;;;;;;;;;;OAUG;IACH,OAAO,CAAC,QAAQ;IAYhB;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAMpB;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAKrB,eAAe,IAAI,IAAI;IAKvB,gBAAgB,IAAI,IAAI;IAKxB,iBAAiB,IAAI,IAAI;IAKzB,OAAO,CAAC,kBAAkB;IAY1B,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,eAAe;IAYvB;;OAEG;IACH,OAAO,KAAK,OAAO,GAElB;IAED;;;OAGG;IACH,OAAO,KAAK,qBAAqB,GAEhC;IAED;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAgC3B;;;OAGG;IACH,OAAO,KAAK,aAAa,GAExB;IAED;;OAEG;IACH,OAAO,CAAC,YAAY;IAIpB;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAO1B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAY5B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAUpC;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAsB9B;;OAEG;IACH,OAAO,KAAK,mBAAmB,GAE9B;IAED;;OAEG;IACH,OAAO,KAAK,kBAAkB,GAE7B;IAED;;OAEG;IACH,OAAO,KAAK,iBAAiB,GAE5B;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,gBAAgB,GAAG,IAAI,CAG5C;IAED;;;OAGG;IACH,OAAO,KAAK,gBAAgB,GAG3B;IAED;;;OAGG;IACH,OAAO,KAAK,kBAAkB,GAG7B;IAED,MAAM,KAAK,MAAM,IAAI,cAAc,CAgKlC;CACF"}