scroll-list.mustache revision 5b139d58acfcae4b1bcab5a895706abafc2a87a0
0N/A<div class="intro">
3909N/A<p>This example shows how to make a sortable list using Custom Event Bubbling and Node scrolling.</p>
0N/A</div>
0N/A
0N/A<div class="example">
0N/A {{>scroll-list-source}}
2362N/A</div>
0N/A<h3>Setting up the lists</h3>
2362N/A<p>First we will make a list that we want to make sortable.</p>
0N/A
0N/A```
0N/A {{>scroll-list-source-html}}
0N/A```
0N/A
0N/A<h3>Make it scrollable</h3>
0N/A<p>Now add some CSS to make it scrollable.</p>
0N/A
0N/A```
0N/A#play ul {
0N/A /* Snipped */
2362N/A overflow: auto;
2362N/A}
2362N/A```
0N/A
0N/A<h3>Setting up the YUI Instance</h3>
0N/A<p>Now we need to create our YUI instance and tell it to load the `dd-constrain`,
0N/A`dd-proxy`, `dd-drop` and `dd-scroll`, modules.</p>
0N/A
0N/A```
0N/AYUI().use('dd-constrain', 'dd-proxy', 'dd-drop', 'dd-scroll', function(Y) {
0N/A```
0N/A
0N/A<h3>Making the Nodes Drag Instances and Drop Targets</h3>
0N/A<p>Now we have our YUI instance ready, we can make the list items draggable. We will do this using `Y.Node.all`</p>
0N/A<p>We will be passing the selector string `#play ul li` to `Y.all` to have it return us a `NodeList` of the li's in our 2 lists.
0N/AUsing this selector syntax we will be able to add new list markup to the `#play` div and not have to change our code.</p>
0N/A<p>Then we will walk that `NodeList` and create our draggable Nodes.</p>
0N/A<p>Also note that we are using the Node's `parentNode` as our node in the DDNodeScroll plugin.</p>
0N/A
0N/A```
0N/A//Get the list of li's in the lists and make them draggable
0N/Avar lis = Y.all('#play ul li');
0N/Alis.each(function(v, k) {
0N/A var dd = new Y.DD.Drag({
0N/A node: v,
0N/A //Make it Drop target and pass this config to the Drop constructor
0N/A target: {
0N/A padding: '0 0 0 20'
0N/A }
0N/A }).plug(Y.Plugin.DDProxy, {
0N/A //Don't move the node at the end of the drag
0N/A moveOnEnd: false
0N/A }).plug(Y.Plugin.DDConstrained, {
0N/A //Keep it inside the #play node
0N/A constrain2node: '#play'
0N/A }).plug(Y.Plugin.DDNodeScroll, {
0N/A node: v.get('parentNode')
0N/A });
0N/A});
0N/A```
0N/A
0N/A<h3>Making the List Drop Targets too</h3>
0N/A<p>We need to make each UL node a Drop Target so we can catch drops on the empty space of the list.
0N/AUsing this selector syntax we will be able to add new list markup to the `#play` div and not have to change our code.</p>
0N/A
0N/A```
0N/A//Create simple targets for the 2 lists.
var uls = Y.all('#play ul');
uls.each(function(v, k) {
var tar = new Y.DD.Drop({
node: v
});
});
```
<h3>Using Event Bubbling</h3>
<p>By default, all Drag and Drop instances bubble their events up to the DragDropMgr. In this example we are assuming that there are no other Drag operations in this YUI Instance.</p>
<h3>Start Drag Event</h3>
<p>The first thing we will do is handle the `drag:start` event. In this event, we will setup some styles to apply to the `node` and `dragNode` of the current Drag instance.</p>
<p>We will also be copying the `innerHTML` of the `node` and copying that to the `innerHTML` of the `dragNode`.</p>
<p><em>It should be noted, that
doing this will also copy any `id`'s of the nodes inside the `node`. So if you are using this on something that is `id` based, you may need to remove the `id`'s
of the nodes inside the `node` that is being dragged.
</em></p>
```
Y.DD.DDM.on('drag:start', function(e) {
//Get our drag object
var drag = e.target;
//Set some styles here
drag.get('node').setStyle('opacity', '.25');
drag.get('dragNode').set('innerHTML', drag.get('node').get('innerHTML'));
drag.get('dragNode').setStyles({
opacity: '.5',
borderColor: drag.get('node').getStyle('borderColor'),
backgroundColor: drag.get('node').getStyle('backgroundColor')
});
});
```
<h3>End Drag Event</h3>
<p>In this event, we will reset some of the styles set in the `drag:start` event.</p>
```
Y.DD.DDM.on('drag:end', function(e) {
var drag = e.target;
//Put out styles back
drag.get('node').setStyles({
visibility: '',
opacity: '1'
});
});
```
<h3>Drag Event</h3>
<p>In this event, we will track the up/down movement for later use.</p>
```
Y.DD.DDM.on('drag:drag', function(e) {
//Get the last y point
var y = e.target.lastXY[1];
//is it greater than the lastY var?
if (y &lt; lastY) {
//We are going up
goingUp = true;
} else {
//We are going down.
goingUp = false;
}
//Cache for next check
lastY = y;
//Added to support scrolling
Y.DD.DDM.syncActiveShims(true);
});
```
<h3>Over Drop Event</h3>
<p>In this event, we know which target we are over, so we add the Drag node to the list either above or below the current Drop Target.</p>
<p>Here we also change the node which needs to be scrolled. Since we are changing lists, we need to tell the scrolling plugin instance that it needs to check against another node.</p>
```
Y.DD.DDM.on('drop:over', function(e) {
//Get a reference to out drag and drop nodes
var drag = e.drag.get('node'),
drop = e.drop.get('node');
//Are we dropping on a li node?
if (drop.get('tagName').toLowerCase() === 'li') {
//Are we not going up?
if (!goingUp) {
drop = drop.get('nextSibling');
}
//Add the node to this list
e.drop.get('node').get('parentNode').insertBefore(drag, drop);
//Set the new parentScroll on the nodescroll plugin
e.drag.nodescroll.set('parentScroll', e.drop.get('node').get('parentNode'));
//Resize this node's shim, so we can drop on it later.
e.drop.sizeShim();
}
});
```
<h3>Drop Hit Event</h3>
<p>In this event, we check to see if the target that was dropped on was not an LI node. If it wasn't, then we know it was dropped on the empty space of the UL.</p>
```
Y.DD.DDM.on('drag:drophit', function(e) {
var drop = e.drop.get('node'),
drag = e.drag.get('node');
//if we are not on an li, we must have been dropped on a ul
if (drop.get('tagName').toLowerCase() !== 'li') {
if (!drop.contains(drag)) {
drop.appendChild(drag);
//Set the new parentScroll on the nodescroll plugin
e.drag.nodescroll.set('parentScroll', e.drop.get('node'));
}
}
});
```
<h3>Full Javascript Source</h3>
```
{{>scroll-list-source-js}}
```