> This is ES module based on `https://www.npmjs.com/package/headroom.js`

More information about usage or others at [headroom.js](https://github.com/WickyNilliams/headroom.js)

## Installation

```bash
npm i @operato/headroom
```

## Usage

```html
<script type="module">
  import Headroom from '@operato/headroom'

  const head = document.querySelector('#head')
  const content = document.querySelector('#content')

  var headroom = new Headroom(head, {
    scroller: content
  })
  headroom.init()
</script>
```

## Linting and formatting

To scan the project for linting and formatting errors, run

```bash
npm run lint
```

To automatically fix linting and formatting errors, run

```bash
npm run format
```

## Testing with Web Test Runner

To execute a single test run:

```bash
npm run test
```

To run the tests in interactive watch mode run:

```bash
npm run test:watch
```

## Demoing with Storybook

To run a local instance of Storybook for your component, run

```bash
npm run storybook
```

To build a production version of Storybook, run

```bash
npm run storybook:build
```

## Tooling configs

For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

## Local Demo with `web-dev-server`

```bash
npm start
```

To run a local development server that serves the basic demo located in `demo/index.html`