@bloomreach/limitless-ui-react
v0.7.0
Published
## Getting Started
Downloads
382
Maintainers
Keywords
Readme
Bloomreach Limitless UI - React
Getting Started
Prerequisites
- Node.js (version 20 or higher)
- React (version 18.3.1 or higher)
- @bloomreach/discovery-web-sdk (version 1.2.1 or higher)
Installation
NPM:
npm add @bloomreach/limitless-ui-react
PNPM:
pnpm add @bloomreach/limitless-ui-react
Yarn:
yarn add @bloomreach/limitless-ui-react
Basic Setup
- Set up the Limitless UI provider in your main App component:
import { LimitlessUIProvider } from '@bloomreach/limitless-ui-react';
const App = () => {
return <LimitlessUIProvider>{/* Your app components */}</LimitlessUIProvider>;
};
export default App;
- Use Limitless UI React components in your application:
import { SearchBox } from '@bloomreach/limitless-ui-react';
const SearchPage = () => {
return (
<div>
<SearchBox />
</div>
);
};
export default SearchPage;
Storybook
For a complete API reference, including all available components, hooks, and their props, please refer to our Storybook documentation.
Developer guide
For getting started with the project and for a more extensive guide see our Developer guide.
Contribution & Development
See our Contribution Guide.
Changes
See our Changelog for a the series of releases and their changes.