Skip to content

Commit

Permalink
tools: fix CJS/ESM toggle on small screens
Browse files Browse the repository at this point in the history
Fixes: nodejs#43468
Co-authored-by: Moshe Atlow <[email protected]>
  • Loading branch information
aduh95 and MoLow committed Jun 20, 2022
1 parent 6ac55fa commit dbd9385
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 1 deletion.
2 changes: 2 additions & 0 deletions doc/api_assets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -953,6 +953,8 @@ kbd {
background-repeat: no-repeat;
width: 142px;
height: 20px;
display: block;
cursor: pointer;
}
.js-flavor-selector:checked {
background-image: url(./js-flavor-esm.svg);
Expand Down
1 change: 1 addition & 0 deletions doc/template.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<link rel="stylesheet" href="assets/hljs.css">
<link rel="canonical" href="https://nodejs.org/api/__FILENAME__.html">
<script async defer src="assets/api.js" type="text/javascript"></script>
__JS_FLAVORED_DYNAMIC_CSS__
</head>
<body class="alt apidoc" id="api-section-__FILENAME__">
<div id="content" class="clearfix">
Expand Down
24 changes: 23 additions & 1 deletion tools/doc/html.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ import { visit } from 'unist-util-visit';
import * as common from './common.mjs';
import * as typeParser from './type-parser.mjs';

const dynamicSizes = Object.create(null);

const { highlight, getLanguage } = highlightJs;

const docPath = new URL('../../doc/', import.meta.url);
Expand Down Expand Up @@ -89,7 +91,21 @@ function processContent(content) {
}) + (firstTime ? '' : '</section>');
}

function buildCSSForFlavoredJS(dynamicSizes) {
if (dynamicSizes == null) return '';

return `<style>${Array.from(dynamicSizes, (charCount) =>
`@media(max-width:${charCount * 8 + 142 + 16 * 4}px){` +
`.with-${charCount}-chars>.js-flavor-selector{` +
'float:none;' +
'margin:0 0 1em auto;' +
'}' +
'}').join('')}</style>`;
}

export function toHTML({ input, content, filename, nodeVersion, versions }) {
const dynamicSizesForThisFile = dynamicSizes[filename];

filename = path.basename(filename, '.md');

const id = filename.replace(/\W+/g, '-');
Expand All @@ -99,6 +115,7 @@ export function toHTML({ input, content, filename, nodeVersion, versions }) {
.replace('__SECTION__', content.section)
.replace(/__VERSION__/g, nodeVersion)
.replace(/__TOC__/g, content.toc)
.replace(/__JS_FLAVORED_DYNAMIC_CSS__/g, buildCSSForFlavoredJS(dynamicSizesForThisFile))
.replace(/__TOC_PICKER__/g, tocPicker(id, content))
.replace(/__GTOC_PICKER__/g, gtocPicker(id))
.replace(/__GTOC__/g, gtocHTML.replace(
Expand Down Expand Up @@ -228,14 +245,19 @@ export function preprocessElements({ filename }) {
const previousNode = parent.children[index - 1] || {};
const nextNode = parent.children[index + 1] || {};

const charCountFirstTwoLines = Math.max(...node.value.split('\n', 2).map((str) => str.length));

if (!isJSFlavorSnippet(previousNode) &&
isJSFlavorSnippet(nextNode) &&
nextNode.lang !== node.lang) {
// Saving the highlight code as value to be added in the next node.
node.value = highlighted;
node.charCountFirstTwoLines = charCountFirstTwoLines;
} else if (isJSFlavorSnippet(previousNode) &&
previousNode.lang !== node.lang) {
node.value = '<pre>' +
const actualCharCount = Math.max(charCountFirstTwoLines, previousNode.charCountFirstTwoLines);
(dynamicSizes[filename] ??= new Set()).add(actualCharCount);
node.value = `<pre class="with-${actualCharCount}-chars">` +
'<input class="js-flavor-selector" type="checkbox"' +
// If CJS comes in second, ESM should display by default.
(node.lang === 'cjs' ? ' checked' : '') +
Expand Down

0 comments on commit dbd9385

Please sign in to comment.