-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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.
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
doc: fix CJS/ESM toggle on small screens #43495
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! LGTM with or without a suggestion:
@nodejs/documentation |
This comment was marked as outdated.
This comment was marked as outdated.
The issue was not reproducible on some browser at least on iOS: #43468 (comment), /cc @aduh95 It might happen because browser had viewport wider than 600px; but otherwise we need a confirmation that the fix doesn't break layout on those environments, before fast-tracking. |
@@ -972,6 +973,14 @@ kbd { | |||
} | |||
} | |||
|
|||
@media only screen and (max-width: 600px) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any reason for using 600px here? Given that all doc example should wrapped around 80 chars a line, I think we can use a more fine grained value.
@media only screen and (max-width: 600px) { | |
/* 80 chars + the width of the toggle input + 20px of margin */ | |
@media only screen and (max-width: calc(80ch + 142px + 20px)) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
calc
is not supported in media query:
Properties sometimes accept complex values, e.g., calculations that involve several other values. Media features only accept single values: one keyword, one number, etc.
- the 80 char lines is a limit in documentation text, not inside
pre
tags that take 100% width
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
calc
is not supported in media query:
That doesn't seem to be correct, according to https://drafts.csswg.org/mediaqueries/#width any <length>
is a valid value, and IIUC that should include calc()
.
2. the 80 char lines is a limit in documentation text, not inside
pre
tags that take 100% width
I still think it would be a better value than 600px, that feels quite arbitrary to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It simply dosent work on chrome
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting, it does work on Chrome 105 but not on Chrome 102 (I've tested on Firefox 101 and Safari 15.5, both support calc()
media queries). Given Chrome release schedule, should we ignore that incompatibility?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some observations:
- Currently, the longest line to be overlapped with the switch is
const { createHook, executionAsyncId, triggerAsyncId } = require('node:async_hooks');
, 85 characters. - On my Chrome, overlapping for 80 characters happens on
< 820
and1024 ~ 1090
. - On 600px viewport, overlapping starts at ~49 characters.
- Only first two lines might overlap with the switch.
Is it possible/reasonable to add a linter rule in docs for cjs
/mjs
blocks, forcing <=50
or <=60
for first two lines and maybe <= 80
for the rest?
Another option is to keep this fix with hardcoded width and eventually somehow redesign the switch, e.g. by attaching it "outside" of code block.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've opened #43506 to propose another suggestion: instead of applying the same breakpoint for all screen sizes, we could adapt to the length of the content. Let me know what you think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So should we go with #43506 instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Both sound ok to me. I haven't tested your PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you (or someone else) want to test it, you can check out the built version from GitHub Actions: https://github.com/nodejs/node/actions/runs/2543023359
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Fixes: #43468
before:
after: