Skip to content

doc: make header smaller and dropdown click-driven when JS is on #42165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 7 commits into from
Mar 22, 2022
Merged

doc: make header smaller and dropdown click-driven when JS is on #42165

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
770215f
doc: make header smaller and dropdown click-driven when JS is on
ShogunPanda Mar 1, 2022
e94673a
doc: add assets JS to the linting list
ShogunPanda Mar 2, 2022
3eae4bc
doc: refactored api script
ShogunPanda Mar 18, 2022
d785152
doc: defer script loading
ShogunPanda Mar 18, 2022
05c4fad
doc: defer script loading
ShogunPanda Mar 18, 2022
5e2d376
doc: ensure scope to api assets
ShogunPanda Mar 22, 2022
72a2aef
doc: linted code
ShogunPanda Mar 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: refactored api script
  • Loading branch information
@ShogunPanda
ShogunPanda committed Mar 22, 2022
commit 3eae4bc9e05827b45f36cacc9be43d317c4eb24c
182 changes: 113 additions & 69 deletions doc/api_assets/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,87 +1,131 @@
'use strict';

// Check if we have JavaScript support
document.querySelector(':root').classList.add('has-js');
function setupTheme() {
Comment thread
ShogunPanda marked this conversation as resolved.
Outdated
const kCustomPreference = 'customDarkTheme';
const userSettings = sessionStorage.getItem(kCustomPreference);
const themeToggleButton = document.getElementById('theme-toggle-btn');

// Restore user mode preferences
const kCustomPreference = 'customDarkTheme';
const userSettings = sessionStorage.getItem(kCustomPreference);
const themeToggleButton = document.getElementById('theme-toggle-btn');
if (userSettings === null && window.matchMedia) {
const mq = window.matchMedia('(prefers-color-scheme: dark)');
if ('onchange' in mq) {
function mqChangeListener(e) {
document.documentElement.classList.toggle('dark-mode', e.matches);
if (userSettings === null && window.matchMedia) {
const mq = window.matchMedia('(prefers-color-scheme: dark)');

if ('onchange' in mq) {
function mqChangeListener(e) {
document.documentElement.classList.toggle('dark-mode', e.matches);
}
mq.addEventListener('change', mqChangeListener);
if (themeToggleButton) {
themeToggleButton.addEventListener('click', function() {
mq.removeEventListener('change', mqChangeListener);
}, { once: true });
}
}
mq.addEventListener('change', mqChangeListener);
if (themeToggleButton) {
themeToggleButton.addEventListener('click', function() {
mq.removeEventListener('change', mqChangeListener);
}, { once: true });

if (mq.matches) {
document.documentElement.classList.add('dark-mode');
}
}
if (mq.matches) {
} else if (userSettings === 'true') {
document.documentElement.classList.add('dark-mode');
}
} else if (userSettings === 'true') {
document.documentElement.classList.add('dark-mode');
}
if (themeToggleButton) {
themeToggleButton.hidden = false;
themeToggleButton.addEventListener('click', function() {
sessionStorage.setItem(
kCustomPreference,
document.documentElement.classList.toggle('dark-mode')
);
});

if (themeToggleButton) {
themeToggleButton.hidden = false;
themeToggleButton.addEventListener('click', function() {
sessionStorage.setItem(
kCustomPreference,
document.documentElement.classList.toggle('dark-mode')
);
});
}
}

// Handle pickers with click/taps rather than hovers
const pickers = document.querySelectorAll('.picker-header');
for (const picker of pickers) {
picker.addEventListener('click', (e) => {
if (!e.target.closest('.picker')) {
e.preventDefault();
function setupPickers() {
function closeAllPickers() {
for (const picker of pickers) {
picker.parentNode.classList.remove('expanded');
}

if (picker.classList.contains('expanded')) {
picker.classList.remove('expanded');
} else {
for (const other of pickers) {
other.classList.remove('expanded');
}
window.removeEventListener('click', closeAllPickers);
window.removeEventListener('keydown', onKeyDown);
}

picker.classList.add('expanded');
function onKeyDown(e) {
if (e.key === 'Escape') {
closeAllPickers();
}
});
}

const pickers = document.querySelectorAll('.picker-header > a');

for (const picker of pickers) {
const parentNode = picker.parentNode;

picker.addEventListener('click', (e) => {
e.preventDefault();

/*
closeAllPickers as window event trigger already closed all the pickers,
if it already closed there is nothing else to do here
*/
if (parentNode.classList.contains('expanded')) {
return;
}

/*
In the next frame reopen the picker if needed and also setup events
to close pickers if needed.
*/

requestAnimationFrame(() => {
parentNode.classList.add('expanded');
window.addEventListener('click', closeAllPickers);
window.addEventListener('keydown', onKeyDown);
});
});
}
}
Comment thread
ShogunPanda marked this conversation as resolved.

// Track when the header is in sticky position
const header = document.querySelector('.header');
let ignoreNextIntersection = false;
new IntersectionObserver(
([e]) => {
const currentStatus = header.classList.contains('is-pinned');
const newStatus = e.intersectionRatio < 1;

// Same status, do nothing
if (currentStatus === newStatus) {
return;
} else if (ignoreNextIntersection) {
ignoreNextIntersection = false;
return;
}
function setupStickyHeaders() {
const header = document.querySelector('.header');
let ignoreNextIntersection = false;

new IntersectionObserver(
([e]) => {
const currentStatus = header.classList.contains('is-pinned');
const newStatus = e.intersectionRatio < 1;

// Same status, do nothing
if (currentStatus === newStatus) {
return;
} else if (ignoreNextIntersection) {
ignoreNextIntersection = false;
return;
}

/*
To avoid flickering, ignore the next change event that is triggered
as the visible elements in the header change once we pin it.
/*
To avoid flickering, ignore the next changes event that is triggered
as the visible elements in the header change once we pin it.

The timer is reset anyway after few milliseconds
*/
ignoreNextIntersection = true;
setTimeout(() => ignoreNextIntersection = false, 50);
The timer is reset anyway after few milliseconds.
*/
ignoreNextIntersection = true;
setTimeout(() => {
ignoreNextIntersection = false;
}, 50);

header.classList.toggle('is-pinned', newStatus);
},
{ threshold: [1] }
).observe(header);
header.classList.toggle('is-pinned', newStatus);
},
{ threshold: [1] }
).observe(header);
}

// Check if we have JavaScript support
document.querySelector(':root').classList.add('has-js');
Comment thread
ShogunPanda marked this conversation as resolved.
Outdated

// Restore user mode preferences
setupTheme();
Comment thread
ShogunPanda marked this conversation as resolved.
Outdated

// Handle pickers with click/taps rather than hovers
setupPickers();

// Track when the header is in sticky position
setupStickyHeaders();
9 changes: 8 additions & 1 deletion doc/api_assets/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -811,13 +811,20 @@ kbd {
background-color: var(--color-fill-app);
}

@media not screen, (max-width: 600px), (max-height: 1000px) {
@media not screen, (max-width: 600px) {
.header {
position: relative;
top: 0;
}
}

@media not screen, (max-height: 1000px) {
:root:not(.has-js) .header {
position: relative;
top: 0;
}
}

.header .pinned-header {
display: none;
margin-right: 0.4rem;
Expand Down