Drag and drop table column
Before taking a look at this example, it's recommended to visit this
post to know how we can drag and drop element in a list.
The same technique can be applied to the table columns. The basic idea is
- When user starts moving a table column, we create a list of items. Each item is cloned from each column of table.
- We show the list at the same position as table, and hide the table.
- At this step, moving column around is actually moving the list item.
- When user drags an item, we determine the index of target item within the list. And swap the columns associated with the dragging and end indexes.
Let's get started with the basic markup of table:
<table id="table">
...
</table>
Basic setup
mousedown
for the all header cells, so user can click and drag the first cell in each column
mousemove
for document
: This event triggers when user moves the column around, and we will create and insert a placeholder column depending on the direction (left or right)
mouseup
for document
: This event occurs when user drags the column.
Here is the skeleton of these event handlers:
const table = document.getElementById('table');
const mouseDownHandler = function(e) {
...
document.addEventListener('mousemove', mouseMoveHandler);
document.addEventListener('mouseup', mouseUpHandler);
};
const mouseMoveHandler = function(e) {
...
};
const mouseUpHandler = function() {
...
document.removeEventListener('mousemove', mouseMoveHandler);
document.removeEventListener('mouseup', mouseUpHandler);
};
table.querySelectorAll('th').forEach(function(headerCell) {
headerCell.addEventListener('mousedown', mouseDownHandler);
});
Clone the table when user is moving a column
Since this task is performed once, we need a flag to track if it's executed:
let isDraggingStarted = false;
const mouseMoveHandler = function(e) {
if (!isDraggingStarted) {
isDraggingStarted = true;
cloneTable();
}
...
};
cloneTable
creates an element that has the same position as the table, and is shown right before the table:
let list;
const cloneTable = function () {
const rect = table.getBoundingClientRect();
list = document.createElement('div');
list.style.position = 'absolute';
list.style.left = `${rect.left}px`;
list.style.top = `${rect.top}px`;
table.parentNode.insertBefore(list, table);
table.style.visibility = 'hidden';
};
Imagine that list
consists of items which are cloned from the table columns:
const cloneTable = function() {
...
const originalCells = [].slice.call(table.querySelectorAll('tbody td'));
const originalHeaderCells = [].slice.call(table.querySelectorAll('th'));
const numColumns = originalHeaderCells.length;
originalHeaderCells.forEach(function(headerCell, headerIndex) {
const width = parseInt(window.getComputedStyle(headerCell).width);
const item = document.createElement('div');
item.classList.add('draggable');
const newTable = document.createElement('table');
const th = headerCell.cloneNode(true);
let newRow = document.createElement('tr');
newRow.appendChild(th);
newTable.appendChild(newRow);
const cells = originalCells.filter(function(c, idx) {
return (idx - headerIndex) % numColumns === 0;
});
cells.forEach(function(cell) {
const newCell = cell.cloneNode(true);
newRow = document.createElement('tr');
newRow.appendChild(newCell);
newTable.appendChild(newRow);
});
item.appendChild(newTable);
list.appendChild(item);
});
};
After this step, we have the following list
:
<div>
<div>
<table>
<tr>
...
</tr>
<tr>
...
</tr>
...
</table>
</div>
<div>
<table>
<tr>
...
</tr>
<tr>
...
</tr>
...
</table>
</div>
</div>
<table>
...
</table>
It's worth noting that when cloning cells in each item, we have to set the cell width same as the original cell.
So the item looks like the original column completely:
originalHeaderCells.forEach(function(headerCell, headerIndex) {
const width = parseInt(window.getComputedStyle(headerCell).width);
newTable.style.width = `${width}px`;
cells.forEach(function(cell) {
const newCell = cell.cloneNode(true);
newCell.style.width = `${width}px`;
...
});
});
Determine the indexes of dragging and target columns
let draggingEle;
let draggingRowIndex;
const mouseDownHandler = function (e) {
draggingColumnIndex = [].slice.call(table.querySelectorAll('th')).indexOf(e.target);
};
const mouseMoveHandler = function (e) {
if (!isDraggingStarted) {
cloneTable();
draggingEle = [].slice.call(list.children)[draggingColumnIndex];
}
};
const mouseUpHandler = function () {
const endColumnIndex = [].slice.call(list.children).indexOf(draggingEle);
};
As we have
draggingColumnIndex
and
endColumnIndex
, it's now easy to check if user drops to the left or right of table.
And we can decide how to move the target column
before or after the dragging column:
const mouseUpHandler = function () {
table.querySelectorAll('tr').forEach(function (row) {
const cells = [].slice.call(row.querySelectorAll('th, td'));
draggingColumnIndex > endColumnIndex
? cells[endColumnIndex].parentNode.insertBefore(cells[draggingColumnIndex], cells[endColumnIndex])
: cells[endColumnIndex].parentNode.insertBefore(
cells[draggingColumnIndex],
cells[endColumnIndex].nextSibling
);
});
};
Following is the final demo. Try to drag and drop the first cell of any column.
Demo
Drag and drop table column
See also