@danielcobo/drag v1.0.0

drag

Add proper drag events to enable things like GUI for element creation, resizing, etc.

🧭 Table of contents

• ✨ Benefits
• 🎒 Requierments
• 🚀 Quickstart
• 📘 Documentation
• 🆘 Troubleshooting
• 🤝 Contributing
• 🧪 Testing
• ⚖️ License

✨ Benefits

• Fine-tune UI for drag events
• Live events by default, as they should be
• Single event for desktop and mobile

🎒 Requierments

To use this package you will need:

• NodeJS

🚀 Quickstart

Install

NodeJS

Install using the terminal:

npm install @danielcobo/drag

Require the module:

const drag = require('@danielcobo/drag');

Note: In case you're wondering, @danielcobo/ is just a namespace scope - an NPM feature. Scopes make it easier to name modules and improve security.

Browser

Declare it as a global variable named drag by including this script before any script you want to use it in:

<script src="https://cdn.jsdelivr.net/npm/@danielcobo/drag@1/dist/iife/drag.min.js"></script>

Or import it as an ECMAScript module:

import * as drag from 'https://cdn.jsdelivr.net/npm/@danielcobo/drag@1/dist/esm/drag.min.js';

Also, feel free to download the file if you prefer not to use jsdelivr. In that case just replace the url with the relative file path.

Example use

document.body.innerHTML = `
  <div>
    <p>Hello <span>world</span></p>
  </div>
 `;

drag.on('p');
let eventFired
document.addEventListener('dragStart', function () {
  eventFired = true;
});

const e = new Event('pointerdown', { bubbles: true });
document.querySelector('p').dispatchEvent(e);
//eventFired === true;

For details see documentation below.

📘 Documentation

.off()

Disable drag events on given element/s

Source: src/index.js:97

.on()

Enable drag events on given element/s

Source: src/index.js:87

🆘 Troubleshooting

If you run into trouble or have questions just submit an issue.

🤝 Contributing

Anyone can contribute

Contributions come in many shapes and sizes. All are welcome. You can contribute by:

• asking questions
• suggesting features
• sharing this repo with friends
• improving documentation (even fixing typos counts 😉)
• providing tutorials (if you do, please let me know, I would love to read them)
• improving tests
• contributing code (new features, performance boosts, code readability improvements..)

Rules for contributions

General guidelines:

• there are no dumb questions
• be polite and respectful to others
• do good

When coding remember:

• working > maintainability > performance
• best code is no code
• be descriptive when naming
• keep it DRY
• do test

Contribution licence: All contributions are considered to be under same license as this repository.

🧪 Testing

Testing suite: 🃏 Jest | Test command: npm test

Mutation testing suite: 👽 Stryker Mutator | Mutation test command: npm run mutation

If you intend to develop further or contribute code, then please ensure to write and use testing. Strive for 100% code coverage and high mutation scores. Mutation score 100 is great, but it's not always neccessary (if there are valid reasons).

⚖️ License

MIT License