Affixed

Make something affix on scroll.

Usage

// es6 imports
import affixed from 'affixed';

// commonjs
// var affixed = require('affixed');

var menu = new affixed({
  element: document.getElementById('sticky-menu'),
  offset: 70,
  position: 'fixed',
  throttle: 10,
});

<div id="sticky-menu">
  ... content here
</div>

Parameters

| Param | Description | | :--- | :--- | | element | The DOM element to affix. | | offset | Amount of pixels to scroll before the element is affixed. | | position | Either absolute fixed, or mirror positioning. | | throttle | Specify the milliseconds to throttle the position updates. |

Notes

absolute positioned element's are reposition on every scroll which may perform slow in some instances. You should set the position to fixed whenever possible. If your element is within a container that is positioned relative, you will need to set the position parameter to absolute.

You can also choose to use the mirror position option. A mirror will be created and added to the <body/> element as a clone of your specified element. This mirror will now act as the affixed element.

Lint

$ npm run lint

Dev

$ npm run dev

Build

$ npm run build

License

MIT © Vu Tran