Okiba / DragEmitter

Emits drag events for all common pointers kinds (touch & mouse)

__

Installation

npm i --save @okiba/drag-emitter

Or import it directly in the browser

<script type="module" src="https://unpkg.com/@okiba/drag-emitter/index.js"></script>

Usage

import DragEmitter from '@okiba/drag-emitter'

Untranspiled code 🛑

Okiba Core packages are not transpiled, so don't forget to transpile them with your favourite bundler. For example, using Babel with Webpack, you should prevent imports from okiba to be excluded from transpilation, like follows:

{
  test: /\.js$/,
  exclude: /node_modules\/(?!(@okiba)\/).*/,
  use: {
    loader: 'babel-loader',
    options: {
      presets: ['@babel/preset-env']
    }
  }
}

constructor(el)

import {DragEmitter} from '@okiba/drag-emitter'
import {qs} from '@okiba/dom'

const dragEmitter = new DragEmitter(qs('.container'))
dragEmitter.on(
  'drag',
  ({deltaX, clientX, deltaY, clientY}) => {
    console.log(deltaX, clientX, deltaY, clientY)
  }

Arguments

+ el: Element

Element whose surface is used for drag events

destroy()

Unbinds events from the element and deletes the reference. To be called when the instance is not needed anymore for cleanup.