@midiu/sticky/README.md

A lightweight vanilla javascript for creating sticky elements pinned to the page or to a container element

<div align="center">

![](https://img.shields.io/npm/l/@midiu/sticky.svg?style=flat-square)
![](https://img.shields.io/github/size/vinhtrinh/sticky/src/js/sticky.js.svg?style=flat-square)
![](https://img.shields.io/npm/v/@midiu/sticky.svg?style=flat-square)
![](https://img.shields.io/npm/dt/@midiu/sticky.svg?style=flat-square)

![](https://img.shields.io/travis/vinhtrinh/sticky.svg?style=flat-square)
![](https://img.shields.io/david/vinhtrinh/sticky.svg?style=flat-square)
![](https://img.shields.io/david/dev/vinhtrinh/sticky.svg?style=flat-square)

[![](https://sonarcloud.io/api/project_badges/measure?project=vinhtrinh_sticky&metric=alert_status)](https://sonarcloud.io/dashboard?id=vinhtrinh_sticky)
[![](https://sonarcloud.io/api/project_badges/measure?project=vinhtrinh_sticky&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=vinhtrinh_sticky)
[![](https://sonarcloud.io/api/project_badges/measure?project=vinhtrinh_sticky&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=vinhtrinh_sticky)
[![](https://sonarcloud.io/api/project_badges/measure?project=vinhtrinh_sticky&metric=coverage)](https://sonarcloud.io/dashboard?id=vinhtrinh_sticky)

#
</div>


## Sticky

> Sticky is a library for sticky elements written in vanilla javascript. With this library you can easily set sticky elements on your website

### Installation

```shell
npm install --save @midiu/sticky
```

### Usage

``` js
new Sticky(document.querySelector('.section-1 .sticky'), {
    containment: document.querySelector('.section-1')
});
```