# PanelSnap

[![Build Status](https://travis-ci.org/guidobouman/panelsnap.svg?branch=develop)](https://travis-ci.org/guidobouman/panelsnap)
[![npm](https://img.shields.io/npm/v/panelsnap.svg)](https://www.npmjs.com/package/panelsnap)

A JavaScript plugin that provides snapping functionality to a set of panels within your interface.

## Installation

```bash
npm install panelsnap
```

```js
import PanelSnap from 'panelsnap';

const instance = new PanelSnap();
```

```html
<body>
  <section>
    ...
  </section>
  <section>
    ...
  </section>
  <section>
    ...
  </section>
</body>
```

## Documentation

Check out the documentation at [https://panelsnap.com](https://panelsnap.com) or the `docs` folder for a working demo.

## Credits

- [jellea](https://github.com/jellea) for early feedback and brainpickings.
- [aalexandrov](https://github.com/aalexandrov) for small improvements & bugfixes.
- [akreitals](https://github.com/akreitals) for fixing keyboard navigation when disabled.
- [brumm](https://github.com/brumm) far a panel count bug.
- [dpaquette](https://github.com/dpaquette) for the offset option.
- [wudi96](https://github.com/wudi96) for button navigation.
