# stickyfill-web-module

> This repo is a combination of the [wilddeer `position: sticky` polyfill](https://github.com/wilddeer/stickyfill) and the [web module](https://github.com/webmodules/stickyfill) that was created to wrap it.

Latest version **1.1.11** (published 2016-11-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install stickyfill-web-module
pnpm add stickyfill-web-module
yarn add stickyfill-web-module
bun add stickyfill-web-module
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.11 |
| Published | 2016-11-23 |
| First published | 2016-11-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Brian Hedberg |
| Maintainers | gemfarmer |

## Links

- npm: https://www.npmjs.com/package/stickyfill-web-module
- Repository: https://github.com/18F/stickyfill
- Issues: https://github.com/18F/stickyfill/issues
- npm.io page: https://npm.io/package/stickyfill-web-module

## Recent versions

- 1.1.11 (latest) — 2016-11-23
- 1.1.10 — 2016-11-23

## README

#`position: sticky` polyfill and webmodule.

This repo is a combination of the [wilddeer `position: sticky` polyfill](https://github.com/wilddeer/stickyfill) and the [web module](https://github.com/webmodules/stickyfill) that was created to wrap it. 

This repo is using code from v1.1.4 of [wilddeer/stickyfill](https://github.com/wilddeer/stickyfill) with some minor updates.

The most accurate sticky polyfill out in the wild.

Check out [the demo](http://wd.dizaina.net/en/scripts/stickyfill/) and [use cases test page](http://wilddeer.github.io/stickyfill/test/).

###What it does

- supports top-positioned stickies,
- works in IE9+,
- disables in older IEs and in browsers with native `position: sticky` support.
- Mimics original `position: sticky` behavior:

	- uses parent node as a boundary box,
	- behaves nicely with horizontal page scrolling,
	- only works on elements with specified `top`,
	- mimics native `top` and `margin-bottom` behavior,
	- ~~works with table cells~~ disabled until Firefox [makes a native implementation](https://bugzilla.mozilla.org/show_bug.cgi?id=975644)

###What it doesn't

- doesn't support left, right, bottom or combined stickies,
- doesn't work in overflowed blocks,
- doesn't parse your CSS! Launch it manually.

###Installation

Download:

- [stickyfill.min.js](https://raw.github.com/18F/stickyfill/master/dist/stickyfill.min.js) – minified production script
- [stickyfill.js](https://raw.github.com/18F/stickyfill/master/dist/stickyfill.js) – full development script

Include it on your page:

```html
<script src="path/to/stickyfill.js"></script>
```

Available using npm:
```
npm i stickyfill-web-module
```

You can then require it in your javascript like so

```js
var Stickyfill = require('stickyfill-web-module')();
```

###Usage

JS:

```js
var stickyElements = document.getElementsByClassName('sticky');

for (var i = stickyElements.length - 1; i >= 0; i--) {
    Stickyfill.add(stickyElements[i]);
}
```

or JS + jQuery:

```js
$('.sticky').Stickyfill();
```

CSS:

```css
.sticky {
    position: -webkit-sticky;
    position: sticky;
    top: 0;
}
```

Also worth having a clearfix:

```css
.sticky:before,
.sticky:after {
    content: '';
    display: table;
}
```

###Pro tips

- `top` specifies sticky's position relatively to the top edge of the viewport. It accepts negative values, too.
- Despite common misconception, sticky's bottom limit is defined by its parent node's bottom boundary. It has nothing to do with `offsetParent` (closest relatively positioned parent).
- You can push sticky's bottom limit up or down by specifying `margin-bottom`.
- Any non-default value (not `visible`) for `overflow`, `overflow-x`, or `overflow-y` on any of the predecessor elements anchors the sticky to the overflow context of that predecessor. Simply speaking, scrolling the predecessor will cause the sticky to stick, scrolling the window will not. This is expected with `overflow: auto` and `overflow: scroll`, but often causes problems and confusion with `overflow: hidden`. Keep this in mind, folks!

Check out [the test page](http://wilddeer.github.io/stickyfill/test/) to understand stickies better.

###API

####`Stickyfill.add(HTMLNode)`

Add new sticky and `init()`, if necessary.

####`Stickyfill.remove(HTMLNode)`

Remove sticky.

####`Stickyfill.rebuild()`

Recalc all metrics and update stickies' positions.

Call it after layout changes. Launches automatically after window resizes and device orientations changes.

####`Stickyfill.pause()`

Remove event listeners.

Usefull for debugging. Use `Stickyfill.init()` to get stuff running again.

####`Stickyfill.stop()`

Disable stickies.

Use `Stickyfill.init()` to enable them again.

####`Stickyfill.kill()`

Disable stickies and erase `Stickyfill.stickies`.

####`Stickyfill.init()`

Attach event listeners and start watching for stickies in `Stickyfill.stickies`.

####`Stickyfill.stickies`

Array of parametric objects for all added stickies.

###Using Stickyfill?

Be sure to drop me a link &rarr; [:envelope: wd@dizaina.net](mailto:wd@dizaina.net). Wanna see it in action.

###License

[MIT license](http://opensource.org/licenses/MIT).

---
_Source: https://npm.io/package/stickyfill-web-module · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._