deku-search
v2.0.0
Published
a simple Search Autocomplete component
Downloads
10
Maintainers
Readme
deku-search
deku-search is a simple Autocomplete Search component
Install
npm install deku-search --save
Usage basic
Pass in your items
as a prop to deku-search. The items must be an array of objects with value
and id
, and any other props you may need, which will not be displayed. Check out the example for more info.
/** @jsx element */
import Search from 'deku-search'
import { element, createApp } from 'deku'
function HiItems(items) {
console.log(items)
}
let items = [
{ id: 0, value: 'ruby' },
{ id: 1, value: 'javascript' },
{ id: 2, value: 'lua' },
{ id: 3, value: 'go' },
{ id: 4, value: 'julia' }
]
function update () {
render(<Search items={items}
placeholder='Pick your language'
NotFoundPlaceholder='No items found...'
maxSelected={3}
multiple={true}
onItemsChanged={ (items) => HiItems(items) } />, {})
}
var render = createApp(document.body, update)
update()
Props
items
(required)
List of Items to filter through, an array of items with value
and id
, and any other props. value is displayed. let items = [{ id: 0, value: 'ruby' }, { id: 1, value: 'lua' }
multiple
(optional)
Defaults to false, set as true if you want multiple items in the list, false for a single selection dropdown.
maxSelected
(optional)
Defaults to 100, a maximum number of items allowed to be selected
placeholder
(optional)
placeholder for the input
NotFoundPlaceholder
(optional)
The placeholder shown when no results are found
onItemsChanged
(optional)
Handler returns the items from the Search autocomplete component when items are added or removed from the list.
onKeyChange
(optional)
Handler returns the search value on key change.
Styles
deku-search can be used with your own custom styles. A minimal deku-search.css style sheet is included.
Development
npm install
npm run build
npm test
npm start