Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ranajahanzaib/searchbox-js
React Search Box Library
https://github.com/ranajahanzaib/searchbox-js
react-search react-search-component search
Last synced: about 1 month ago
JSON representation
React Search Box Library
- Host: GitHub
- URL: https://github.com/ranajahanzaib/searchbox-js
- Owner: ranajahanzaib
- License: mit
- Created: 2021-10-16T14:26:06.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T13:24:14.000Z (almost 2 years ago)
- Last Synced: 2024-11-16T15:23:24.927Z (about 2 months ago)
- Topics: react-search, react-search-component, search
- Language: HTML
- Homepage:
- Size: 3.16 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SearchBox JS - React Library
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./CONTRIBUTING.md)
Create Search Boxes with complete functionalities and multiple variants.
# Get Started
### **Step 1** - Install Search Box.
```shell
npm i searchbox-js
```OR
```shell
yarn add searchbox-js
```### **Step 2** - Usage.
Once, you have installed the `searchbox-js` library, you can use it in your project by importing it in your `App.js` or any `.js` / `.jsx` files.
```diff
+ import { SearchBox } from "searchbox-js";
import "./App.css";function App() {
return (
+ ...
);
}export default App;
```# Contributing
We'd love to accept your patches and contributions to this project. There are just a few guidelines you need to follow.
### [Code of Conduct](./CODE_OF_CONDUCT.md)
This project follows [Contributor Covenant](https://www.contributor-covenant.org/)
as it's Code of Conduct, and we expect all project participants to adhere to it.
Please read the [full guide](./CODE_OF_CONDUCT.md) so that you can understand
what actions will not be tolerated.### [Contributing Guide](./CONTRIBUTING.md)
Read our [contributing guide](./CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to project.
### [LICENSE](./LICENSE)
This project is licensed under the [MIT License](./LICENSE), meaning that you're free to modify, distribute, and / or use it for any commercial or private project.