draggable/src/Plugins/Snappable

Snappable

Snappable simulates a "snap" by hiding the mirror and removing the 'source:dragging' class from the source. It also sets the 'source:placed' class for potential drop animations.

This plugin is not included by default, so make sure to import it before using.

Import

import { Plugins } from '@shopify/draggable';

import Snappable from '@shopify/draggable/lib/plugins/snappable';

<script src="https://cdn.jsdelivr.net/npm/@shopify/draggable@1.0.0-beta.7/lib/plugins.js"></script>

<script src="https://cdn.jsdelivr.net/npm/@shopify/draggable@1.0.0-beta.7/lib/plugins/snappable.js"></script>

Options

No options

Events

Name	Description	Cancelable	Cancelable action
snap:in	Gets fired when just before snapping in	true	Prevents snapping
snap:out	Gets fired when snapping out	true	Prevents snapping out

Example

import { Sortable, Plugins } from '@shopify/draggable';

const sortable = new Sortable(document.querySelectorAll('ul'), {
  draggable: 'li',
  plugins: [Plugins.Snappable]
});

sortable.on('snap:in', () => console.log('snap:in'));
sortable.on('snap:out', () => console.log('snap:out'));