react-light-select

1.0.2 • Public • Published

React Light Select - Demo

npm

View Demo

react-light-select is a lightweight ReactJS selectbox component (~3kb minified) that lets you define your options and a callback for when the selection changes.

The elements list is your browser's default and works on every browser and device, it doesn't define a custom elements list.

Install

Simply run

npm install react-light-select --save

and require it with your favorite bundler (tested with Browserify and Webpack).

Don't forget to include the provided CSS (or write your own)

Example:

var ReactLightSelect = require('react-light-select');

or if you're using ES6

import ReactLightSelect from 'react-light-select';

Include the CSS in your HTML (change the path to your needs):

<link rel="stylesheet" href="../node_modules/react-light-select/examples/react-light-select.css" media="screen">

Then use it like this (JSX style, but you are free to use it in plain JS):

<ReactLightSelect 
    value={this.state.selectOption} 
    data={'a'}
    onSelectChange={this.onChange}
/>

Configuration

The most basic select must have data and onSelectChange props, for example:

<ReactLightSelect 
    value={this.state.selectOption} 
    data={'a'}
    onSelectChange={this.onChange}
/>

Following there's a complete list of props you can pass to the component.

Props

data

type: array

This is needed to populate the selectbox.

Example:

const data = [
    {label:"Option A", value:"a"},
    {label:"Option B", value:"b"},
    {label:"Option C", value:"c"}
];

<ReactLightSelect 
    value={'a'}
    data={data}
    onSelectChange={this.onChange}
/>

onSelectChange

type: function

This gets called when a the user selects a new option.

value

type: string

Default value.

Build

The component is written in ES6 and JSX, so you need to compile it first.

Clone the project, run

npm install

and then open up the test environment with the command

gulp serve

This command will open a web page with live reload so you can develop and see the changes in realtime.

Contribute

Contributions are welcome!

Fork the project and send a pull request when you're ready.

Package Sidebar

Install

npm i react-light-select

Weekly Downloads

0

Version

1.0.2

License

MIT

Last publish

Collaborators

  • dannycalleri