@redocly/react-dropdown-aria v2.0.12

react-dropdown-aria

Simple, lightweight, and accessible React dropdown component.

Purpose

This component was created to be a light weight and fully accessible dropdown component for React. For a more feature heavy and powerful dropdown look to the react-select package. (This dropdown is inspired by react-select)

Upgrading to v2

Please take note when upgrading from v1 to v2 there are breaking changes. Be sure to carefully read the changelog entry for v2.0.0.

Features

1. Fully customizable styling
2. Grouped options
3. Accessible
4. Searchable
5. Custom render function props
6. Typescript typings

Demo And Examples

For demo and examples see https://jfangrad.github.io/react-dropdown-aria/

Installation

Simply use npm or yarn to install the package.

// Yarn
$ yarn add react-dropdown-aria

// npm
$ npm install --save react-dropdown-aria

You can then include it in your project as needed:

import Dropdown from 'react-dropdown-aria';

Usage

Options should be provided to the Dropdown as an array of objects.

Simple Example:

<Dropdown
  ...
  options: {[
    { value: 'one' },
    { value: 'two' },
    { value: 'three' }
  ]}
/>

Each option object in the array of options can have the following keys:

Groups Example

Groups of items can also be implemented by pasing an array of objects of the following form to the dropdown options prop:

<Dropdown
  ...
  options: {[
    { label: 'Group 1', groupOptions: optionsGroup1 },
    { label: 'Group 2', groupOptions: optionsGroup2 },
  ]}
/>

Where the groupOptions is an array of options as described above, and the label is the string to display above the group in the dropdown.

Styling

Custom styling can be applied using CSS className props (As seen in props table below)

Dropdown Props

Developing

Clone the repo

git clone https://github.com/jfangrad/react-dropdown-aria.git

Install node modules

yarn install

Then in two seperate consoles start the library and demo

yarn lib:dev
yarn demo:dev