tapspace/lib/components/Item/slidable.js

A zoomable user interface lib for web apps

const Slide = require('../../interaction/Slide')

module.exports = function (options) {
  // @Item:slidable(options)
  // @Item:slideable
  //
  // A slidable component can be moved along a straight line.
  //
  // Parameters:
  //   options
  //     optional, various types:
  //       a boolean, set false to disable the slide ability.
  //       an object with properties:
  //         direction
  //           a Direction or Vector. Specifies a line along which
  //           .. the item can be slid.
  //
  // Return
  //   this, for chaining
  //

  // False to unbind
  if (options === false) {
    this.removeInteraction('slide')
    return this
  }

  // Cancel contradicting interactions
  this.removeInteraction('pinch')

  // Begin slide interaction
  const slide = new Slide(this, this, options)
  this.addInteraction('slide', slide)

  return this
}