# HawkSearch Handlebars UI

The HawkSearch Handlebars UI package allows you to add a highly-customizable search results page to your website powered by [HawkSearch](https://www.hawksearch.com/).

## Getting Started

### Install

#### Stable (recommended)

Installs the most recent stable release (npm dist-tag: `latest`):

```bash
npm install --save @bridgeline-digital/hawksearch-handlebars-ui
```

#### Beta / prerelease

Installs the most recent prerelease build (npm dist-tag: `beta`):

```bash
npm install --save @bridgeline-digital/hawksearch-handlebars-ui@beta
```

### Modify HTML

Modify your HTML by importing the HawkSearch Handlebars UI script file and adding the appropriate HTML elements.

```html
<!DOCTYPE html>
<html lang="en">
    <head>
        <title>HawkSearch Handlebars UI</title>
        <meta name="viewport" content="width=device-width, initial-scale=1" />

        <script type="module" src="node_modules/@bridgeline-digital/hawksearch-handlebars-ui/dist/hawksearch-handlebars-ui.min.js"></script>
        <script type="text/javascript">
            addEventListener('hawksearch:loaded', () => {
                HawkSearch.init({
                    clientId: 'YOUR_CLIENTID_HERE'
                });
            });
        </script>
    </head>
    <body>
        <h1>HawkSearch Handlebars UI</h1>
        <hawksearch-search-field></hawksearch-search-field>
        <hawksearch-search-results></hawksearch-search-results>
    </body>
</html>
```

To display a landing page or recommendations instead of search results, replace:

- `<hawksearch-search-results></hawksearch-search-results>`

With either:

- `<hawksearch-landing-page></hawksearch-landing-page>`
- `<hawksearch-recommendations widget-id="YOUR_WIDGETID_HERE"></hawksearch-recommendations>`

## Documentation

- Latest docs: https://handlebars-ui.hawksearch.com/latest/

## Maintainers

# Release workflow and CI behavior are documented in `internal.md`.
