sticky.ts
A library for sticky elements written in TypeScript and compiled to vanilla JavaScript.
sticky-ts is a library for creating sticky elements for your website. It is originally inspired by sticky-js and its many forks.
Features
- No dependencies
- The safety of TypeScript and the minimalism of vanilla JavaScript
- Lightweight
- You may sticky an element the entire page or a specific container
- No additional CSS needed
Install
npm install sticky-ts
Usage
Include the module in your bundle or the dist build into your HTML.
And given an element
Sticky element
Initialize in your code
let sticky = '.selector';
Syntax
selector:string global options:object
Examples
Multiple sticky elements with data-sticky-container and options
Sticky-js Lorem ipsum.....
Methods
Update sticky, e.g. when parent container (data-sticky-container) change height
var sticky = '.sticky'; // and when parent change height..sticky;
Destroy sticky element
var sticky = '.sticky'; sticky;
Available options
Option | Type | Default | Description |
---|---|---|---|
data-sticky-wrap | boolean | false | When it's true sticky element is wrapped in <span></span> which has sticky element dimensions. Prevents content from "jumping". |
data-margin-top | number | 0 | Margin between page and sticky element when scrolled |
data-sticky-for | number | 0 | Breakpoint which when is bigger than viewport width, sticky is activated and when is smaller, then sticky is destroyed |
data-sticky-class | string | null | Class added to sticky element when it is stuck |
Browser Compatibility
Library is using ECMAScript 5 features.
- IE 9+
- Chrome 23+
- Firefox 21+
- Safari 6+
- Opera 15+
If you need this library working with older browsers you should use ECMAScript 5 polyfill.
Website
https://jziggas.github.io/sticky-ts/