react-select README

The project's README from github.com/JedWatson/react-select. As one markdown file: README.md.

NPM CircleCI Coverage Status Supported by Thinkmill

React-Select

The Select control for React. Initially built for use in KeystoneJS.

See react-select.com for live demos and comprehensive docs.

react-select is funded by Thinkmill and Atlassian. We are an open source project that is continuously supported by the community.

React Select helps you develop powerful select components that just work out of the box, without stopping you from customising the parts that are important to you.

For the story behind this component, watch Jed's talk at React Conf 2019 - building React Select

Features include:

Using an older version?

Installation and usage

The easiest way to use react-select is to install it from npm and build it into your app with Webpack.

yarn add react-select

Then use it in your app:

import React, { useState } from 'react';
import Select from 'react-select';

const options = [
  { value: 'chocolate', label: 'Chocolate' },
  { value: 'strawberry', label: 'Strawberry' },
  { value: 'vanilla', label: 'Vanilla' },
];

export default function App() {
  const [selectedOption, setSelectedOption] = useState(null);

  return (
    <div className="App">
      <Select
        defaultValue={selectedOption}
        onChange={setSelectedOption}
        options={options}
      />
    </div>
  );
}

Props

Common props you may want to specify include:

See the props documentation for complete documentation on the props react-select supports.

Controllable Props

You can control the following props by providing values for them. If you don't, react-select will manage them for you.

If you don't provide these props, you can set the initial value of the state they control:

Methods

React-select exposes two public methods:

Customisation

Check the docs for more information on:

TypeScript

The v5 release represents a rewrite from JavaScript to TypeScript. The types for v4 and earlier releases are available at @types. See the TypeScript guide for how to use the types starting with v5.

Thanks

Thank you to everyone who has contributed to this project. It's been a wild ride.

If you like React Select, you should follow me on Twitter!

Shout out to Joss Mackison, Charles Lee, Ben Conolly, Tom Walker, Nathan Bierema, Eric Bonow, Emma Hamilton, Dave Brotherstone, Brian Vaughn, and the Atlassian Design System team who along with many other contributors have made this possible ❤️

License

MIT Licensed. Copyright (c) Jed Watson 2022.

react-select (JedWatson/react-select)

Searching Database…

28K ·GitHub
React-select
Что это такое?React Select — гибкий, настраиваемый компонент выпадающего списка (select/dropdown) для приложений на React, изначально созданный для KeystoneJS.
Это библиотека UI-компонентов или полноценный фреймворк?Это отдельная библиотека UI-компонентов, которую вы подключаете к приложению на React, а не фреймворк — она распространяется как npm-пакет, который вы импортируете и выводите на экран.
Как добавить его в проект?Установите его из npm и соберите с помощью Webpack (или другого инструмента сборки), затем импортируйте и выведите компонент Select в вашем приложении.
Нужно ли что-то кроме самого React?Никакой особый бэкенд или API-ключ не требуется — это клиентский компонент, хотя для настройки стилей под капотом используется CSS-библиотека Emotion.
Будет ли мой старый код v1/v2 работать после обновления?Нет — мажорные версии содержат несовместимые изменения, а v5 — это полная переработка с JavaScript на TypeScript, поэтому старая документация и типы хранятся отдельно.
Какие основные варианты настройки есть?Обработку данных можно настраивать с помощью функций, оформление задаётся через API стилей на основе Emotion, собственные компоненты подставляются через Component Injection API, а состоянием можно управлять через контролируемые пропсы, такие как value, menuIsOpen и inputValue.
Поддерживается ли множественный выбор и поиск?Да, через пропсы isMulti для выбора нескольких значений и isSearchable, которое позволяет пользователям фильтровать варианты вводом текста.
Есть ли встроенная асинхронная загрузка вариантов?Да, в документации описано создание асинхронного списка для динамической загрузки вариантов, а также поддержка групп вариантов, порталов и анимированных переходов.
Работает ли это с TypeScript?Да, начиная с v5 вся библиотека написана на TypeScript и есть отдельное руководство по TypeScript; в более ранних версиях были отдельные пакеты @types.
What are similar projects?drawably, blobatar, cult-ui, rare-ui, react-transition-group, shaders, Libraries.dev, react-bootstrap
Which topics is it in?component-library, ui-components, animation, css, react, npm, frontend, library, typescript, javascript, web, mit
Creator
JedWatson
Size
18.9 MB
Stars
28K
Updated
CommitJul 16Release[email protected]Jul 11
Age
12y
Commits · 90 Days