README.md

react-searchbox

react-searchbox is a simple Searchbox component with events for keychange, searching and clearing.

Install

yarn add react-searchbox

Usage

import Search from 'react-searchbox'
import ReactDOM from 'react-dom'
import React, { Component } from 'react'

class TestComponent extends Component {
  clear() {
    console.log('clearing...')
  }
  search() {
    console.log('searching...')
  }
  change(key) {
    console.log('key change...')
    console.log(key)
  }

  constructor(props) {
    super(props)
  }

  render() {
    return (
      <div style={{ padding: '20px', maxWidth: '400px' }}>
        <Search
          inputName="my-input"
          placeholder="Search for something..."
          onClearClick={this.clear.bind(this)}
          onSearchClick={this.search.bind(this)}
          onKeyChange={this.change.bind(this)}
        />
      </div>
    )
  }
}

ReactDOM.render(<TestComponent />, document.getElementById('root'))

Props

inputName (optional)

The name of the input element

placeholder (optional)

The placeholder for the input element

autoFocus (optional)

Focus the input element on component mount if set to true.

onSearchClick (optional)

Handler for the click event of the search button, returns the search value.

onKeyChange (optional)

Handler for the onKeyUp event on the input element, returns the search value.

onClearClick (optional)

Handler for the click event of the clear button, returns the search value.

Styles

react-searchbox can be used with your own custom styles. A minimal react-searchbox.css style sheet is included.

Development

yarn
yarn dev

Test

yarn test

Build

yarn
yarn build

Publish

npm login
npm version patch
git add -A
git push origin master
npm publish

License

MIT