@aquera/nile-elements 0.0.1-beta.2 → 0.0.1-beta.3

package/src/nile-select/nile-select.ts

@@ -0,0 +1,1069 @@
+/**
+ * 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 {
+  LitElement,
+  html,
+  property,
+  CSSResultArray,
+  TemplateResult,
+} from 'lit-element';
+import { customElement } from 'lit/decorators.js';
+import { styles } from './nile-select.css';
+
+import '../nile-icon';
+import '../nile-popup/nile-popup';
+import '../nile-tag/nile-tag';
+import { animateTo, stopAnimations } from '../internal/animate';
+import { classMap } from 'lit/directives/class-map.js';
+import { query, state } from 'lit/decorators.js';
+import { defaultValue } from '../internal/default-value';
+import { FormControlController } from '../internal/form';
+import {
+  getAnimation,
+  setDefaultAnimation,
+} from '../utilities/animation-registry';
+import { HasSlotController } from '../internal/slot';
+import { scrollIntoView } from '../internal/scroll';
+import { waitForEvent } from '../internal/event';
+import { watch } from '../internal/watch';
+import NileElement from '../internal/nile-element';
+import type { CSSResultGroup } from 'lit';
+import type { NileFormControl } from '../internal/nile-element';
+import type NileOption from '../nile-option/nile-option';
+import type NilePopup from '../nile-popup/nile-popup';
+
+type NileRemoveEvent = CustomEvent<Record<PropertyKey, never>>;
+
+/**
+ * Nile icon component.
+ *
+ * @tag nile-select
+ *
+ */
+
+/**
+ * @summary Selects allow you to choose items from a menu of predefined options.
+ * @status stable
+ * @since 2.0
+ *
+ * @dependency nile-icon
+ * @dependency nile-popup
+ * @dependency nile-tag
+ *
+ * @slot - The listbox options. Must be `<nile-option>` elements. You can use `<nile-divider>` to group items visually.
+ * @slot label - The input's label. Alternatively, you can use the `label` attribute.
+ * @slot prefix - Used to prepend a presentational icon or similar element to the combobox.
+ * @slot clear-icon - An icon to use in lieu of the default clear icon.
+ * @slot expand-icon - The icon to show when the control is expanded and collapsed. Rotates on open and close.
+ * @slot help-text - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.
+ *
+ * @event nile-change - Emitted when the control's value changes.
+ * @event nile-clear - Emitted when the control's value is cleared.
+ * @event nile-input - Emitted when the control receives input.
+ * @event nile-focus - Emitted when the control gains focus.
+ * @event nile-blur - Emitted when the control loses focus.
+ * @event nile-show - Emitted when the select's menu opens.
+ * @event nile-after-show - Emitted after the select's menu opens and all animations are complete.
+ * @event nile-hide - Emitted when the select's menu closes.
+ * @event nile-after-hide - Emitted after the select's menu closes and all animations are complete.
+ * @event nile-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
+ *
+ * @csspart form-control - The form control that wraps the label, input, and help text.
+ * @csspart form-control-label - The label's wrapper.
+ * @csspart form-control-input - The select's wrapper.
+ * @csspart form-control-help-text - The help text's wrapper.
+ * @csspart combobox - The container the wraps the prefix, combobox, clear icon, and expand button.
+ * @csspart prefix - The container that wraps the prefix slot.
+ * @csspart display-input - The element that displays the selected option's label, an `<input>` element.
+ * @csspart listbox - The listbox container where options are slotted.
+ * @csspart tags - The container that houses option tags when `multiselect` is used.
+ * @csspart tag - The individual tags that represent each multiselect option.
+ * @csspart tag__base - The tag's base part.
+ * @csspart tag__content - The tag's content part.
+ * @csspart tag__remove-button - The tag's remove button.
+ * @csspart tag__remove-button__base - The tag's remove button base part.
+ * @csspart clear-button - The clear button.
+ * @csspart expand-icon - The container that wraps the expand icon.
+ */
+
+@customElement('nile-select')
+export class NileSelect extends NileElement implements NileFormControl {
+  static styles: CSSResultGroup = styles;
+
+  private readonly formControlController = new FormControlController(this, {
+    assumeInteractionOn: ['nile-blur', 'nile-input'],
+  });
+  private readonly hasSlotController = new HasSlotController(
+    this,
+    'help-text',
+    'label'
+  );
+  private typeToSelectString = '';
+  private typeToSelectTimeout: number;
+
+  @query('.select') popup: NilePopup;
+  @query('.select__combobox') combobox: HTMLSlotElement;
+  @query('.select__display-input') displayInput: HTMLInputElement;
+  @query('.select__value-input') valueInput: HTMLInputElement;
+  @query('.select__listbox') listbox: HTMLSlotElement;
+
+  @state() private hasFocus = false;
+  @state() displayLabel = '';
+  @state() currentOption: NileOption;
+  @state() selectedOptions: NileOption[] = [];
+
+  /** The name of the select, submitted as a name/value pair with form data. */
+  @property() name = '';
+
+  /**
+   * The current value of the select, submitted as a name/value pair with form data. When `multiple` is enabled, the
+   * value will be a space-delimited list of values based on the options selected.
+   */
+  @property({
+    converter: {
+      fromAttribute: (value: string) => value.split(' '),
+      toAttribute: (value: string[]) => value.join(' '),
+    },
+  })
+  value: string | string[] = '';
+
+  /** The default value of the form control. Primarily used for resetting the form control. */
+  @defaultValue() defaultValue: string | string[] = '';
+
+  /** The select's size. */
+  @property() size: 'small' | 'medium' | 'large' = 'medium';
+
+  /** Placeholder text to show as a hint when the select is empty. */
+  @property() placeholder = '';
+
+  /** Placeholder text to show as a hint when the select is empty. */
+  @state() searchValue = '';
+
+  /** Allows more than one option to be selected. */
+  @property({ type: Boolean, reflect: true }) searchEnabled = false;
+
+  /** Allows more than one option to be selected. */
+  @property({ type: Boolean, reflect: true }) multiple = false;
+
+  /**
+   * The maximum number of selected options to show when `multiple` is true. After the maximum, "+n" will be shown to
+   * indicate the number of additional items that are selected. Set to 0 to remove the limit.
+   */
+  @property({ attribute: 'max-options-visible', type: Number })
+  maxOptionsVisible = 3;
+
+  /** Disables the select control. */
+  @property({ type: Boolean, reflect: true }) disabled = false;
+
+  /** Adds a clear button when the select is not empty. */
+  @property({ type: Boolean }) clearable = false;
+
+  /**
+   * Indicates whether or not the select is open. You can toggle this attribute to show and hide the menu, or you can
+   * use the `show()` and `hide()` methods and this attribute will reflect the select's open state.
+   */
+  @property({ type: Boolean, reflect: true }) open = false;
+
+  /**
+   * Enable this option to prevent the listbox from being clipped when the component is placed inside a container with
+   * `overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.
+   */
+  @property({ type: Boolean }) hoist = false;
+
+  /** Draws a filled select. */
+  @property({ type: Boolean, reflect: true }) filled = false;
+
+  /** Draws a pill-style select with rounded edges. */
+  @property({ type: Boolean, reflect: true }) pill = false;
+
+  /** The select's label. If you need to display HTML, use the `label` slot instead. */
+  @property() label = '';
+
+  /**
+   * The preferred placement of the select's menu. Note that the actual placement may vary as needed to keep the listbox
+   * inside of the viewport.
+   */
+  @property({ reflect: true }) placement: 'top' | 'bottom' = 'bottom';
+
+  /** The select's help text. If you need to display HTML, use the `help-text` slot instead. */
+  @property({ attribute: 'help-text' }) helpText = '';
+
+  /**
+   * 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.
+   */
+  @property({ reflect: true }) form = '';
+
+  /** The select's required attribute. */
+  @property({ type: Boolean, reflect: true }) required = false;
+
+  @property({ type: Boolean }) showSelected = false;
+
+  /** Gets the validity state object */
+  get validity() {
+    return this.valueInput.validity;
+  }
+
+  /** Gets the validation message */
+  get validationMessage() {
+    return this.valueInput.validationMessage;
+  }
+
+  connectedCallback() {
+    super.connectedCallback();
+    this.handleDocumentFocusIn = this.handleDocumentFocusIn.bind(this);
+    this.handleDocumentKeyDown = this.handleDocumentKeyDown.bind(this);
+    this.handleDocumentMouseDown = this.handleDocumentMouseDown.bind(this);
+
+    // Because this is a form control, it shouldn't be opened initially
+    this.open = false;
+  }
+
+  private addOpenListeners() {
+    document.addEventListener('focusin', this.handleDocumentFocusIn);
+    document.addEventListener('keydown', this.handleDocumentKeyDown);
+    document.addEventListener('mousedown', this.handleDocumentMouseDown);
+  }
+
+  private removeOpenListeners() {
+    document.removeEventListener('focusin', this.handleDocumentFocusIn);
+    document.removeEventListener('keydown', this.handleDocumentKeyDown);
+    document.removeEventListener('mousedown', this.handleDocumentMouseDown);
+  }
+
+  private handleFocus() {
+    this.hasFocus = true;
+    this.displayInput.setSelectionRange(0, 0);
+    this.emit('nile-focus');
+  }
+
+  private handleBlur() {
+    this.hasFocus = false;
+    this.emit('nile-blur');
+  }
+
+  private handleDocumentFocusIn(event: FocusEvent) {
+    // Close when focusing out of the select
+    const path = event.composedPath();
+    if (this && !path.includes(this)) {
+      this.hide();
+    }
+  }
+
+  /**
+   * Handles the click event on the footer.
+   * @param event - The click event.
+   */
+  private handleFooterClick(event: MouseEvent): void {
+    event.stopPropagation();
+    event.preventDefault();
+  }
+
+  /**
+   * Toggles the display of selected options in the dropdown
+   * @param event - the event object
+   */
+  private toggleShowSelected(event: Event): void {
+    event.stopPropagation();
+    event.preventDefault();
+    // Only toggle if there are selected options
+    if (this.selectedOptions?.length === 0) {
+      return;
+    }
+    // Toggle the showSelected property
+    this.showSelected = !this.showSelected;
+
+    // Hide unselected options if showSelected is true
+    const allOptions = this.getAllOptions();
+    allOptions.forEach(el => {
+      if (!el.selected) {
+        el.hidden = this.showSelected;
+      }
+    });
+
+    this.requestUpdate();
+  }
+
+  /**
+   * Deselects all options and updates the value, selectedOptions, and displayLabel properties accordingly
+   */
+  private unSlectAll(): void {
+    this.showSelected = false;
+    const allOptions = this.getAllOptions();
+    allOptions.forEach(el => {
+      el.selected = false;
+      el.hidden = false;
+    });
+    this.value = '';
+    this.selectionChanged();
+  }
+
+  private handleDocumentKeyDown(event: KeyboardEvent) {
+    const target = event.target as HTMLElement;
+    const isClearButton = target.closest('.select__clear') !== null;
+    const isIconButton = target.closest('nile-icon-button') !== null;
+
+    // Ignore presses when the target is an icon button (e.g. the remove button in <nile-tag>)
+    if (isClearButton || isIconButton) {
+      return;
+    }
+
+    // Close when pressing escape
+    if (event.key === 'Escape' && this.open) {
+      event.preventDefault();
+      event.stopPropagation();
+      this.hide();
+      this.displayInput.focus({ preventScroll: true });
+    }
+
+    // Handle enter and space. When pressing space, we allow for type to select behaviors so if there's anything in the
+    // buffer we _don't_ close it.
+    if (
+      event.key === 'Enter' ||
+      (event.key === ' ' && this.typeToSelectString === '')
+    ) {
+      event.preventDefault();
+      event.stopImmediatePropagation();
+
+      // If it's not open, open it
+      if (!this.open) {
+        this.show();
+        return;
+      }
+
+      // If it is open, update the value based on the current selection and close it
+      if (this.currentOption && !this.currentOption.disabled) {
+        if (this.multiple) {
+          this.toggleOptionSelection(this.currentOption);
+        } else {
+          this.setSelectedOptions(this.currentOption);
+        }
+
+        // Emit after updating
+        this.updateComplete.then(() => {
+          this.emit('nile-input');
+          this.emit('nile-change');
+        });
+
+        if (!this.multiple) {
+          this.hide();
+          this.displayInput.focus({ preventScroll: true });
+        }
+      }
+
+      return;
+    }
+
+    // Navigate options
+    if (['ArrowUp', 'ArrowDown', 'Home', 'End'].includes(event.key)) {
+      const allOptions = this.getAllOptions();
+      const currentIndex = allOptions.indexOf(this.currentOption);
+      let newIndex = Math.max(0, currentIndex);
+
+      // Prevent scrolling
+      event.preventDefault();
+
+      // Open it
+      if (!this.open) {
+        this.show();
+
+        // If an option is already selected, stop here because we want that one to remain highlighted when the listbox
+        // opens for the first time
+        if (this.currentOption) {
+          return;
+        }
+      }
+
+      if (event.key === 'ArrowDown') {
+        newIndex = currentIndex + 1;
+        if (newIndex > allOptions.length - 1) newIndex = 0;
+      } else if (event.key === 'ArrowUp') {
+        newIndex = currentIndex - 1;
+        if (newIndex < 0) newIndex = allOptions.length - 1;
+      } else if (event.key === 'Home') {
+        newIndex = 0;
+      } else if (event.key === 'End') {
+        newIndex = allOptions.length - 1;
+      }
+
+      this.setCurrentOption(allOptions[newIndex]);
+    }
+
+    // All other "printable" keys trigger type to select
+    if (event.key.length === 1 || event.key === 'Backspace') {
+      const allOptions = this.getAllOptions();
+
+      // Don't block important key combos like CMD+R
+      if (event.metaKey || event.ctrlKey || event.altKey) {
+        return;
+      }
+
+      // Open, unless the key that triggered is backspace
+      if (!this.open) {
+        if (event.key === 'Backspace') {
+          return;
+        }
+
+        this.show();
+      }
+
+      event.stopPropagation();
+      event.preventDefault();
+
+      clearTimeout(this.typeToSelectTimeout);
+      this.typeToSelectTimeout = window.setTimeout(
+        () => (this.typeToSelectString = ''),
+        1000
+      );
+
+      if (event.key === 'Backspace') {
+        this.typeToSelectString = this.typeToSelectString.slice(0, -1);
+      } else {
+        this.typeToSelectString += event.key.toLowerCase();
+      }
+
+      for (const option of allOptions) {
+        const label = option.getTextLabel().toLowerCase();
+
+        if (label.startsWith(this.typeToSelectString)) {
+          this.setCurrentOption(option);
+          break;
+        }
+      }
+    }
+  }
+
+  private handleDocumentMouseDown(event: MouseEvent) {
+    // Close when clicking outside of the select
+    const path = event.composedPath();
+    if (this && !path.includes(this)) {
+      this.hide();
+    }
+  }
+
+  private handleLabelClick() {
+    this.displayInput.focus();
+  }
+
+  private handleComboboxMouseDown(event: MouseEvent) {
+    const path = event.composedPath();
+    const isIconButton = path.some(
+      el =>
+        el instanceof Element && el.tagName.toLowerCase() === 'nile-icon-button'
+    );
+
+    // Ignore disabled controls and clicks on tags (remove buttons)
+    if (this.disabled || isIconButton) {
+      return;
+    }
+
+    event.preventDefault();
+    this.displayInput.focus({ preventScroll: true });
+    this.open = !this.open;
+  }
+
+  private handleComboboxKeyDown(event: KeyboardEvent) {
+    event.stopPropagation();
+    this.handleDocumentKeyDown(event);
+  }
+
+  private handleClearClick(event: MouseEvent) {
+    event.stopPropagation();
+
+    if (this.value !== '') {
+      this.setSelectedOptions([]);
+      this.displayInput.focus({ preventScroll: true });
+
+      // Emit after update
+      this.updateComplete.then(() => {
+        this.emit('nile-clear');
+        this.emit('nile-input');
+        this.emit('nile-change');
+      });
+    }
+  }
+
+  private handleClearMouseDown(event: MouseEvent) {
+    // Don't lose focus or propagate events when clicking the clear button
+    event.stopPropagation();
+    event.preventDefault();
+  }
+
+  private handleOptionClick(event: MouseEvent) {
+    const target = event.target as HTMLElement;
+    const option = target.closest('nile-option');
+    const oldValue = this.value;
+
+    if (option && !option.disabled) {
+      if (this.multiple) {
+        this.toggleOptionSelection(option);
+      } else {
+        this.setSelectedOptions(option);
+      }
+
+      // Set focus after updating so the value is announced by screen readers
+      this.updateComplete.then(() =>
+        this.displayInput.focus({ preventScroll: true })
+      );
+
+      if (this.value !== oldValue) {
+        // Emit after updating
+        this.updateComplete.then(() => {
+          this.emit('nile-input');
+          this.emit('nile-change');
+        });
+      }
+
+      if (!this.multiple) {
+        this.hide();
+        this.displayInput.focus({ preventScroll: true });
+      }
+    }
+  }
+
+  private handleDefaultSlotChange() {
+    const allOptions = this.getAllOptions();
+    const value = Array.isArray(this.value) ? this.value : [this.value];
+    const values: string[] = [];
+
+    // Check for duplicate values in menu items
+    if (customElements.get('nile-option')) {
+      allOptions.forEach(option => values.push(option.value));
+
+      // Select only the options that match the new value
+      this.setSelectedOptions(
+        allOptions.filter(el => value.includes(el.value))
+      );
+    } else {
+      // Rerun this handler when <nile-option> is registered
+      customElements
+        .whenDefined('nile-option')
+        .then(() => this.handleDefaultSlotChange());
+    }
+  }
+
+  private handleTagRemove(event: NileRemoveEvent, option: NileOption) {
+    event.stopPropagation();
+
+    if (!this.disabled) {
+      this.toggleOptionSelection(option, false);
+
+      // Emit after updating
+      this.updateComplete.then(() => {
+        this.emit('nile-input');
+        this.emit('nile-change');
+      });
+    }
+  }
+
+  // Gets an array of all <nile-option> elements
+  private getAllOptions() {
+    return [...this.querySelectorAll<NileOption>('nile-option')];
+  }
+
+  // Gets the first <nile-option> element
+  private getFirstOption() {
+    return this.querySelector<NileOption>('nile-option');
+  }
+
+  // Sets the current option, which is the option the user is currently interacting with (e.g. via keyboard). Only one
+  // option may be "current" at a time.
+  private setCurrentOption(option: NileOption | null) {
+    const allOptions = this.getAllOptions();
+
+    // Clear selection
+    allOptions.forEach(el => {
+      el.current = false;
+      el.tabIndex = -1;
+    });
+
+    // Select the target option
+    if (option) {
+      this.currentOption = option;
+      option.current = true;
+      option.tabIndex = 0;
+      option.focus();
+    }
+  }
+
+  // Sets the selected option(s)
+  private setSelectedOptions(option: NileOption | NileOption[]) {
+    const allOptions = this.getAllOptions();
+    const newSelectedOptions = Array.isArray(option) ? option : [option];
+
+    // Clear existing selection
+    allOptions.forEach(el => (el.selected = false));
+
+    // Set the new selection
+    if (newSelectedOptions.length) {
+      newSelectedOptions.forEach(el => (el.selected = true));
+    }
+
+    // Update selection, value, and display label
+    this.selectionChanged();
+  }
+
+  // Toggles an option's selected state
+  private toggleOptionSelection(option: NileOption, force?: boolean) {
+    if (force === true || force === false) {
+      option.selected = force;
+    } else {
+      option.selected = !option.selected;
+    }
+
+    this.selectionChanged();
+  }
+
+  // This method must be called whenever the selection changes. It will update the selected options cache, the current
+  // value, and the display value
+  private selectionChanged() {
+    // Update selected options cache
+    this.selectedOptions = this.getAllOptions().filter(el => el.selected);
+
+    // Update the value and display label
+    if (this.multiple) {
+      this.value = this.selectedOptions.map(el => el.value);
+
+      if (this.placeholder && this.value.length === 0) {
+        // When no items are selected, keep the value empty so the placeholder shows
+        this.displayLabel = '';
+      } else {
+        this.displayLabel = this.selectedOptions.length + ' selected';
+      }
+    } else {
+      this.value = this.selectedOptions[0]?.value ?? '';
+      this.displayLabel = this.selectedOptions[0]?.getTextLabel() ?? '';
+    }
+
+    // Update validity
+    this.updateComplete.then(() => {
+      this.formControlController.updateValidity();
+    });
+  }
+
+  handleSearchFocus() {
+    document.removeEventListener('keydown', this.handleDocumentKeyDown);
+  }
+
+  handleSearchBlur() {
+    document.addEventListener('keydown', this.handleDocumentKeyDown);
+  }
+
+  handleSearchChange(e: any) {
+    this.searchValue = e.detail.value;
+    this.filterOptions(this.searchValue);
+  }
+
+  filterOptions(searchValue: string) {
+    const allOptions = this.getAllOptions();
+    const lowerCaseSearchValue = searchValue.toLowerCase();
+
+    allOptions.forEach(el => {
+      // Hide the option if its text and value do not include the search value.
+      const lowerCaseLabel = el.getTextLabel().toLowerCase();
+      const lowerCaseValue = (el.value || '').toLowerCase();
+      el.hidden = !(
+        lowerCaseLabel.includes(lowerCaseSearchValue) ||
+        lowerCaseValue.includes(lowerCaseSearchValue)
+      );
+    });
+  }
+
+  private handleInvalid(event: Event) {
+    this.formControlController.setValidity(false);
+    this.formControlController.emitInvalidEvent(event);
+  }
+
+  @watch('disabled', { waitUntilFirstUpdate: true })
+  handleDisabledChange() {
+    // Close the listbox when the control is disabled
+    if (this.disabled) {
+      this.open = false;
+      this.handleOpenChange();
+    }
+  }
+
+  @watch('value', { waitUntilFirstUpdate: true })
+  handleValueChange() {
+    const allOptions = this.getAllOptions();
+    const value = Array.isArray(this.value) ? this.value : [this.value];
+
+    // Select only the options that match the new value
+    this.setSelectedOptions(allOptions.filter(el => value.includes(el.value)));
+  }
+
+  @watch('open', { waitUntilFirstUpdate: true })
+  async handleOpenChange() {
+    if (this.open && !this.disabled) {
+      // Reset the current option
+      this.setCurrentOption(this.selectedOptions[0] || this.getFirstOption());
+
+      // Show
+      this.emit('nile-show');
+      this.addOpenListeners();
+
+      await stopAnimations(this);
+      this.listbox.hidden = false;
+      this.popup.active = true;
+
+      // Select the appropriate option based on value after the listbox opens
+      requestAnimationFrame(() => {
+        this.setCurrentOption(this.currentOption);
+      });
+
+      const { keyframes, options } = getAnimation(this, 'select.show', {
+        dir: 'ltr',
+      });
+      await animateTo(this.popup.popup, keyframes, options);
+
+      // Make sure the current option is scrolled into view (required for Safari)
+      if (this.currentOption) {
+        scrollIntoView(this.currentOption, this.listbox, 'vertical', 'auto');
+      }
+
+      this.emit('nile-after-show');
+    } else {
+      // Hide
+      this.emit('nile-hide');
+      this.removeOpenListeners();
+
+      await stopAnimations(this);
+      const { keyframes, options } = getAnimation(this, 'select.hide', {
+        dir: 'ltr',
+      });
+      await animateTo(this.popup.popup, keyframes, options);
+      this.listbox.hidden = true;
+      this.popup.active = false;
+
+      this.emit('nile-after-hide');
+    }
+  }
+
+  /** Shows the listbox. */
+  async show() {
+    if (this.open || this.disabled) {
+      this.open = false;
+      return undefined;
+    }
+
+    this.open = true;
+    return waitForEvent(this, 'nile-after-show');
+  }
+
+  /** Hides the listbox. */
+  async hide() {
+    if (!this.open || this.disabled) {
+      this.open = false;
+      return undefined;
+    }
+
+    this.open = false;
+    return waitForEvent(this, 'nile-after-hide');
+  }
+
+  /** Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid. */
+  checkValidity() {
+    return this.valueInput.checkValidity();
+  }
+
+  /** Gets the associated form, if one exists. */
+  getForm(): HTMLFormElement | null {
+    return this.formControlController.getForm();
+  }
+
+  /** Checks for validity and shows the browser's validation message if the control is invalid. */
+  reportValidity() {
+    return this.valueInput.reportValidity();
+  }
+
+  /** Sets a custom validation message. Pass an empty string to restore validity. */
+  setCustomValidity(message: string) {
+    this.valueInput.setCustomValidity(message);
+    this.formControlController.updateValidity();
+  }
+
+  /** Sets focus on the control. */
+  focus(options?: FocusOptions) {
+    this.displayInput.focus(options);
+  }
+
+  /** Removes focus from the control. */
+  blur() {
+    this.displayInput.blur();
+  }
+
+  render() {
+    const hasLabelSlot = this.hasSlotController.test('label');
+    const hasHelpTextSlot = this.hasSlotController.test('help-text');
+    const hasLabel = this.label ? true : !!hasLabelSlot;
+    const hasHelpText = this.helpText ? true : !!hasHelpTextSlot;
+    const hasClearIcon =
+      this.clearable && !this.disabled && this.value.length > 0;
+    const isPlaceholderVisible = this.placeholder && this.value.length === 0;
+    const searchValue = this.searchValue || '';
+
+    return html`
+      <div
+        part="form-control"
+        class=${classMap({
+          'form-control': true,
+          'form-control--small': this.size === 'small',
+          'form-control--medium': this.size === 'medium',
+          'form-control--large': this.size === 'large',
+          'form-control--has-label': hasLabel,
+          'form-control--has-help-text': hasHelpText,
+        })}
+      >
+        <label
+          id="label"
+          part="form-control-label"
+          class="form-control__label"
+          aria-hidden=${hasLabel ? 'false' : 'true'}
+          @click=${this.handleLabelClick}
+        >
+          <slot name="label">${this.label}</slot>
+        </label>
+
+        <div part="form-control-input" class="form-control-input">
+          <nile-popup
+            class=${classMap({
+              select: true,
+              'select--standard': true,
+              'select--filled': this.filled,
+              'select--pill': this.pill,
+              'select--open': this.open,
+              'select--disabled': this.disabled,
+              'select--multiple': this.multiple,
+              'select--focused': this.hasFocus,
+              'select--placeholder-visible': isPlaceholderVisible,
+              'select--top': this.placement === 'top',
+              'select--bottom': this.placement === 'bottom',
+              'select--small': this.size === 'small',
+              'select--medium': this.size === 'medium',
+              'select--large': this.size === 'large',
+            })}
+            placement=${this.placement}
+            strategy=${this.hoist ? 'fixed' : 'absolute'}
+            flip
+            shift
+            sync="width"
+            auto-size="vertical"
+            auto-size-padding="10"
+          >
+            <div
+              part="combobox"
+              class="select__combobox"
+              slot="anchor"
+              @keydown=${this.handleComboboxKeyDown}
+              @mousedown=${this.handleComboboxMouseDown}
+            >
+              <slot part="prefix" name="prefix" class="select__prefix"></slot>
+
+              <input
+                part="display-input"
+                class="select__display-input"
+                type="text"
+                placeholder=${this.placeholder}
+                .disabled=${this.disabled}
+                .value=${this.displayLabel}
+                autocomplete="off"
+                spellcheck="false"
+                autocapitalize="off"
+                readonly
+                aria-controls="listbox"
+                aria-expanded=${this.open ? 'true' : 'false'}
+                aria-haspopup="listbox"
+                aria-labelledby="label"
+                aria-disabled=${this.disabled ? 'true' : 'false'}
+                aria-describedby="help-text"
+                role="combobox"
+                tabindex="0"
+                @focus=${this.handleFocus}
+                @blur=${this.handleBlur}
+              />
+
+              ${this.multiple
+                ? html`
+                    <div part="tags" class="select__tags">
+                      ${this.selectedOptions.map((option, index) => {
+                        if (
+                          index < this.maxOptionsVisible ||
+                          this.maxOptionsVisible <= 0
+                        ) {
+                          return html`
+                            <nile-tag
+                              part="tag"
+                              exportparts="
+                                base:tag__base,
+                                content:tag__content,
+                                remove-button:tag__remove-button,
+                                remove-button__base:tag__remove-button__base
+                              "
+                              ?pill=${this.pill}
+                              size=${this.size}
+                              removable
+                              @nile-remove=${(event: NileRemoveEvent) =>
+                                this.handleTagRemove(event, option)}
+                            >
+                              ${option.getTextLabel()}
+                            </nile-tag>
+                          `;
+                        } else if (index === this.maxOptionsVisible) {
+                          return html`
+                            <nile-tag
+                              class="select__tags-count ${hasClearIcon
+                                ? `select__tags-count-clearable`
+                                : ``} "
+                              size=${this.size}
+                            >
+                              +${this.selectedOptions.length - index}
+                            </nile-tag>
+                          `;
+                        } else {
+                          return null;
+                        }
+                      })}
+                    </div>
+                  `
+                : ''}
+
+              <input
+                class="select__value-input"
+                type="text"
+                ?disabled=${this.disabled}
+                ?required=${this.required}
+                .value=${Array.isArray(this.value)
+                  ? this.value.join(', ')
+                  : this.value}
+                tabindex="-1"
+                aria-hidden="true"
+                @focus=${() => this.focus()}
+                @invalid=${this.handleInvalid}
+              />
+
+              ${hasClearIcon
+                ? html`
+                    <button
+                      part="clear-button"
+                      class="select__clear"
+                      type="button"
+                      aria-label="clearEntry"
+                      @mousedown=${this.handleClearMouseDown}
+                      @click=${this.handleClearClick}
+                      tabindex="-1"
+                    >
+                      <slot name="clear-icon">
+                        <nile-icon name="close" library="system"></nile-icon>
+                      </slot>
+                    </button>
+                  `
+                : ''}
+
+              <slot
+                name="expand-icon"
+                part="expand-icon"
+                class="select__expand-icon"
+              >
+                <nile-icon library="system" name="arrowdown"></nile-icon>
+              </slot>
+            </div>
+
+            <div
+              id="listbox"
+              role="listbox"
+              aria-expanded=${this.open ? 'true' : 'false'}
+              aria-multiselectable=${this.multiple ? 'true' : 'false'}
+              aria-labelledby="label"
+              part="listbox"
+              class="select__listbox ${this.searchEnabled
+                ? 'select__search-enabled '
+                : ''}"
+              tabindex="-1"
+              @mouseup=${this.handleOptionClick}
+              @slotchange=${this.handleDefaultSlotChange}
+            >
+              <slot></slot>
+
+              ${this.searchEnabled
+                ? html` <div class="select__search">
+                    <nile-input
+                      size="small"
+                      clearable
+                      .value=${searchValue}
+                      placeholder="Search..."
+                      @nile-input=${this.handleSearchChange}
+                      @nile-focus=${this.handleSearchFocus}
+                      @nile-blur=${this.handleSearchBlur}
+                    >
+                      <nile-icon name="search" slot="suffix"> </nile-icon>
+                    </nile-input>
+                  </div>`
+                : ``}
+              ${this.multiple
+                ? html` <div
+                    class="select__footer"
+                    @click="${this.handleFooterClick}"
+                  >
+                    <span
+                      @click="${this.toggleShowSelected}"
+                      style="cursor: pointer;"
+                    >
+                      <nile-checkbox
+                        ?disabled="${this.selectedOptions.length === 0}"
+                        ?checked="${this.showSelected}"
+                      >
+                        Show Selected</nile-checkbox
+                      >
+                    </span>
+                    <span class="select__clear" @click="${this.unSlectAll}"
+                      >clear all</span
+                    >
+                  </div>`
+                : ``}
+            </div>
+          </nile-popup>
+        </div>
+
+        <slot
+          name="help-text"
+          part="form-control-help-text"
+          id="help-text"
+          class="form-control__help-text"
+          aria-hidden=${hasHelpText ? 'false' : 'true'}
+        >
+          ${this.helpText}
+        </slot>
+      </div>
+    `;
+  }
+}
+
+setDefaultAnimation('select.show', {
+  keyframes: [
+    { opacity: 0, scale: 0.9 },
+    { opacity: 1, scale: 1 },
+  ],
+  options: { duration: 100, easing: 'ease' },
+});
+
+setDefaultAnimation('select.hide', {
+  keyframes: [
+    { opacity: 1, scale: 1 },
+    { opacity: 0, scale: 0.9 },
+  ],
+  options: { duration: 100, easing: 'ease' },
+});
+
+export default NileSelect;
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'nile-select': NileSelect;
+  }
+}