@launchscout/simple-autocomplete v0.0.1

<simple-autocomplete>

This custom element implements an autocomplete (aka combobox) custom element. Fancy autocompletes know how to fetch and filter options themselves; this element does not. Instead, it relies on the user to provide the current set of options and emits events based on user interaction. This makes it a good fit with event oriented backends such as LiveView or LiveState.

The intended usage pattern for this element is to handle the events dispatched by this element(see below), use the data in said events to obtain the current list of items, and populate the list of items as inner content in the list slot (see below).

Installation

npm install @launchscout/simple-autocomplete

Slots

This element requires the user to provide content in the following named slots:

• input This slot is expected to contain the search input
• list This slot is expected to contain a list of options. Each element with aria-role="option" will be considered an option.

Events

• autocomplete-search sent when the value of the input changes
• autocomplete-commit sent when an item is selected either by pressing Enter or clicking an option

Attributes

• clear-on-select This will clear the input value when an item is selected
• debounce The time in milliseconds to debounce before sending an autocomplete-search event when the user enters text into the input

Styling the selected option

The currently selected option (via keyboard navigation) will be so indicated by adding the airia-selected attribute. This allows you to style the selected option like so:

  simple-autocomplete [aria-selected='true'] {
    background-color: lavender;
  }

Example

The index.html file in this directory shows a simple example of choosing people and adding them to a list. It requires the silly_crm example app to be up and running. It will also only work if you've created Persons that can be found.

Credits

The excellent @github/combobox-nav provides the functionality to navigate and select from the list of options.