martin

1.1.3 • Public • Published

martin Build Status Gitter

Extendable vanillaJS slider

Supported browsers

Works fine in modern browsers, for older must be used element.classList polyfill

  • ie9 (without transitions)
  • ie10+

Polyfills

Plugins

Usage

<!-- .martin-slideshow will be initialized on document ready -->
<section class="martin-slideshow martin-fx-horz">
    <!-- Height based on first slide -->
    <article class="martin-slide"></article>
    <!-- Active class recommended to prevent flashing -->
    <article class="martin-slide martin-active"></article>
    <article class="martin-slide"></article>
    <span class="martin-prev"></span>
    <span class="martin-next"></span>
</section>

Effects

Effect is on of this css classes:

  • .martin-fx-horz
  • .martin-fx-vert
  • .martin-fx-fade
  • .martin-fx-leave

Controls

Prev and next buttons

Options

<div class="martin-slideshow"
    data-martin-prev=".martin-prev"
    data-martin-next=".martin-next"></div>
{
  prev: '.martin-prev',
  next: '.martin-next'
}

API

inst = new Martin(el || selector, options)

inst.slideTo(index, direction)

callback({ index, direction })

inst.slidePrev()

callback({ index })

inst.slideNext()

callback({ index })

inst.on(event, callback)

event is one of init, slide, slidePrev, slideNext

Action will be prevented if callback will return false

Helpers

inst.attr(name)

Returns data-martin-* attribute value with related type

inst.option()

Returns first 'defined' argument

inst.listen(event, callback)

Listen system event on slider root-element

inst.listen(selector, event, callback)

Listen system event on slider children elements

Martin.get(el)

Returns instance of Martin by element

Writing a plugin

Martin.hook(callback)

To combine hooks you may use init event:

Martin.hook('plugin', function (opts) {
    this.on('init', function () {
        // All hooks are ready
    });
});

Will called with current instance on initialize

License

The MIT License (MIT)

Copyright © 2015 Bogdan Chadkin

Readme

Keywords

none

Package Sidebar

Install

npm i martin

Weekly Downloads

2

Version

1.1.3

License

MIT

Last publish

Collaborators

  • trysound