mickdragger v1.1.1

mickdragger

A vanilla JavaScript library to allow for element dragging and drag threshold notification.

MickDragger helps you enable any element to be draggable and notifies you when that element has been dragged past a defined threshold. There is also a configurable activation threshold so that the element won't start moving until a defined drag distance has been detected. This will decrease the amount of accidental drags.

MickDragger also allows you to confine dragging along the horizontal/vertical axis. When the drag activation threshold has been met, the largest horizontal/vertical component will determine the drag axis. Alternatively you can limit its movement only on the vertical axis or only on the horizontal axis and of course you can also allow for full omnidirectional movement.

Getting Started

1. Fetch the plugin

   The plugin is available using the Node Package Manager(npm)

   $ npm install mickdragger --save

2. Include plugin script

   <script src="node_modules/mickdragger/src/mickdragger.js"></script>

3. Create a instance of MickDragger with DOM element

   var $dragEl = document.querySelector('.drag');
   var mickDragger = new MickDragger($dragEl);

4. Add event listener

   mickDragger.on(MickDragger.event.THRESHOLD, function(){
     // do awesome things
   });

API

new MickDragger(domElement, options)

Constructor for MickDragger instance.

Parameters:

.on(eventName, callbackFunction)

Registers for library callback notifications on MickDragger instances.

Parameters:

Options

Constants