collapsible.js: Add support for <details>

This commit is contained in:
Johannes Meyer 2022-04-29 15:42:32 +02:00
parent e8cae1f28a
commit 222a6a8e0f
2 changed files with 107 additions and 21 deletions

View File

@ -335,7 +335,9 @@ a:hover > .icon-cancel {
} }
.collapsible.can-collapse:not(.collapsed) + .collapsible-control button, .collapsible.can-collapse:not(.collapsed) + .collapsible-control button,
.collapsible.can-collapse:not(.collapsed) > .collapsible-control { .collapsible.can-collapse:not(.collapsed) > .collapsible-control,
details.collapsible[open] + .collapsible-control button,
details.collapsible[open] > .collapsible-control {
i.expand-icon { i.expand-icon {
display: none; display: none;
} }
@ -346,7 +348,9 @@ a:hover > .icon-cancel {
} }
.collapsible.collapsed + .collapsible-control button, .collapsible.collapsed + .collapsible-control button,
.collapsible.collapsed > .collapsible-control { .collapsible.collapsed > .collapsible-control,
details.collapsible:not([open]) + .collapsible-control button,
details.collapsible:not([open]) > .collapsible-control {
i.expand-icon { i.expand-icon {
display: inline; display: inline;
} }
@ -358,11 +362,11 @@ a:hover > .icon-cancel {
// Collapsibles // Collapsibles
.collapsible.collapsed { .collapsible.collapsed:not(details) {
overflow: hidden; overflow: hidden;
} }
.collapsible.collapsed:not([data-toggle-element]) { .collapsible.collapsed:not([data-toggle-element], details) {
position: relative; position: relative;
&:after { &:after {

View File

@ -39,13 +39,19 @@
* @param event Event The `onRender` event triggered by the rendered container * @param event Event The `onRender` event triggered by the rendered container
*/ */
Collapsible.prototype.onRendered = function(event) { Collapsible.prototype.onRendered = function(event) {
var _this = event.data.self; var _this = event.data.self,
var toCollapse = []; toCollapse = [],
toExpand = [];
$.each(event.target.querySelectorAll('.collapsible:not(.can-collapse)'), function (_, collapsible) { $.each(event.target.querySelectorAll('.collapsible:not(.can-collapse)'), function (_, collapsible) {
// Assumes that any newly rendered elements are expanded // Assumes that any newly rendered elements are expanded
if (_this.canCollapse(collapsible) && _this.setupCollapsible(collapsible)) { if (_this.canCollapse(collapsible)) {
if (_this.setupCollapsible(collapsible)) {
toCollapse.push([collapsible, _this.calculateCollapsedHeight(collapsible)]); toCollapse.push([collapsible, _this.calculateCollapsedHeight(collapsible)]);
} else if (_this.isDetails(collapsible)) {
// Except if it's a <details> element, which may not be expanded by default
toExpand.push(collapsible);
}
} }
}); });
@ -55,6 +61,10 @@
for (var i = 0; i < toCollapse.length; i++) { for (var i = 0; i < toCollapse.length; i++) {
_this.collapse(toCollapse[i][0], toCollapse[i][1]); _this.collapse(toCollapse[i][0], toCollapse[i][1]);
} }
for (i = 0; i < toExpand.length; i++) {
_this.expand(toExpand[i]);
}
}; };
/** /**
@ -70,7 +80,7 @@
if (collapsible.matches('.can-collapse')) { if (collapsible.matches('.can-collapse')) {
if (! _this.canCollapse(collapsible)) { if (! _this.canCollapse(collapsible)) {
var toggleSelector = collapsible.dataset.toggleElement; var toggleSelector = collapsible.dataset.toggleElement;
if (! toggleSelector) { if (! toggleSelector && ! this.isDetails(collapsible)) {
$(collapsible).next('.collapsible-control').remove(); $(collapsible).next('.collapsible-control').remove();
} }
@ -99,8 +109,12 @@
var collapsible = $(collapsiblePath)[0]; var collapsible = $(collapsiblePath)[0];
if (collapsible && collapsible.matches('.can-collapse')) { if (collapsible && collapsible.matches('.can-collapse')) {
if ('stateCollapses' in collapsible.dataset) {
this.collapse(collapsible, this.calculateCollapsedHeight(collapsible));
} else {
this.expand(collapsible); this.expand(collapsible);
} }
}
}; };
/** /**
@ -112,8 +126,12 @@
var collapsible = $(collapsiblePath)[0]; var collapsible = $(collapsiblePath)[0];
if (collapsible && this.canCollapse(collapsible)) { if (collapsible && this.canCollapse(collapsible)) {
if ('stateCollapses' in collapsible.dataset) {
this.expand(collapsible);
} else {
this.collapse(collapsible, this.calculateCollapsedHeight(collapsible)); this.collapse(collapsible, this.calculateCollapsedHeight(collapsible));
} }
}
}; };
/** /**
@ -133,6 +151,8 @@
if (! collapsible) { if (! collapsible) {
_this.icinga.logger.error( _this.icinga.logger.error(
'[Collapsible] Collapsible control has no associated .collapsible: ', $target[0]); '[Collapsible] Collapsible control has no associated .collapsible: ', $target[0]);
return;
} else if (typeof collapsible.dataset.noPersistence !== 'undefined') { } else if (typeof collapsible.dataset.noPersistence !== 'undefined') {
if (collapsible.matches('.collapsed')) { if (collapsible.matches('.collapsed')) {
_this.expand(collapsible); _this.expand(collapsible);
@ -140,15 +160,32 @@
_this.collapse(collapsible, _this.calculateCollapsedHeight(collapsible)); _this.collapse(collapsible, _this.calculateCollapsedHeight(collapsible));
} }
} else { } else {
var collapsiblePath = _this.icinga.utils.getCSSPath(collapsible); var collapsiblePath = _this.icinga.utils.getCSSPath(collapsible),
stateCollapses = 'stateCollapses' in collapsible.dataset;
if (_this.state.has(collapsiblePath)) { if (_this.state.has(collapsiblePath)) {
_this.state.delete(collapsiblePath); _this.state.delete(collapsiblePath);
if (stateCollapses) {
_this.expand(collapsible);
} else {
_this.collapse(collapsible, _this.calculateCollapsedHeight(collapsible)); _this.collapse(collapsible, _this.calculateCollapsedHeight(collapsible));
}
} else { } else {
_this.state.set(collapsiblePath); _this.state.set(collapsiblePath);
if (stateCollapses) {
_this.collapse(collapsible, _this.calculateCollapsedHeight(collapsible));
} else {
_this.expand(collapsible); _this.expand(collapsible);
} }
} }
}
if (_this.isDetails(collapsible)) {
// The browser handles these clicks as well, and would toggle the state again
event.preventDefault();
}
}; };
/** /**
@ -159,9 +196,18 @@
* @returns {boolean} Whether it needs to collapse or not * @returns {boolean} Whether it needs to collapse or not
*/ */
Collapsible.prototype.setupCollapsible = function (collapsible) { Collapsible.prototype.setupCollapsible = function (collapsible) {
var toggleSelector = collapsible.dataset.toggleElement; if (this.isDetails(collapsible)) {
if (!! toggleSelector) { var summary = collapsible.querySelector(':scope > summary');
var toggle = $(collapsible).children(toggleSelector)[0]; if (! summary.classList.contains('collapsible-control')) {
summary.classList.add('collapsible-control');
}
if (collapsible.open) {
collapsible.dataset.stateCollapses = '';
}
} else if (!! collapsible.dataset.toggleElement) {
var toggleSelector = collapsible.dataset.toggleElement,
toggle = $(collapsible).children(toggleSelector)[0];
if (! toggle && $(collapsible.nextSibling).is(toggleSelector)) { if (! toggle && $(collapsible.nextSibling).is(toggleSelector)) {
toggle = collapsible.nextSibling; toggle = collapsible.nextSibling;
} }
@ -184,8 +230,15 @@
collapsible.classList.add('can-collapse'); collapsible.classList.add('can-collapse');
return typeof collapsible.dataset.noPersistence !== 'undefined' if ('noPersistence' in collapsible.dataset) {
|| ! this.state.has(this.icinga.utils.getCSSPath(collapsible)); return ! ('stateCollapses' in collapsible.dataset);
}
if ('stateCollapses' in collapsible.dataset) {
return this.state.has(this.icinga.utils.getCSSPath(collapsible));
} else {
return ! this.state.has(this.icinga.utils.getCSSPath(collapsible));
}
}; };
/** /**
@ -217,6 +270,10 @@
* @returns {boolean} * @returns {boolean}
*/ */
Collapsible.prototype.canCollapse = function(collapsible) { Collapsible.prototype.canCollapse = function(collapsible) {
if (this.isDetails(collapsible)) {
return collapsible.querySelector(':scope > summary') !== null;
}
var rowSelector = this.getRowSelector(collapsible); var rowSelector = this.getRowSelector(collapsible);
if (!! rowSelector) { if (!! rowSelector) {
var visibleRows = Number(collapsible.dataset.visibleRows); var visibleRows = Number(collapsible.dataset.visibleRows);
@ -247,6 +304,10 @@
Collapsible.prototype.calculateCollapsedHeight = function (collapsible) { Collapsible.prototype.calculateCollapsedHeight = function (collapsible) {
var height; var height;
if (this.isDetails(collapsible)) {
return -1;
}
var rowSelector = this.getRowSelector(collapsible); var rowSelector = this.getRowSelector(collapsible);
if (!! rowSelector) { if (!! rowSelector) {
height = collapsible.scrollHeight; height = collapsible.scrollHeight;
@ -303,7 +364,12 @@
* @param toHeight {int} The height in pixels to collapse to * @param toHeight {int} The height in pixels to collapse to
*/ */
Collapsible.prototype.collapse = function(collapsible, toHeight) { Collapsible.prototype.collapse = function(collapsible, toHeight) {
if (this.isDetails(collapsible)) {
collapsible.open = false;
} else {
collapsible.style.cssText = 'display: block; height: ' + toHeight + 'px; padding-bottom: 0'; collapsible.style.cssText = 'display: block; height: ' + toHeight + 'px; padding-bottom: 0';
}
collapsible.classList.add('collapsed'); collapsible.classList.add('collapsed');
}; };
@ -314,7 +380,23 @@
*/ */
Collapsible.prototype.expand = function(collapsible) { Collapsible.prototype.expand = function(collapsible) {
collapsible.classList.remove('collapsed'); collapsible.classList.remove('collapsed');
if (this.isDetails(collapsible)) {
collapsible.open = true;
} else {
collapsible.style.cssText = ''; collapsible.style.cssText = '';
}
};
/**
* Get whether the given collapsible is a <details> element
*
* @param collapsible
*
* @return {Boolean}
*/
Collapsible.prototype.isDetails = function (collapsible) {
return collapsible.tagName === 'DETAILS';
}; };
Icinga.Behaviors.Collapsible = Collapsible; Icinga.Behaviors.Collapsible = Collapsible;