Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.04 KB

README.md

File metadata and controls

29 lines (21 loc) · 1.04 KB
Raw

sioux offscreen

More info from sioux: gerhardberger.github.io/sioux/

npm install sioux-offscreen

An off screen navigation item. Similar to the menu of the Facebook and Path app. demo. It requires two part: an offscreen elem which is hidden behind the other onscreen element.

var Offscreen = require('sioux-offscreen');

var off = new Offscreen(offscreenElement, onscreenElement);

off.toggle(function () {
  console.log('Toggled!');
});

properties

  • offscreen: the off screen DOM element
  • onscreen: the forward DOM element
  • hidden: Boolean, whether the offscreen element is hidden or not

methods

  • show(callback): shows the offscreen element, the callback gets called when the animation ended
  • hide(callback): hides the offscreen element, the callback gets called when the animation ended
  • toggle(callback): toggles the state, the callback gets called when the animation ended