React SDK for building search experience with Unbxd.
 IE / Edge |
 Firefox |
 Chrome |
 Safari |
 iOS Safari |
|---|---|---|---|---|
| IE11*, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
(*) Use polyfills in case of IE.
The quickest way to get started is to use Create Unbxd Search App.
npx @unbxd-ui/create-unbxd-search-app demo-app
cd demo-app
yarn startFor more details about using Create Unbxd Search App, refer here.
Install react-search-sdk using npm.
npm i @unbxd-ui/react-search-sdk --saveor using yarn
yarn add @unbxd-ui/react-search-sdkFollowing is the example of usage:
// The wrapper search component
import UnbxdSearchWrapper from '@unbxd-ui/react-search-sdk';
// Search components ship with basic presentational styles as well.
// They are optional, but if you want them you will need to also import the CSS file.
// This only needs to be done once; probably during your application's bootstrapping process.
import '@unbxd-ui/react-search-sdk/public/dist/css/core.css';
// You can import any component you want as a named export from 'react-search-sdk'
import { Products, Pagination, Sort } from '@unbxd-ui/react-search-sdk';
// Now you can use
<UnbxdSearchWrapper {...props}>
<Products {...props} />
<Pagination {...props} />
<Sort {...props} />
</UnbxdSearchWrapper>;Now you're ready to start using the components. You can learn more about which components react-search-sdk has to offer below.
react-search-sdk has very few dependencies and most are managed by NPM automatically.
However the following peer dependencies must be specified by your project in order to avoid version conflicts:
react,
react-dom.
NPM will not automatically install these for you but it will show you a warning message with instructions on how to install them.
API documentation available here.
Use GitHub issues for requests.
We actively welcome pull requests; learn how to contribute.
Changes are tracked in the changelog.