npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

metal-drag-drop

v3.3.1

Published

Metal's drag and drop component.

Downloads

2,084

Readme

metal-drag-drop

Build Status

Metal's drag and drop component.

Use

Simple use case

This instance of Drag will allow any element with the box class to be dragged, but only when clicking a child element that has the handle class.

<div class="box">
  <div class="handle" tabindex="0"></div>
</div>
<div class="box">
  <div class="handle" tabindex="0"></div>
</div>
import {Drag} from 'metal-drag-drop';

new Drag({
  handles: '.handle',
  sources: '.box'
});

drag

Locking axis

The drag elements can be locked to a specified axis, the following example would only allow the elements to move along the y axis.

new Drag({
  axis: 'y',
  sources: '.box'
});

The same can be done for the x axis.

new Drag({
  axis: 'x',
  sources: '.box'
});

Constraining

By setting the constrain element, the drag elements will not be allowed to leave the defined element's region.

new Drag({
  constrain: '#container', // Parent element of `.box` elements
  sources: '.box'
});

Steps

The steps config property defines how much the drag elements will move by at a time.

new Drag({
  sources: '.box',
  steps: {
    x: 50,
    y: 150
  }
});

steps

Cloning drag element

Rather than dragging the element itself, a clone can be created in it's place.

new Drag({
  dragPlaceholder: Drag.Placeholder.CLONE,
  sources: '.box'
});

clone

Drag Drop

The DragDrop class extends from the Drag class, but adds additional config properties for defining target drop areas and behavior.

<div class="box"></div>
<div class="target"></div>
import {DragDrop} from 'metal-drag-drop';

const dragDrop = new DragDrop({
  sources: '.box',
  targets: '.target'
});

dragDrop.on(DragDrop.Events.END, function(data, event) {
  event.preventDefault();

  console.log('Hit target:', data.target); // <div class="target"></div>
});

Events

The Drag class emits three events that can be listened to.

const drag = new Drag({
  sources: '.box'
});

drag.on(Drag.Events.DRAG, function(event) {
  // Logic
});

drag.on(Drag.Events.END, function(event) {
  // Logic
});

drag.on(Drag.Events.START, function(event) {
  // Logic
});

The DragDrop class adds two additional events related to drop targets.

const dragDrop = new DragDrop({
  sources: '.box',
  targets: '.target'
});

dragDrop.on(DragDrop.Events.TARGET_ENTER, function(event) {
  // Logic
});

dragDrop.on(DragDrop.Events.TARGET_LEAVE, function(event) {
  // Logic
});

More examples

For more examples, check out the demos.

Setup

  1. Install a recent release of NodeJS if you don't have it yet.

  2. Install local dependencies:

npm install
  1. Run the tests:
npm test
  1. Build the code:
npm run build
  1. Open the demo at demos/index.html on your browser.

Contributing

Check out the contributing guidelines for more information.