1
0
mirror of synced 2025-12-21 10:57:10 -05:00
Files
docs/javascripts/wrap-code-terms.js
Sarah Schneider cc7bd5d701 Wrap slash characters in tables (#15774)
* include slashes in list of chars to inject <wbr> tags around for better table rendering

* add clarifying comment to tables.scss
2020-09-28 10:54:23 -04:00

27 lines
1.1 KiB
JavaScript

const wordsLongerThan18Chars = /[\w:/\\]{18,}/g
const camelCaseChars = /([a-z])([A-Z])/g
const underscoresAfter12thChar = /([\w:]{12}[^_]*?)_/g
const slashChars = /([/\\])/g
// This module improves table rendering on reference pages by inserting a <wbr>
// tag in code terms that use camelcase, slashes, or underscores, inspired by
// http://heap.ch/blog/2016/01/19/camelwrap/
export default function () {
const codeTerms = document.querySelectorAll('#article-contents table code')
if (!codeTerms) return
codeTerms.forEach(node => {
node.innerHTML = node.innerHTML.replace(wordsLongerThan18Chars, (str) => {
return str
// GraphQL code terms use camelcase
.replace(camelCaseChars, '$1<wbr>$2')
// REST code terms use underscores
// to keep word breaks looking nice, only break on underscores after the 12th char
// so `has_organization_projects` will break after `has_organization` instead of after `has_`
.replace(underscoresAfter12thChar, '$1_<wbr>')
// Some Actions reference pages have tables with code terms separated by slashes
.replace(slashChars, '$1<wbr>')
})
})
}