npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@area17/flotsam-autocomplete

v1.0.0

Published

Accessibility first autocomplete without limiting style flexibility

Downloads

4

Readme

Flotsam autocomplete

/ˈflätsəm/

noun

  • the wreckage of a ship or its cargo found floating on or washed up by the sea.
  • people or things that have been rejected and are regarded as worthless.
  • An a11y autocomplete library

Mission Statement

We felt that the existing choices for typeahead/autocomplete UI are lacking one or more in the following areas:

  • vetted accessibility standards
  • simplicity, with clear documentation
  • a modern event bus system
  • flexible styling
  • vanilla JS with no requirement for jQuery,
  • small footprint (<4kb)

This library is inspired and aims to build upon alphagov/accessible-autocomplete.


Demo

http://flotsam.dev.area17.com/


Using Flotsam

Firstly, install via npm:

$ npm install flotsam-autocomplete

Import into your JavaScript by:

import flotsam from 'flotsam-autocomplete'

You'll also need some very basic styles - see Styling.

Static setup

const typeahead = new flotsam({
    // input element you want to attach to
    el: document.querySelector('input'),
    // static data formatted in an array, this is the data that will render on interaction
    data: ['lorem ipsum', 'lipsum', 'hello world', 'foo', 'bar', 'foo bar'],
});

NB currently filtering from a static list uses [String.prototype.includes()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/includes) and so looks for exact string matches - e.g. "and" will match "and", "stand", "mandatory" etc.

Dynamic setup

let fetchController = new AbortController();
let fetchSignal = fetchController.signal;

const typeahead = new flotsam({
    // input element you want to attach to
    el: document.querySelector('input'),

    // textValue is the input/search value 
    getData: (textValue) => {
        fetchController.abort();
        fetchController = new AbortController();
        fetchSignal = fetchController.signal;

        const url = new URL('http://fakejsonendpoints.dev.area17.com/api/autocomplete.php');
        const params = {
          q: textValue,
        };
        url.search = new URLSearchParams(params).toString();

        return fetch(
          url, 
          {
            method: 'get',
            signal: fetchSignal,
            headers: {
              "Content-Type": "application/json",
              "Accept": "application/json",
              "X-Requested-With": "XMLHttpRequest",
            }
          }
        )
        .then(response => {
          try {
            return response.json();
          } catch(error) {
            console.log('json error:', error, response);
          }
        })
        .then(data => {
          // return data arr
          return data;
        })
        .catch(error => {
          console.log('fetch error:', error);
          return [];
        });
    }
});

NB Your Ajax'd list should be filtered by your remote server, so you can allow fuzzy or exact string matches

Options

const typeahead = new flotsam({
    el: document.querySelector('input'),
    data: [...data],

    // this sets the minimum count of input characters before we will render the box, defaults to 2
    minChars: 2,

    // when key-ing up or down, the input will fill with the previewed string
    // defaults to true
    inputPreview: true,

    // a11y instructions, defaults to:
    hint: 'When autocomplete results are available, use up and down arrows to review and enter to select. Touch device users, explore by touch or with swipe gestures.',

    // no results text, `::term::` is replaced with your search term
    noResultsText: 'Sorry there are no results for ::term:: please search again',

    // mark results in results, with `<mark>` tags, defaults to `true`
    markResults: true,

    // submit form on return key press, defaults to `true`
    submitOnReturn: true,
})

Events

Flotsom triggers events on user interaction:

const typeahead = new flotsam({
    el: document.querySelector('input'),
    data: [...data],
});

typeahead.addEventListener('init', instanceData => {
    // flotsam init
});

typeahead.addEventListener('openModal', (instanceData) => {
    // modal opened
});

typeahead.addEventListener('closeModal', (instanceData) => {
    // modal closed
});

typeahead.addEventListener('selectKey', (instanceData) => {
    // selected item (with keyboard)
});

typeahead.addEventListener('resultClicked', (instanceData) => {
    // result clicked/return key pressed on selected result
});

typeahead.addEventListener('loadingData', (instanceData) => {
    // loading data
});

typeahead.addEventListener('loadedData', (instanceData) => {
    // loaded
});

typeahead.addEventListener('disabled', (instanceData) => {
    // flotsam disabled
});

InstanceData has access to the current, modal, input, options (readonly), and any other useful information i could think of!

Methods

const typeahead = new flotsam({
    el: document.querySelector('input'),
    data: [...data],
});

// force close the flotsom
typeahead.triggerClose();

// enables flotsom
typeahead.triggerEnable();

// disables flotsom
typeahead.triggerDisable();

Keyboard controls

Flotsom includes keyboard controls which follow the google autocomplete UI:

  • Arrow Up and Arrow Down keys allow you to select previous and next items while open
  • Tab will set the value, close the modal, but NOT submit (google-like)
  • Escape will set the value, close the modal, but NOT submit (google-like)
  • Enter will set the value, close the modal AND submit (google-like)

Styling

The rendered HTML will look like:

<div class="flotsam-modal">
    <div class="flotsam-modal__inner">
        <ul class="flotsam-modal__list" role="combobox">
            <li role="option" class="flotsam-modal__list-item flotsam-modal__selected-item">Rendered value 1 (selected)</li>
            <li role="option" class="flotsam-modal__list-item"><mark>Rendered value 2 (highlighted)</mark></li>
            <li role="option" class="flotsam-modal__list-item">Rendered value 3</li>
        </ul>
    </div>
</div>
<div id="assistiveHint-${this.uid}" class="flotsam-modal__hint">When autocomplete results are available, use up and down arrows to review and enter to select. Touch device users, explore by touch or with swipe gestures.</div>
<div id="status-${this.uid}" aria-role='status' aria-live="polite" class="flotsam-modal__status"></div>

The container of your input will need to have position: relative; in order to correctly position the dropdown.

Some default styles can be included by importing:

import './node_modules/flotsam-autocomplete/dist/flotsam.css'

These default styles come with colors set via CSS variables:

:root {
    --flotsam-border: black;
    --flotsam-selected: pink;
    --flotsam-empty: grey;
}

These default styles really are basic:

.flotsam-modal {
    position: absolute;
    width: 100%;
    top: 100%;
    border: 1px solid var(--flotsam-border, black);
}

.flotsam-modal__inner {
    padding: 0 24px;
    max-height: 200px;
    overflow: scroll;
}

.flotsam-modal__list .flotsam-modal__selected-item {
    background: var(--flotsam-selected, pink);
}

.flotsam-modal__empty {
    max-height: 200px;
    padding: 25px;
    color: var(--flotsam-empty, grey);
    font-size: 14px;
}

.flotsam-modal__hint,
.flotsam-modal__status {
    clip: rect(0 0 0 0);
    clip-path: inset(50%);
    height: 1px;
    overflow: hidden;
    position: absolute;
    white-space: nowrap;
    width: 1px;
}

You will likely want to replace and write your own, but the imported styles will hopefully get you set up and started.

Roadmap

  • 100% a11y parity with alphagov/accessible-autocomplete
  • Custom empty state option
  • Assistive text for screen readers (using aria-describeby)
  • Optional empty state modal
  • Outside click close (with option to disable that)
  • Keep the project small in size

Nice to haves

  • Custom filterBy and sortBy functions before we generate autocomplete list items
  • Custom regex for the text highlight on autocomplete

Code of Conduct

AREA 17 is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the AREA 17 community to abide by our Code of Conduct. Please read it. Please follow it.