Skip to content

Conversation

@jirkavrba
Copy link
Contributor

In the new documentation, there is an option key displayed for all users in the search bar.
This PR provides a check for the navigator platform and changes the displayed key to Ctrl when displayed on Windows or Linux.

Search bar displayed on Mac
image

Search bar displayed on Windows/Linux
image

@github-actions
Copy link

github-actions bot commented Oct 23, 2022

Size Changes

📦 Next.js Bundle Analysis

This analysis was generated by the next.js bundle analysis action 🤖

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 89.11 KB (🟡 +46 B)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

Three Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/404 42.5 KB (🟡 +73 B) 131.61 KB
/500 42.48 KB (🟡 +73 B) 131.59 KB
/[[...markdownPath]] 42.56 KB (🟡 +73 B) 131.67 KB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 10% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

@arafatiqbal
Copy link
Contributor

I like this, nice!

Copy link
Member

@gaearon gaearon left a comment

Choose a reason for hiding this comment

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

This doesn't work for initially rendered HTML. Can you instead make it so that we know the platform in advance? E.g. by detecting it in an inline script that runs before the rest of the page, and setting an appropriate HTML class name on the document.

@facebook-github-bot
Copy link
Collaborator

Hi @jirkavrba!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@jirkavrba
Copy link
Contributor Author

I've added the platform detection via an inline script, but I had some troubles with integrating it within the component (as document is not available during the initial render)

Can anybody please point me at how that reading from document could be accomplished during the initial render?

@gaearon
Copy link
Member

gaearon commented Nov 16, 2022

I imagine you would render both versions but one would be hidden via global styles. E.g. via data-platform="mac" or some similar custom attribute and .mac data-platform="mac" selector in global CSS.

@facebook-github-bot
Copy link
Collaborator

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@jirkavrba
Copy link
Contributor Author

Because the search bar component has changed quite a lot since I opened this PR I will close it and I will open a new PR with changes to the current version.

The original issue that this PR is trying to solve seems to be still present on the website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants