API reference
Constructor and statics
| Member | Description |
|---|
new Mozert(el, options) | Create a slider. el is an element or selector. Returns the existing instance if already created. |
Mozert.get(el) | Instance for an element, or null. |
Mozert.initAll(root?, options?) | Initialise every [data-mozert] element under root. |
Mozert.defaults | Default options (mutable). |
Mozert.version | Version string. |
Mozert.use(module) | Register a module (see below). |
Methods
| Method | Description |
|---|
next() / prev() | Move one step. |
goTo(index, dontAnimate?) | Go to a slide. |
play() / pause() / isPlaying() | Control autoplay. |
getOption(name) / setOption(name, value, refresh?) | Read or change options live. setOption(object) also works. |
add(markup, index?, addBefore?) / remove(index, removeBefore?) / removeAll() | Change slides at runtime. |
filter(selectorOrFn) / unfilter() | Show a subset of slides. |
getSlides() / slideCount() / currentSlide() / getState() | Inspect. |
refresh() / setPosition() | Rebuild or recalculate layout (after the container size changes). |
destroy() | Restore the original markup and remove listeners. |
on(name, fn) / once / off / emit | Events. |
Events
Listen with slider.on('afterChange', (slider, current) => {}), the on option, a DOM listener for mozert:afterChange, or jQuery .on('afterChange', ...).
| Event | Arguments (after slider) |
|---|
init, reInit, destroy, setPosition | |
beforeChange | currentIndex, nextIndex |
afterChange | currentIndex |
breakpoint | breakpoint |
swipe, edge | direction: left | right | up | down |
lazyLoaded, lazyLoadError | element, source |
autoplayStart, autoplayStop | |
autoplayTimeLeft | ms left, progress 0..1 |
zoomChange | scale |
virtualRender | indexes rendered |
freeModeEnd | target translate |
Module API
Mozert.use({
name: 'my-module',
defaults: { myOption: false }, // merged into Mozert.defaults
create(slider) {
if (!slider.s.myOption) return null; // slider.s = resolved settings
slider._onFx((pv, animate, speed) => { // pv = visual position in slide units
/* update visuals */
});
slider._sub('afterChange', () => {}); // auto-unsubscribed on rebuild
return { destroy() { /* cleanup */ } };
}
});
Members starting with _ are for modules and may change between minor versions.