public
Last active

Add <details> support - includes stylesheet

  • Download Gist
details.js
JavaScript
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
/**
* Note that this script is intended to be included at the *end* of the document, before </body>
*/
(function (window, document) {
if ('open' in document.createElement('details')) return;
// made global by myself to be reused elsewhere
var addEvent = (function () {
if (document.addEventListener) {
return function (el, type, fn) {
if (el && el.nodeName || el === window) {
el.addEventListener(type, fn, false);
} else if (el && el.length) {
for (var i = 0; i < el.length; i++) {
addEvent(el[i], type, fn);
}
}
};
} else {
return function (el, type, fn) {
if (el && el.nodeName || el === window) {
el.attachEvent('on' + type, function () { return fn.call(el, window.event); });
} else if (el && el.length) {
for (var i = 0; i < el.length; i++) {
addEvent(el[i], type, fn);
}
}
};
}
})();
/** details support - typically in it's own script */
// find the first /real/ node
function firstNode(source) {
var node = null;
if (source.firstChild.nodeName != "#text") {
return source.firstChild;
} else {
source = source.firstChild;
do {
source = source.nextSibling;
} while (source && source.nodeName == '#text');
return source || null;
}
}
function isSummary(el) {
var nn = el.nodeName.toUpperCase();
if (nn == 'DETAILS') {
return false;
} else if (nn == 'SUMMARY') {
return true;
} else {
return isSummary(el.parentNode);
}
}
function toggleDetails(event) {
// more sigh - need to check the clicked object
var keypress = event.type == 'keypress',
target = event.target || event.srcElement;
if (keypress || isSummary(target)) {
if (keypress) {
// if it's a keypress, make sure it was enter or space
keypress = event.which || event.keyCode;
if (keypress == 32 || keypress == 13) {
// all's good, go ahead and toggle
} else {
return;
}
}
var open = this.getAttribute('open');
if (open === null) {
this.setAttribute('open', 'open');
} else {
this.removeAttribute('open');
}
// this.className = open ? 'open' : ''; // Lame
// trigger reflow (required in IE - sometimes in Safari too)
setTimeout(function () {
document.body.className = document.body.className;
}, 13);
if (keypress) {
event.preventDefault && event.preventDefault();
return false;
}
}
}
function addStyle() {
var style = document.createElement('style'),
head = document.getElementsByTagName('head')[0],
key = style.innerText === undefined ? 'textContent' : 'innerText';
var rules = ['details{display: block;}','details > *{display: none;}','details.open > *{display: block;}','details[open] > *{display: block;}','details > summary:first-child{display: block;cursor: pointer;}','details[open]{display: block;}'];
i = rules.length;
style[key] = rules.join("\n");
head.insertBefore(style, head.firstChild);
}
var details = document.getElementsByTagName('details'),
wrapper,
i = details.length,
j,
first = null,
label = document.createElement('summary');
label.appendChild(document.createTextNode('Details'));
while (i--) {
first = firstNode(details[i]);
if (first != null && first.nodeName.toUpperCase() == 'SUMMARY') {
// we've found that there's a details label already
} else {
// first = label.cloneNode(true); // cloned nodes weren't picking up styles in IE - random
first = document.createElement('summary');
first.appendChild(document.createTextNode('Details'));
if (details[i].firstChild) {
details[i].insertBefore(first, details[i].firstChild);
} else {
details[i].appendChild(first);
}
}
// this feels *really* nasty, but we can't target details :text in css :(
j = details[i].childNodes.length;
while (j--) {
if (details[i].childNodes[j].nodeName === '#text' && (details[i].childNodes[j].nodeValue||'').replace(/\s/g, '').length) {
wrapper = document.createElement('text');
wrapper.appendChild(details[i].childNodes[j]);
details[i].insertBefore(wrapper, details[i].childNodes[j]);
}
}
first.legend = true;
first.tabIndex = 0;
}
// trigger details in case this being used on it's own
document.createElement('details');
addEvent(details, 'click', toggleDetails);
addEvent(details, 'keypress', toggleDetails);
addStyle();
})(window, document);

It should probably be noted that this solution doesn’t work with <details> elements that contain only text (an edge case, admittedly).

Hmm - it is designed to...

Fixed....though I think I need a shower now :-S

I like the idea of wrapping direct child text nodes in a <text> element. It’s better than wrapping them in a <div>, because that way, any CSS for details div {} will get applied. Clever!

BTW, I completely agree with your comment on line132 :)

I’ve updated the demo page for your snippet: http://jsbin.com/akadi4/2 IE8 and below seems to throw an error though (this happened before the update as well).

Urgh testing for nodeName #text instead of nodeType?

WTF?
why not to use event delegation ???

@yaffle WTF WTF? Why WTF?

i think it's better to use event delegation, so dynamically inserted will be supported too, also you will be able place script at any place in document(not only before

@yaffle ... so fork the script right, instead of getting all upset. Make it better - then we'll use your script and that's better for everyone.

@remy, ok, i will try a little later.
Also some notes:
1) seems, "keydown" event should be used an
2) while checking event.keyCode, event.ctrlKey, event.shiftKey, event.altKey should also be checked (some user agents may have shortcuts or something for such combinations..., so to not preventDefault action for this combinations, it's better to check for !event.ctrlKey && !event.shiftKey && !event.altKey and may be event.metaKey...)

Wow. Awesome! I came up with a very similar approach to this and was looking for a solution to the text node problem and BAM! Remy beat me to it (by like year and a half!). It's nice to be vindicated in my approach though. Thanks for that :)

Yaffle, you can try this script (supports dynamic inclusion): https://github.com/kapitancho/logifill-details

I implemented Element.open in https://gist.github.com/chris-morgan/8909427. Its browser support, however, will be limited to those supporting Object.defineProperty correctly, which is IE9 (http://kangax.github.io/es5-compat-table/#Object.defineProperty suggests IE8 won't work but I don't know).

Please sign in to comment on this gist.

Something went wrong with that request. Please try again.