Skip to content
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

Jump to bottom

doc: fix CJS/ESM toggle on small screens #43495

Closed
wants to merge 2 commits into from
Closed

doc: fix CJS/ESM toggle on small screens #43495

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b96a2a6
doc: fix CJS/ESM toggle on small screens
MoLow Jun 19, 2022
17ee9d3
Update doc/api_assets/style.css
MoLow Jun 20, 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
9 changes: 9 additions & 0 deletions doc/api_assets/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -953,6 +953,7 @@ kbd {
background-repeat: no-repeat;
width: 142px;
height: 20px;
cursor: pointer;
}
.js-flavor-selector:checked {
background-image: url(./js-flavor-esm.svg);
Expand All @@ -972,6 +973,14 @@ kbd {
}
}

@media only screen and (max-width: 600px) {
Copy link
Contributor

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.

Suggested change
@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)) {

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. 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.

  1. the 80 char lines is a limit in documentation text, not inside pre tags that take 100% width

Copy link
Contributor

@aduh95 aduh95 Jun 20, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. 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.

Copy link
Member Author

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

Copy link
Contributor

@aduh95 aduh95 Jun 20, 2022 •
edited
Loading

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some observations:

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.

Copy link
Contributor

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.

Copy link
Contributor

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?

Copy link
Member Author

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

Copy link
Contributor

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

.js-flavor-selector {
float: none;
display: block;
margin: 0 0 1em 0;
LiviaMedeiros marked this conversation as resolved.
Show resolved Hide resolved
MoLow marked this conversation as resolved.
Show resolved Hide resolved
}
}

@media print {
html {
height: auto;
Expand Down