@reactify-apps/search v2.1.1

Reactify Search UI

This library provides React components and hooks for building UI's for the Reactify Search app.

The aim of this library is not to build a search and filter interface from the ground up. The aim of this library is to abstract the complexities of Reactify Search, whilst providing the developer a wide range of approaches and escape hatches to build in the way they want to. To do this, we wrap a mature Elasticsearch UI library called Reactivesearch (similar name, but completely unaffiliated with Reactify Search).

Getting started

npm install @reactify-apps/search

You should always begin with the Provider component, which you need to pass the Reactify Search config and index name, using whichever mechanism is most appropriate for your project. Within the provider, you can then begin to render components from the @reactify-apps/search package or ordinary Reactivesearch components.

import { Provider } from "@reactify-apps/search";

export const YourComponent: React.FC = () => {
  return (
    <Provider index="my-cool-shop" config={config}>
      <YourComponents />
    </Provider>
  );
};

Contributing

# install dependencies
npm install

# watch and build the package
npm run watch

# serve storybook to interact with components
npm run storybook

# release a version
npm run release