A place to cache linked articles (think custom and personal wayback machine)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

index.html 22KB

2 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. <!doctype html><!-- This is a valid HTML5 document. -->
  2. <!-- Screen readers, SEO, extensions and so on. -->
  3. <html lang="fr">
  4. <!-- Has to be within the first 1024 bytes, hence before the `title` element
  5. See: https://www.w3.org/TR/2012/CR-html5-20121217/document-metadata.html#charset -->
  6. <meta charset="utf-8">
  7. <!-- Why no `X-UA-Compatible` meta: https://stackoverflow.com/a/6771584 -->
  8. <!-- The viewport meta is quite crowded and we are responsible for that.
  9. See: https://codepen.io/tigt/post/meta-viewport-for-2015 -->
  10. <meta name="viewport" content="width=device-width,initial-scale=1">
  11. <!-- Required to make a valid HTML5 document. -->
  12. <title>Add Responsive-Friendly Enhancements to `details` with `details-utils`-zachleat.com (archive) — David Larlet</title>
  13. <meta name="description" content="Publication mise en cache pour en conserver une trace.">
  14. <!-- That good ol' feed, subscribe :). -->
  15. <link rel="alternate" type="application/atom+xml" title="Feed" href="/david/log/">
  16. <!-- Generated from https://realfavicongenerator.net/ such a mess. -->
  17. <link rel="apple-touch-icon" sizes="180x180" href="/static/david/icons2/apple-touch-icon.png">
  18. <link rel="icon" type="image/png" sizes="32x32" href="/static/david/icons2/favicon-32x32.png">
  19. <link rel="icon" type="image/png" sizes="16x16" href="/static/david/icons2/favicon-16x16.png">
  20. <link rel="manifest" href="/static/david/icons2/site.webmanifest">
  21. <link rel="mask-icon" href="/static/david/icons2/safari-pinned-tab.svg" color="#07486c">
  22. <link rel="shortcut icon" href="/static/david/icons2/favicon.ico">
  23. <meta name="msapplication-TileColor" content="#f7f7f7">
  24. <meta name="msapplication-config" content="/static/david/icons2/browserconfig.xml">
  25. <meta name="theme-color" content="#f7f7f7" media="(prefers-color-scheme: light)">
  26. <meta name="theme-color" content="#272727" media="(prefers-color-scheme: dark)">
  27. <!-- Documented, feel free to shoot an email. -->
  28. <link rel="stylesheet" href="/static/david/css/style_2021-01-20.css">
  29. <!-- See https://www.zachleat.com/web/comprehensive-webfonts/ for the trade-off. -->
  30. <link rel="preload" href="/static/david/css/fonts/triplicate_t4_poly_regular.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" crossorigin>
  31. <link rel="preload" href="/static/david/css/fonts/triplicate_t4_poly_bold.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" crossorigin>
  32. <link rel="preload" href="/static/david/css/fonts/triplicate_t4_poly_italic.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" crossorigin>
  33. <link rel="preload" href="/static/david/css/fonts/triplicate_t3_regular.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: dark)" crossorigin>
  34. <link rel="preload" href="/static/david/css/fonts/triplicate_t3_bold.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: dark)" crossorigin>
  35. <link rel="preload" href="/static/david/css/fonts/triplicate_t3_italic.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: dark)" crossorigin>
  36. <script>
  37. function toggleTheme(themeName) {
  38. document.documentElement.classList.toggle(
  39. 'forced-dark',
  40. themeName === 'dark'
  41. )
  42. document.documentElement.classList.toggle(
  43. 'forced-light',
  44. themeName === 'light'
  45. )
  46. }
  47. const selectedTheme = localStorage.getItem('theme')
  48. if (selectedTheme !== 'undefined') {
  49. toggleTheme(selectedTheme)
  50. }
  51. </script>
  52. <meta name="robots" content="noindex, nofollow">
  53. <meta content="origin-when-cross-origin" name="referrer">
  54. <!-- Canonical URL for SEO purposes -->
  55. <link rel="canonical" href="https://www.zachleat.com/web/details-utils/">
  56. <body class="remarkdown h1-underline h2-underline h3-underline em-underscore hr-center ul-star pre-tick" data-instant-intensity="viewport-all">
  57. <article>
  58. <header>
  59. <h1>Add Responsive-Friendly Enhancements to `details` with `details-utils`-zachleat.com</h1>
  60. </header>
  61. <nav>
  62. <p class="center">
  63. <a href="/david/" title="Aller à l’accueil"><svg class="icon icon-home">
  64. <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-home"></use>
  65. </svg> Accueil</a> •
  66. <a href="https://www.zachleat.com/web/details-utils/" title="Lien vers le contenu original">Source originale</a>
  67. </p>
  68. </nav>
  69. <hr>
  70. <p>I use <code>&lt;details&gt;</code>. I use <code>&lt;details&gt;</code> a lot. It is one of my favorite HTML elements.</p>
  71. <p>Over time I’ve collected a bunch of add-on utilities to enhance <code>&lt;details&gt;</code> with new features and functionality. They’ve been super useful in <em>a bunch</em> of long-standing production implementations at Netlify:</p>
  72. <p>I’ve decided to finally package those <code>&lt;details&gt;</code> helpers up and formally release them as a web component!</p>
  73. <h2 id="lessdetails-utilsgreater" tabindex="-1"><code>&lt;details-utils&gt;</code> <a class="direct-link" href="#lessdetails-utilsgreater" aria-hidden="true">#</a></h2>
  74. <pre class="language-html"><code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details-utils</span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details</span><span class="token punctuation">&gt;</span></span>…<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details</span><span class="token punctuation">&gt;</span></span><br> <br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details-utils</span><span class="token punctuation">&gt;</span></span></code></pre>
  75. <p>At time of writing, this web component adds five new responsive-friendly enhancements to one or more <code>&lt;details&gt;</code> elements nestled inside:</p>
  76. <ul><li>Force open/closed</li><li>Click outside to close</li><li>Close on <code>esc</code></li><li>Animate open/closed</li><li>Toggle root element <code>class</code></li></ul>
  77. <h3 id="force-openclosed" tabindex="-1">Force open/closed <a class="direct-link" href="#force-openclosed" aria-hidden="true">#</a></h3>
  78. <p>In this example, the <code>&lt;details&gt;</code> is forced open when viewport is wider than <code>48em</code>.</p>
  79. <pre class="language-html"><code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details-utils</span> <span class="token attr-name">force-open</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">"</span>(min-width: 48em)<span class="token punctuation">"</span></span> <span class="token attr-name">force-restore</span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details</span> <span class="token attr-name">open</span><span class="token punctuation">&gt;</span></span>…<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details</span><span class="token punctuation">&gt;</span></span><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details-utils</span><span class="token punctuation">&gt;</span></span></code></pre>
  80. <p>I’ve gotten <em>a lot</em> of mileage out of the above example, specifically to drive navigation that is always visible at a certain breakpoint (think a collapsible menu at small viewport versus sidebar, e.g. <a href="https://www.11ty.dev/docs/"><code>11ty.dev/docs/</code></a>).</p>
  81. <p>Alternatively, <code>force-close</code> is also available. The optional <code>force-restore</code> attribute will restore previous state when the <code>force-open</code> or <code>force-close</code> media queries do not match.</p>
  82. <p>The media query is optional, and using it as a bare attribute allows control of the state pre and post JavaScript.</p>
  83. <pre class="language-html"><code class="language-html"><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details-utils</span> <span class="token attr-name">force-open</span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details</span><span class="token punctuation">&gt;</span></span>…<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details</span><span class="token punctuation">&gt;</span></span><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details-utils</span><span class="token punctuation">&gt;</span></span><br><br><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details-utils</span> <span class="token attr-name">force-close</span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details</span> <span class="token attr-name">open</span><span class="token punctuation">&gt;</span></span>…<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details</span><span class="token punctuation">&gt;</span></span><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details-utils</span><span class="token punctuation">&gt;</span></span></code></pre>
  84. <h3 id="click-outside-to-close" tabindex="-1">Click outside to close <a class="direct-link" href="#click-outside-to-close" aria-hidden="true">#</a></h3>
  85. <p>If you click anywhere on the document (outside of the <code>&lt;details&gt;</code> content), the <code>&lt;details&gt;</code> will be closed. This is useful when you want to absolutely position the <code>&lt;details&gt;</code> content (maybe to make a little custom dropdown 😱)</p>
  86. <pre class="language-html"><code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details-utils</span> <span class="token attr-name">close-click-outside</span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details</span><span class="token punctuation">&gt;</span></span>…<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details</span><span class="token punctuation">&gt;</span></span><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details-utils</span><span class="token punctuation">&gt;</span></span></code></pre>
  87. <p>You can scope this with a media query as well:</p>
  88. <pre class="language-html"><code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details-utils</span> <span class="token attr-name">close-click-outside</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">"</span>(min-width: 48em)<span class="token punctuation">"</span></span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details</span><span class="token punctuation">&gt;</span></span>…<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details</span><span class="token punctuation">&gt;</span></span><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details-utils</span><span class="token punctuation">&gt;</span></span></code></pre>
  89. <p>Add your own bonus close button inside of the content (to complement <code>&lt;summary&gt;</code>):</p>
  90. <pre class="language-css"><code class="language-css"><br><span class="token selector">details-utils:not(:defined) [data-du-close-click]</span> <span class="token punctuation">{</span><br> <span class="token property">display</span><span class="token punctuation">:</span> none<span class="token punctuation">;</span><br><span class="token punctuation">}</span></code></pre>
  91. <pre class="language-html"><code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details-utils</span> <span class="token attr-name">close-click-outside</span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details</span> <span class="token attr-name">id</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">"</span>my-details<span class="token punctuation">"</span></span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>summary</span><span class="token punctuation">&gt;</span></span>…<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>summary</span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>button</span> <span class="token attr-name">type</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">"</span>button<span class="token punctuation">"</span></span> <span class="token attr-name">aria-controls</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">"</span>my-details<span class="token punctuation">"</span></span> <span class="token attr-name">data-du-close-click</span><span class="token punctuation">&gt;</span></span>Close<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>button</span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details</span><span class="token punctuation">&gt;</span></span><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details-utils</span><span class="token punctuation">&gt;</span></span></code></pre>
  92. <h3 id="close-on-esc" tabindex="-1">Close on <code>esc</code> <a class="direct-link" href="#close-on-esc" aria-hidden="true">#</a></h3>
  93. <p>Closes the <code>&lt;details&gt;</code> when the <code>esc</code> key is hit on the keyboard. Media query is optional.</p>
  94. <pre class="language-html"><code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details-utils</span> <span class="token attr-name">close-esc</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">"</span>(max-width: 767px)<span class="token punctuation">"</span></span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details</span><span class="token punctuation">&gt;</span></span>…<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details</span><span class="token punctuation">&gt;</span></span><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details-utils</span><span class="token punctuation">&gt;</span></span></code></pre>
  95. <h3 id="animate-openclose" tabindex="-1">Animate open/close <a class="direct-link" href="#animate-openclose" aria-hidden="true">#</a></h3>
  96. <pre class="language-html"><code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details-utils</span> <span class="token attr-name">animate</span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details</span><span class="token punctuation">&gt;</span></span>…<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details</span><span class="token punctuation">&gt;</span></span><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details-utils</span><span class="token punctuation">&gt;</span></span></code></pre>
  97. <p>Animates the height of the content when opening and closing the <code>&lt;details&gt;</code>. Ignored automatically if <code>(prefers-reduced-motion)</code> is detected.</p>
  98. <p>Just a full disclosure, the configuration around this one is pretty limited (re: easing and timing). Also this doesn’t support media query scoping yet (not for any technical reason, just haven’t run into this use case yet). Open to contributions here!</p>
  99. <h3 id="toggle-class-on-root-element" tabindex="-1">Toggle <code>class</code> on root element <a class="direct-link" href="#toggle-class-on-root-element" aria-hidden="true">#</a></h3>
  100. <pre class="language-html"><code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details-utils</span> <span class="token attr-name">toggle-document-class</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">"</span>my-class-name<span class="token punctuation">"</span></span><span class="token punctuation">&gt;</span></span><br> <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>details</span><span class="token punctuation">&gt;</span></span>…<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details</span><span class="token punctuation">&gt;</span></span><br><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span>details-utils</span><span class="token punctuation">&gt;</span></span></code></pre>
  101. <p>Adds a <code>class</code> to your <code>&lt;html&gt;</code> element when the <code>&lt;details&gt;</code> is open and removes it when the <code>&lt;details&gt;</code> is closed.</p>
  102. <h2 id="enjoy!" tabindex="-1">Enjoy! <a class="direct-link" href="#enjoy!" aria-hidden="true">#</a></h2>
  103. <p>Wiring up and combining each of these enhancements to <code>&lt;details&gt;</code> really can go a long way in building a lot of complex user interface elements in a pretty straightforward way. In my humble opinion, the super long list of things I’ve built using this is proof of that. I hope you can get some useful mileage out of them too!</p>
  104. </article>
  105. <hr>
  106. <footer>
  107. <p>
  108. <a href="/david/" title="Aller à l’accueil"><svg class="icon icon-home">
  109. <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-home"></use>
  110. </svg> Accueil</a> •
  111. <a href="/david/log/" title="Accès au flux RSS"><svg class="icon icon-rss2">
  112. <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-rss2"></use>
  113. </svg> Suivre</a> •
  114. <a href="http://larlet.com" title="Go to my English profile" data-instant><svg class="icon icon-user-tie">
  115. <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-user-tie"></use>
  116. </svg> Pro</a> •
  117. <a href="mailto:david%40larlet.fr" title="Envoyer un courriel"><svg class="icon icon-mail">
  118. <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-mail"></use>
  119. </svg> Email</a> •
  120. <abbr class="nowrap" title="Hébergeur : Alwaysdata, 62 rue Tiquetonne 75002 Paris, +33184162340"><svg class="icon icon-hammer2">
  121. <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-hammer2"></use>
  122. </svg> Légal</abbr>
  123. </p>
  124. <template id="theme-selector">
  125. <form>
  126. <fieldset>
  127. <legend><svg class="icon icon-brightness-contrast">
  128. <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-brightness-contrast"></use>
  129. </svg> Thème</legend>
  130. <label>
  131. <input type="radio" value="auto" name="chosen-color-scheme" checked> Auto
  132. </label>
  133. <label>
  134. <input type="radio" value="dark" name="chosen-color-scheme"> Foncé
  135. </label>
  136. <label>
  137. <input type="radio" value="light" name="chosen-color-scheme"> Clair
  138. </label>
  139. </fieldset>
  140. </form>
  141. </template>
  142. </footer>
  143. <script src="/static/david/js/instantpage-5.1.0.min.js" type="module"></script>
  144. <script>
  145. function loadThemeForm(templateName) {
  146. const themeSelectorTemplate = document.querySelector(templateName)
  147. const form = themeSelectorTemplate.content.firstElementChild
  148. themeSelectorTemplate.replaceWith(form)
  149. form.addEventListener('change', (e) => {
  150. const chosenColorScheme = e.target.value
  151. localStorage.setItem('theme', chosenColorScheme)
  152. toggleTheme(chosenColorScheme)
  153. })
  154. const selectedTheme = localStorage.getItem('theme')
  155. if (selectedTheme && selectedTheme !== 'undefined') {
  156. form.querySelector(`[value="${selectedTheme}"]`).checked = true
  157. }
  158. }
  159. const prefersColorSchemeDark = '(prefers-color-scheme: dark)'
  160. window.addEventListener('load', () => {
  161. let hasDarkRules = false
  162. for (const styleSheet of Array.from(document.styleSheets)) {
  163. let mediaRules = []
  164. for (const cssRule of styleSheet.cssRules) {
  165. if (cssRule.type !== CSSRule.MEDIA_RULE) {
  166. continue
  167. }
  168. // WARNING: Safari does not have/supports `conditionText`.
  169. if (cssRule.conditionText) {
  170. if (cssRule.conditionText !== prefersColorSchemeDark) {
  171. continue
  172. }
  173. } else {
  174. if (cssRule.cssText.startsWith(prefersColorSchemeDark)) {
  175. continue
  176. }
  177. }
  178. mediaRules = mediaRules.concat(Array.from(cssRule.cssRules))
  179. }
  180. // WARNING: do not try to insert a Rule to a styleSheet you are
  181. // currently iterating on, otherwise the browser will be stuck
  182. // in a infinite loop…
  183. for (const mediaRule of mediaRules) {
  184. styleSheet.insertRule(mediaRule.cssText)
  185. hasDarkRules = true
  186. }
  187. }
  188. if (hasDarkRules) {
  189. loadThemeForm('#theme-selector')
  190. }
  191. })
  192. </script>
  193. </body>
  194. </html>