2.0.1 • Published 3 years ago

react-search-field v2.0.1

Weekly downloads
1,811
License
MIT
Repository
github
Last release
3 years ago

React Search Field

dependencies Status Actions Status

NPM

An elegant search field component for React.

See Demo and Documentation.

Screenshot

Props

The component takes the following props.

PropTypeDescription
classNamesstringAdditional classnames for the component
searchTextstringInitial search value of the input
placeholderstringplaceholder for the search input
disabledbooleanDisabling the search input
onChangefunctionCallback function to invoke when the user press any key. The function should contain two parameters(value, event).
onEnterfunctionCallback function to invoke when the user press enter after pressing few keys. The function should contain two parameters(value, event).
onSearchClickfunctionCallback function to invoke when the user click the search button. The function should contain one parameter(value).
onBlurfunctionCallback function to invoke when the user blurs the search box. The function should contain two parameters(value, event).

Installation

npm install react-search-field --save

Usage

import SearchField from "react-search-field";

<SearchField
  placeholder="Search..."
  onChange={onChange}
  searchText="This is initial search text"
  classNames="test-class"
/>

Run

npm start

License

MIT Licensed. Copyright (c) Farhad Yasir 2021.