<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="X-UA-Compatible" content="ie=edge"> <title>vue-dragscroll</title> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" integrity="sha384-/Y6pD6FV/Vv2HJnA6t+vslU6fwYXjCFtcEpHbNJ0lyAFsXTsjBbfaDjzALeQsN6M" crossorigin="anonymous"> <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet"> <style> .big-box { width: 300px; height: 300px; overflow: scroll; } .my-draggable-div-parent { width: 300px; height: 500px; } .my-draggable-div { margin: 25px; width: 250px; height: 250px; overflow: scroll; } .oh { overflow: hidden; } .small-box { width: 50px; height: 50px; display: inline-block; } p.p { margin: 25px; white-space: nowrap; } .grab-bing { cursor : -webkit-grab; cursor : -moz-grab; cursor : -o-grab; cursor : grab; } .grab-bing:active { cursor : -webkit-grabbing; cursor : -moz-grabbing; cursor : -o-grabbing; cursor : grabbing; } </style> </head> <body> <div id="app"> <div class="container"> <div class="row mt-4 justify-content-center"> <h1 class="display-4">vue-dragscroll</h1> </div> <div class="row mt-4"> <div class="col-12 col-md-6"> <a href="https://github.com/donmbelembe/vue-dragscroll" target="_blank" class="text-warning"> <i class="fa fa-github"></i> View on github </a> <br> <a href="https://unpkg.com/vue-dragscroll" target="_blank" class="text-danger"> <i class="fa fa-bookmark"></i> CDN : https://unpkg.com/vue-dragscroll </a> <br> <a href="https://www.npmjs.com/package/vue-dragscroll" target="_blank" class="text-info"> <i class="fa fa-bookmark"></i> NPM : https://www.npmjs.com/package/vue-dragscroll </a> </div> </div> <div class="row my-4 py-4 border"> <div class="col-12 text-center mb-3"> <h4 class="text-uppercase">Install</h4> </div> <div class="col-12 col-md-6"> <div class="col-12 mb-3"> <h5 class="text-uppercase">Via npm</h5> </div> <div> <p><strong>Command</strong></p> <pre class="prettyprint"> <code>npm install vue-dragscroll</code> </pre> </div> <div class="mt-2"> <p><strong>Install globally (main.js)</strong></p> <pre class="prettyprint"> import Vue from 'vue' import VueDragscroll from 'vue-dragscroll' Vue.use(VueDragscroll) </pre> </div> <div class="mt-2"> <p><strong>(Or) Install for a single component</strong></p> <pre class="prettyprint"> import { dragscroll } from 'vue-dragscroll' export default { directives: { dragscroll } } </pre> </div> </div> <div class="col-12 col-md-6"> <div class="col-12 mb-3"> <h5 class="text-uppercase">Via cdn</h5> </div> <div> <p><strong>Tag</strong></p> <pre class="prettyprint lang-html"> <code><script src="https://unpkg.com/vue-dragscroll"></script></code> </pre> </div> </div> </div> <div class="row mb-4"> <div class="col-12 text-center"> <h4 class="text-uppercase">Usage</h4> </div> </div> <div class="row"> <div class="col-12 col-sm-6 mt-3"> <p><strong>Just add the directive to the parent element</strong></p> <div v-if="drag"> <pre class="prettyprint lang-html"> <code> <div v-dragscroll> ... <div> <!-- For more control --> <div v-dragscroll="true"> ... <div> </code> </pre> </div> <div v-else="drag"> <pre class="prettyprint lang-html"> <code><div v-dragscroll="false"> ... <div></code> </pre> </div> <div> <input type="checkbox" v-model="drag"> Enable drag </div> <div> <input type="checkbox" v-model="oh"> (overflow: hidden) </div> </div> <div class="col-12 col-sm-6 mt-3 d-flex justify-content-center"> <div class="big-box grab-bing border border-danger bg-secondary" :class="{oh: oh}" v-dragscroll="drag" v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <img src="./assets/image.jpg" alt=""> </div> </div> <div class="col-12 col-md-6 mt-3 d-flex justify-content-center"> <div class="big-box grab-bing border border-danger bg-secondary" :class="{oh: oh}" v-dragscroll="drag" v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorem ipsum dolor sit</p> <p class="p">Lorem ipsum</p> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam</p> <p class="p">ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Unde impedit laboriosam deserunt ipsa?</p> <input type="text"> <p class="p">Lorem ipsum dolor sit ameturutem. <button class="btn btn-default" @click="testClick()">Test click</button> Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Loremlaboriosam deserunt ipsa?</p> <p class="p">deserunt ipsa?</p> <p class="p">Lorepedit laboriosam deserunt ipsa?</p> <p class="p">Loremeturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorepedit laboriosam deserunt ipsa?</p> <p class="p">Lore ameturutem. Unde impedit laboriosam deserunt ipsa?</p> </div> </div> </div> <hr> <div class="row"> <div class="col-12 col-sm-6 mt-3"> <p><strong>Directive with <span class="text-danger">:nochilddrag</span> argument</strong></p> <pre class="prettyprint lang-html"> <div v-dragscroll:nochilddrag> ... <div> </pre> <i>This will only enable drag-scrolling for an element itself, but not for its children.</i> <a href="http://asvd.github.io/jailed/demos/web/process/" target="_blank">Check this example</a> <br> <i><strong>On below examples, you can scroll on when holding mouse outside of child element</strong></i> <br> <i>(Outside of the text or red box)</i> </div> <div class="col-12 col-sm-6 mt-3 d-flex justify-content-center"> <div class="big-box oh grab-bing border border-danger bg-secondary" v-dragscroll:nochilddrag v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorem ipsum dolor sit</p> <p class="p">Lorem ipsum</p> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam</p> <p class="p">deserunt ipsa?</p> <p class="p">Lorem ipsum doipsa?</p> <p class="p">Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">deserunt ipsa?</p> <p class="p">laboriosam deserunt ipsa?</p> <p class="p">Loremlaboriosam deserunt ipsa?</p> <p class="p">deserunt ipsa?</p> <p class="p">Lorepedit laboriosam deserunt ipsa?</p> <p class="p">Loremeturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorepedit laboriosam deserunt ipsa?</p> <p class="p">Lore ameturutem. Unde impedit laboriosam deserunt ipsa?</p> </div> </div> <div class="col-12 col-sm-6 mt-3 d-flex justify-content-center"> <div class="big-box oh grab-bing border border-danger bg-secondary" v-dragscroll:nochilddrag v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> </div> </div> </div> <hr> <div class="row"> <div class="col-12 col-sm-6 mt-3"> <p><strong>Horizontally only or Vertically only</strong></p> <div> <pre class="prettyprint lang-html"> <div v-dragscroll.x> ... <div> <!-- Or --> <div v-dragscroll.y="true"> ... <div> </pre> </div> </div> <div class="col-12 col-sm-6 mt-3 d-flex justify-content-center"> <div class="big-box grab-bing border border-danger bg-secondary" v-dragscroll.x="drag" v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <img src="./assets/image.jpg" alt=""> </div> </div> <div class="col-12 col-sm-6 mt-3 d-flex justify-content-center"> <div class="big-box grab-bing border border-danger bg-secondary" v-dragscroll.y="drag" v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorem ipsum dolor sit</p> <p class="p">Lorem ipsum</p> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam</p> <p class="p">ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorem ipsum dolor sit ameturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Loremlaboriosam deserunt ipsa?</p> <p class="p">deserunt ipsa?</p> <p class="p">Lorepedit laboriosam deserunt ipsa?</p> <p class="p">Loremeturutem. Unde impedit laboriosam deserunt ipsa?</p> <p class="p">Lorepedit laboriosam deserunt ipsa?</p> <p class="p">Lore ameturutem. Unde impedit laboriosam deserunt ipsa?</p> </div> </div> </div> <hr> <div class="row"> <div class="col-12 col-sm-6 mt-3"> <p><strong>Select which elements can be dragged</strong></p> <div> <pre class="prettyprint lang-html"> <code> <div v-dragscroll> <div class="child">...<div><!-- can be dragged --> <div class="child" data-no-dragscroll>...<div><!-- can't be dragged --> <div> <div v-dragscroll:nochilddrag> <div class="child" data-dragscroll>...<div><!-- can be dragged --> <div class="child">...<div><!-- can't be dragged --> <div> </code> </pre> <p class="font-italic"> When using the directive all elements inside will be draggable. You can use <strong>data-no-dragscroll</strong> to tell which elements <strong>can't</strong> be dragged. </p> <p class="font-italic"> In the same way, if you are using <strong>nochilddrag</strong> you can use <strong>data-dragscroll</strong> to tell which element <strong>can</strong> be dragged. </p> </div> </div> <div class="col-12 col-sm-6 mt-3"> <div class="big-box grab-bing border border-danger bg-secondary mx-auto mb-3" v-dragscroll v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <div class="bg-dark" style="width: 500px; height: 200px;" data-no-dragscroll> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> </div> </div> <div class="big-box grab-bing border border-danger bg-secondary mx-auto" v-dragscroll:nochilddrag v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <div class="bg-dark" style="width: 500px; height: 200px;" data-dragscroll> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> </div> </div> </div> </div> <hr> <div class="row"> <div class="col-12 col-sm-6 mt-3"> <p><strong>firstchilddrag (DEPRECATED, prefer data attributes)</strong></p> <div> <pre class="prettyprint lang-html"> <code> <div v-dragscroll:firstchilddrag> <div class="subContainer">...<div> <div> </code> </pre> <p class="font-italic"> When using <strong>nochilddrag</strong>, all elements inside the parent element will not be draggable, but in some case you may need to have only one subchild and multile grandchild and only the grandchild should not be dragable. </p> </div> </div> <div class="col-12 col-sm-6 mt-3 d-flex justify-content-center"> <div class="big-box grab-bing border border-danger bg-secondary" v-dragscroll:firstchilddrag v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <div class="bg-dark" style="width: 500px; height: 200px;"> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> <div class="small-box bg-danger m-5"></div> </div> </div> </div> </div> <hr> <div class="row"> <div class="col-12 col-sm-6 mt-3"> <p><strong>Pass scroll when max reached</strong></p> <div> <pre class="prettyprint lang-html"> <code> <div v-dragscroll.pass> <div class="subContainer">...<div> <div> </code> </pre> <i>It would be helpful if scroll were passed to the window object, when max scroll position were reached.</i> </div> </div> <div class="col-12 col-sm-6 mt-3 d-flex justify-content-center"> <div class="big-box grab-bing border border-danger bg-secondary" v-dragscroll.pass v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <img src="./assets/image.jpg" alt=""> </div> </div> </div> <hr> <div class="row"> <div class="col-12 col-sm-6 mt-3"> <p><strong>Apply dragscroll to a child dom element</strong></p> <div> <pre class="prettyprint lang-html"> <code> <!-- Vue --> <mycomponent v-dragscroll="{ target: '.my-draggable-div' }"> </mycomponent> <!-- HTML generated --> <div class="mycomponent"> <div class="my-draggable-div"></div> </div> </code> </pre> <p class="font-italic"> Use case: when you want to apply the directive to a child dom element you have no control over (because generated by vuejs). </p> <p class="font-italic"> You can use <strong>v-dragscroll="{ target: 'element' }"</strong> to tell to which child the directive will be applied. This <strong>element</strong> string must be a valid CSS selector string (used by querySelector). Examples: <strong>'#element_id'</strong>, <strong>'.element_class'</strong>, <strong>'section'</strong>. </p> <p class="font-italic"> To control if drag should be enabled/disabled you can add the <strong>active</strong> parameter to the directive. </p> <pre class="prettyprint lang-html"> <code> <!-- Vue --> <mycomponent v-dragscroll="{ target: '.my-draggable-div', active: true }"> </mycomponent> </code> </pre> </div> </div> <div class="col-12 col-sm-6 mt-3 d-flex justify-content-center" > <div class="border border-danger bg-secondary my-draggable-div-parent" v-dragscroll="{ target: '.my-draggable-div', active: true }" v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <div class="grab-bing my-draggable-div"> <img src="./assets/image.jpg" alt=""> </div> </div> </div> </div> <hr> <div class="row"> <div class="col-12 col-sm-6 mt-3"> <p> <strong>Ignore specific mouse buttons</strong> </p> <p>You can use the following modifiers:</p> <ul> <li><strong>noleft</strong></li> <li><strong>nomiddle</strong></li> <li><strong>noright</strong></li> <li><strong>noback</strong></li> <li><strong>noforward</strong></li> </ul> <div> <pre class="prettyprint lang-html"> <code> <div v-dragscroll.noleft="true"> <div class="subContainer">...<div> <div> </code> </pre> <i>This will not scroll using left click. (try with right click)</i> </div> </div> <div class="col-12 col-sm-6 mt-3 d-flex justify-content-center"> <div class="big-box grab-bing border border-danger bg-secondary" v-dragscroll.noleft="true" v-on:dragscrollstart="eventTrigged('dragscrollstart')" v-on:dragscrollend="eventTrigged('dragscrollend')" v-on:dragscrollmove="eventTrigged('dragscrollmove', $event)"> <img src="./assets/image.jpg" alt=""> </div> </div> </div> <hr> <div class="row"> <div class="col-12 mt-5 mb-3"> <strong>EVENTS</strong> <br> <p>The directive provides 3 events.</p> <ul> <li><strong>dragscrollstart</strong></li> <li><strong>dragscrollmove</strong></li> <li><strong>dragscrollend</strong></li> </ul> <p>The dragscrollmove event includes a data object with the following format: </p> <pre class="prettyprint"> { detail: { deltaX: 0, // if using the x modifier, or no axis modifier deltaY: 0, // if using the y modifier, or no axis modifier }, } </pre> <p><strong>example:</strong></p> <pre class="prettyprint lang-html"> <div v-dragscroll v-on:dragscrollstart="doSomething" v-on:dragscrollmove="doSomething(params, $event.detail.deltaX)" v-on:dragscrollend="doSomething"> ... </div> </pre> </div> </div> <div class="row my-5"> <div> Credit: <a href="http://asvd.github.io/dragscroll/" target="_blank">Javascript dragscroll library</a> <br> Follow Me: <a href="https://twitter.com/don_jon243" target="_blank">@don_jon243</a> <br> Photo by <strong>Toa Heftiba</strong> on <a href="https://unsplash.com/">Unsplash</a> </div> </div> </div> </div> <script src="https://unpkg.com/vue"></script> <script src="./dist/vue-dragscroll.js"></script> <!-- <script src="https://unpkg.com/vue-dragscroll"></script> --> <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script> <script> new Vue({ el: '#app', data: { drag: true, oh: false }, methods: { eventTrigged: function(name, e) { console.log(name); if (name == 'dragscrollmove') { console.log(e.detail) } }, testClick: function() { alert('Clicked') } } }) </script> </body> </html>