This repository contains the source code for the Hawksearch React component library. This can be utilized for building rich Hawksearch experiences using modern UI components.
The Hawksearch React SDK is built into two bundles:
- Minified JS
- ES6 Module
The minified JS is targetted a consumers that need to get up and running quickly by simply including the JS in their page. This bundle also comes with a pre-styled CSS file that contains basic stylings for the search UI components.
Customization can be accomplished via additional CSS styling. For richer customization, use the ES6 Module.
The ES6 module build is for consumers with an existing webpack build process. The output of this build is a single ES6 module JS file that can be consumed by Webpack or other modern bundlers.
Various React components are exported by this bundle that can be utilized by consumers. A CSS file is also provided that can additionally be included via a bundler.
To build the bundles, the following commands can be used:
npm run bundle:min:prodornpm run bundle:min:devfor the minified JS.npm run bundle:esm:prodornpm run bundle:esm:devfor the ES6 module.npm run bundle:all:prodornpm run bundle:all:devfor both.
To run a full build (which includes checks, tests, etc):
npm run build:prodornpm run build:dev.
The outputs of these builds will be located in /dist
Type checking, linting, style checking, tests:
npm run check:lintnpm run check:typesnpm run check:stylenpm run check:allnpm run test