react-text-filter
React component that renders filtering Input
Installation
NPM
npm install --save react react-text-filter
Don't forget to manually install peer dependencies (react
) if you use npm@3.
1998 Script Tag:
(Module exposed as `TextFilter`)
Demo
http://nkbt.github.io/react-text-filter
Codepen demo
http://codepen.io/nkbt/pen/ZGmpoO
Usage
;;; const Item = React; const List = React; const fruits = 'apple' 'orange' 'banana' 'kiwi' 'pineapple' 'golden kiwi' 'green apple'; const fruitFilter = fruit !== -1; const App = React; const appRoot = document;documentbody;ReactDOM;
Options
onFilter
: PropTypes.func.isRequired
Function called when filter is changed (debounced) with original event passed through
filter
: PropTypes.string (default: '')
Initial filter value
minLength
: PropTypes.number (default: 2)
Minimal length of text to start notify
debounceTimeout
: PropTypes.number (default: 300)
Notification debounce timeout in ms
<input>
Arbitrary props will be transferred to the rendered <TextFilter onFilter= this placeholder="Filter" className="my-filter" />
Will result in
<input type="text" placeholder="Filter" className="my-filter" />
License
MIT