react-dropdown

react-dropdown
==============

[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][downloads-url]

Simple Dropdown component for React, inspired by react-select

$3

* The default HTML select element is hard to style
* And sometime we also want grouped menus
* if you want more advanced select, check react-select

$3

``
// with npm
$ npm install react-dropdown --save

// with yarn
$ yarn add react-dropdown
`

$3

If you want to support React version under v0.13, use react-dropdown@v0.6.1

$3

This is the basic usage of react-dropdown

`Javascript
import Dropdown from 'react-dropdown';
import 'react-dropdown/style.css';

const options = [
'one', 'two', 'three'
];
const defaultOption = options[0];
;
`

Options

Flat Array options

`JavaScript

const options = [
'one', 'two', 'three'
];
`

Object Array options

`JavaScript

const options = [
{ value: 'one', label: 'One' },
{ value: 'two', label: 'Two', className: 'myOptionClassName' },
{
type: 'group', name: 'group1', items: [
{ value: 'three', label: 'Three', className: 'myOptionClassName' },
{ value: 'four', label: 'Four' }
]
},
{
type: 'group', name: 'group2', items: [
{ value: 'five', label: 'Five' },
{ value: 'six', label: 'Six' }
]
}
];
`

When using Object options you can add to each option a className string to further customize the dropdown, e.g. adding icons to options

Disabling the Dropdown

Just pass a disabled boolean value to the Dropdown to disable it. This will also give you a .Dropdown-disabled class on the element, so you can style it yourself.

`JavaScript
;
`

$3

className

The className prop is passed down to the wrapper div, which also has the Dropdown-root class.

`JavaScript
;
`

controlClassName

The controlClassName prop is passed down to the control div, which also has the Dropdown-control class.

`JavaScript
;
`

placeholderClassName

The placeholderClassName prop is passed down to the placeholder div, which also has the Dropdown-placeholder class.

`JavaScript
;
`

menuClassName

The menuClassName prop is passed down to the menu div (the one that opens and closes and holds the options), which also has the Dropdown-menu class.

`JavaScript
;
`

arrowClassName

The arrowClassName prop is passed down to the arrow span , which also has the Dropdown-arrow class.

`JavaScript
;
`

arrowClosed, arrowOpen

The arrowClosed & arrowOpen props enable passing in custom elements for the open/closed state arrows.

`JavaScript
arrowClosed={}
arrowOpen={}
/>;
`

Check more examples in the example folder.

Run example

`
$ npm start
``

$3

MIT | Build for CSViz project @Wiredcraft

[npm-image]: https://img.shields.io/npm/v/react-dropdown.svg?style=flat-square
[npm-url]: https://npmjs.org/package/react-dropdown
[downloads-image]: http://img.shields.io/npm/dm/react-dropdown.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/react-dropdown