cg-dnd v0.0.1

cg-dnd

JavaScript Accessible Drag And Drop Component by Competentum Group. Exported as a UMD module.

Contents

• Installation
• Usage
• API
  • Static properties
  • Constructor
  • Instance properties
  • Instance methods
    • on
    • disable
    • reset
    • destroy

Installation

Component can be installed with npm:

npm install --save cg-dnd

Usage

Simple dnd example:

import CgDnd from 'cg-dnd';

const settings = {
  dragItems: [{
    item: 'Text 1',
    ariaLabel: 'Text 1',
    data: 'item1'
  }],
  dropAreas: [{
    area: 'element',
    ariaLabel: 'Area 1'
  }],
  bounds: 'body',
  helper: 'original',
  handler: 'h2',
  enabled: true,
  snap: true,
  onCreate: function(data) {
    console.log('create drag', data);
  },
  onStart: function(data) {
    console.log('start drag', data);
  },
  onDrag: function(data) {
    console.log('drag', data);
  },
  onStop: function(data) {
    console.log('stop drag', data);
  }
};

const dnd = new CgDnd(settings);

API

Static properties

• EVENTS {Object} Events which dnd can emit.
  • CREATE - Emits on drag creating.
  • START - Emits on drag start.
  • DRAG - Emits on drag moving.
  • STOP - Emits on drag end.

See dnd.on method to know how to use events.

new CgDnd(settings) - constructor

• settings {Object} Set of configurable options to set on the dnd. Can have the following fields:
  • bounds {string | Element} Can be selector, element, 'parent' or 'window'. Default = 'null'.
  • helper {string} Specifies what element will be used for dragging. Can be 'original' or 'clone'. Default = 'original'.
  • handler {string} Specifies element where mousedown should occur to start dragging.
  • disabled {boolean} Drag is disabled if set to true. Default = false.
  • snap {string} If set to true items snap to drop areas. Default = false.
  • dragItems {Array} Array of drag items.
    • item {string | Element} Draggable element. Can be element or selector.
    • ariaLabel {string} Alternative text for item.
    • data {string} For checking correctness of drag.
    • className {string} Add class name to item.
  • dropAreas {Object} Array of drop areas.
    • area {string | Element} Drop area element. Can be element or selector.
    • ariaLabel {string} Alternative text for area.
    • data {string} For checking correctness of drag.
    • className {string} Add class name to area.
  • onCreate {Function} Triggers on drag creating.
  • onStart {Function} Triggers on drag start.
  • onDrag {Function} Triggers on drag moving.
  • onStop {Function} Triggers on drag end.

Instance properties

To Be Described

Instance methods

.destroy()

Remove all drag functionality.

.disable([disabled = true])

• disabled {boolean} If set to false dragging is disabled. Default = true.

Disable\enable dnd.

.reset()

Reset all items to default positions.

.on(eventName, listener)

• eventName {string} The name of the event.
• listener {Function} The callback function.

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

dnd.on(CgDnd.EVENTS.START, function (data) {
    console.log('Close Event with result', data);
});

Callback data argument is to be described.

Current class extends Node.js EventEmitter. More information about working with events you can get here.

License

Competentum Commercial License

Competentum provides its Accessible DnD component under a dual license model designed to meet the development and distribution needs of both commercial and open source projects.

For Distributors of Commercial Applications:

Organizations that develop and/or distribute commercially licensed software with Accessible DnD component and do not wish to distribute the source code for the commercially licensed software under version 3 of the GNU General Public License (the "GPL") must enter into a commercial license agreement with Competentum.

For Open Source Projects and Other Developers of Open Source Applications:

For developers of applications under the GPL that want to combine and distribute those applications with Accessible DnD component, Competentum’s Accessible DnD component open source software licensed under the GPL is the best option.

We encourage Accessible DnD component users to learn about the license by reading the license and frequently asked questions provided by the Free Software Foundation.

Accessible DnD component is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Accessible DnD component. If not, see http://www.gnu.org/licenses/.