aboutsummaryrefslogtreecommitdiffstats
path: root/library/Sortable/plugins/OnSpill/README.md
diff options
context:
space:
mode:
authorMario <mario@mariovavti.com>2021-08-03 07:12:35 +0000
committerMario <mario@mariovavti.com>2021-08-03 07:12:35 +0000
commitcddc0217724f1a7661014d50e4c940e623a0c2dc (patch)
treef24595d659adbb7d1e5d2e8e6dcd829b093887bb /library/Sortable/plugins/OnSpill/README.md
parent571bae9d1c07bb08270163a314c91c138b42e62f (diff)
downloadvolse-hubzilla-cddc0217724f1a7661014d50e4c940e623a0c2dc.tar.gz
volse-hubzilla-cddc0217724f1a7661014d50e4c940e623a0c2dc.tar.bz2
volse-hubzilla-cddc0217724f1a7661014d50e4c940e623a0c2dc.zip
Apps drag and drop feature
Diffstat (limited to 'library/Sortable/plugins/OnSpill/README.md')
-rw-r--r--library/Sortable/plugins/OnSpill/README.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/library/Sortable/plugins/OnSpill/README.md b/library/Sortable/plugins/OnSpill/README.md
new file mode 100644
index 000000000..816fd19cc
--- /dev/null
+++ b/library/Sortable/plugins/OnSpill/README.md
@@ -0,0 +1,60 @@
+# OnSpill Plugins
+This file contains two seperate plugins, RemoveOnSpill and RevertOnSpill. They can be imported individually, or the default export (an array of both plugins) can be passed to `Sortable.mount` as well.
+
+**These plugins are default plugins, and are included in the default UMD and ESM builds of Sortable**
+
+
+---
+
+
+### Mounting
+```js
+import { Sortable, OnSpill } from 'sortablejs/modular/sortable.core.esm';
+
+Sortable.mount(OnSpill);
+```
+
+
+---
+
+
+## RevertOnSpill Plugin
+This plugin, when enabled, will cause the dragged item to be reverted to it's original position if it is spilled (ie. it is dropped outside of a valid Sortable drop target)
+
+
+
+
+### Options
+
+```js
+new Sortable(el, {
+ revertOnSpill: true, // Enable plugin
+ // Called when item is spilled
+ onSpill: function(/**Event*/evt) {
+ evt.item // The spilled item
+ }
+});
+```
+
+
+---
+
+
+## RemoveOnSpill Plugin
+This plugin, when enabled, will cause the dragged item to be removed from the DOM if it is spilled (ie. it is dropped outside of a valid Sortable drop target)
+
+
+---
+
+
+### Options
+
+```js
+new Sortable(el, {
+ removeOnSpill: true, // Enable plugin
+ // Called when item is spilled
+ onSpill: function(/**Event*/evt) {
+ evt.item // The spilled item
+ }
+});
+```