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

@n3/react-autocomplete

v2.0.0

Published

Autocomplete component for react applications

Downloads

451

Readme

@n3/react-autocomplete

Установка

yarn add @n3/react-autocomplete styled-components

API

Использование

import { Autocomplete } from '@n3/react-autocomplete';

<Autocomplete
  loadOptions={(q) => fetch(`/options/?q=${q}`).then((response) => response.json())}
  value={value}
  onChange={(event) => {
    onChangeCallback(event.target.value)
  }}
  onSelect={(text, option) => {
    onSelectCallback(text, option);
  }}
/>

Терминология

Лейбл опции вычисляется следующим способом:

1. Если определено `getItemValue`, лейбл поля будет равен результату вызова `getItemValue` от опции.
2. Если определено `labelKey`, лейбл поля будет равен значению опции по ключу `labelKey`.
3. Лейбл поля будет равен значению опции по ключу "label".

Props

  • loadOptions - обязательное, асинхронная функция, которая должна возвращать список опций для автокомплита. Первым аргументом принимает параметр поиска.

  • value - обязательное, строка, которая выводится в инпуте.

  • onChange - необязательное, колбэк, вызывающийся после ручного изменения инпута. Первым аргументом принимает событие.

  • onSelect - необязательное, колбэк, вызывающийся после выбора опции из списка. Первым аргументом принимает лейбл опции, вторым - опцию.

  • disabled - булево, выключено ли поле.

  • hasError - булево, есть ли у поля ошибка.

  • hasWarning - булево, есть ли у поля предупреждение.

  • inputProps - дополнительные props, которые будут переданы инпуту.

  • labelKey - строка, нужна для определения лейбла опции.

  • getOptionLabel - функция, нужна для определения лейбла опции.

  • formatOptionLabel - функция, нужна для кастомного рендера опции. Может возвращать jsx. Первым аргументом принимает опцию.

  • components - объект переопределяемых компонентов. Ключи:

    • Wrapper
    • Input
    • Menu
    • MenuItem

Локальная разработка

Репозиторий использует стабильную версию yarn.

Инструкция по установке.

Команды

  • yarn build - сборка;

  • yarn clean - удалить все собранне файлы;

  • yarn test - валидация кода;

  • yarn start - запуск storybook с примерами.