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

react-accessible-typeahead

v0.2.2

Published

composable, accessible, keyboard and screen reader friendly typeahead component

Downloads

35

Readme

react-accessible-typeahead

Composable, accessible, keyboard and screen reader friendly, see it in action at https://sarbbottam.github.io/react-accessible-typeahead/

Installation

npm i react-accessible-typeahead --save

Usage

Import the react-accessible-typeahead/build/main.css to App so:

@import /path/to/node_modules/react-accessible-typeahead/build/main.css;

Use the react-accessible-typeahead component in the App like so:

import React from 'react';
import Typeahead from 'react-accessible-typeahead';
import Input from './input';
import Options from './options';

class MyTypeahead extends React.Component {
  constructor(props) {
    super(props);
    this.state = {
      inputValue: '',
      options: [],
      numberOfOptions: 0
    };

    this.fetchOptions = fetchOptions.bind(this);
    this.onSelect = this.onSelect.bind(this);
    this.onChange = this.onChange.bind(this);
  }

  fetchOptions(query) {
    this.setState({
      // some function to fetch option that can be accessed here
      // options: functionToFetchOption(query)
    });
  }

  onSelect(selectedindex) {
    this.setState(prevState => ({
      inputValue: e ? e.target.innerHTML : prevState.options[selectedindex]
    }));
  }

  onChange(e) {
    this.setState({
      inputValue: e.target.value
    });

    this.fetchOptions(e.target.value || '');
  }

  render() {
    return (
      <Typeahead
        // namespace will be used as an id prefix
        namespace="wikipedia-typeahead"
        // number of available options
        numberOfOptions={this.state.numberOfOptions}
        // use onSelect hook to perform any action corresponding to the event
        onSelect={this.onSelect}
      >
        <Input
          // should be used as label
          placeholder="Search"
          // use onChange to fetch data, update this.state.options and numberOfOptions
          // this method will be called from TypeAhead's onChange method
          // TypeAhead's onChange method will be passed to this Input as props
          onChange={this.onChange}

          value={this.state.inputValue}

          // pass any other props if needed
          {...props}
        />
        <Options
          /* optional */

          // pass any props if needed
          // probably pass this.state.options which could be used by Options component
          options={this.state.options}
          {...props}
        />
      </Typeahead>
    );
  }
}

Refer example directory for a concrete example.

The example components are also part of the distribution, please access them like so:

import Input from '/path/to/node_modules/react-accessible-typeahead/build/example/component/input.js';
import Options from '/path/to/node_modules/react-accessible-typeahead/build/example/component/options.js';
import TypeaheadWikipedia from '/path/to/node_modules/react-accessible-typeahead/build/example/component/typeahead-wikipedia.js';

Please ensure to import the /path/to/node_modules/react-accessible-typeahead/build/example/main.css, like so:

@import /path/to/node_modules/react-accessible-typeahead/build/example/main.css;

Contributing

Please refer CONTRIBUTING.md for instructions to get started.

License

This project is licensed under the MIT.