Skip to content

ZengineChris/dragula-constrain

 
 

Repository files navigation

dragula-constrain

Latest Version on NPM Software License

Constrain mirrors to their containers with Dragula, similar to jQuery UI draggable's contain.

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Postcardware

You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

The best postcards will get published on the open source page on our website.

Install

You can install the package via npm:

$ npm install dragula-constrain

Browser support

dragula-constrain supports at least all modern browsers, starting from IE10.

Usage

import dragula from 'dragula';
import constrain from 'dragula-constrain';

// Set up `myContainer` and `options`...

const dragula = dragula(myContainer, options);

constrain(dragula);

That's it! The mirror shouldn't spill out of the container anymore while dragging.

This package assumes that the mirror has a fixed position, and the container is non-fixed. It currently only supports constraining mirrors to Dragula's first container (custom container support might get implemented in the future).

Please see CHANGELOG for more information what has changed recently.

Testing

$ npm run test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please contact Sebastian De Deyne instead of using the issue tracker.

Credits

About Spatie

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

License

The MIT License (MIT). Please see License File for more information.

About

Constrain mirrors to their containers with Dragula

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%