Swipe a custom element out
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example
lib
test
.travis.yml
Makefile
Readme.md
gulpfile.js
history.md
karma.conf.js
package.json
webpack.config.js

Readme.md

Swipe-it

Swipe a custom element out.

NPM version Dependency Status Build Status Coverage Status

Give me a feed back if you have any problem with this.

Demo

Features

  • Animation like ios messages
  • Light weight and performance optimized
  • Delegate event binding
  • Custom animation
  • Custom render function
  • Support window orientation change & resize event
  • Works with sweet-sortable
  • Optional bind to list-render
  • Temporarily disable by calling bind and unbind

Example

var tap = require('component-tap-event')
var SwipeIt = require('swipe-it')
var template = require('./template.html')
var s = new SwipeIt(template)
s.bind(document.getElementById('list'), 'li')
s.delegate('touchstart', '.remove', tap(function(e, li) {
  // remove holder and swiped element with transition
  s.clear().then(function() {
    // callback on element removed
  })
}))

Events

  • start emit with swipe element when swipe start
  • end emit with swipe element after swiped element reset back
  • clear emit with swipe element just before remove transition begin, used for change the style of swiped element for transition

API

SwipeIt(template, [opts])

  • template string or element for element swiped out
  • opts optional options
  • opts.ease a ease function or string for reset&expand animation, default out-quad
  • opts.duration duration for reset in millisecon, default 350

.bind(parentNode, selector)

Bind swipe event to parentNode with delegated selector

.bind(ListRender, selector)

Bind to listRender instance, which enables automate model reative-lite bind

.ignore(selector)

Ignore touchstart event from target that within element matches selector

.render(fn)

Set a optional render function for swiped out element , fn is passed with related swiped element(which matches the bind selector) and template string, fn should return an element

.delegate(type, selector, handler)

Delegate handler of type event with matched selector within swiped out element, handler is called with original event and related swiped element.

.reset()

Reset the swiped element to original stat with animation, return promise

.clear([duration], [ease])

Remove the swiped element and related holder with transition specified by duration (default 300) in millisecond and ease timing function, return promise.

.unbind()

Unbind all event listeners, and reset status synchronizely, could be active again be calling bind