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.

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

Prevent layout shift by removing <ClientOnly> on the theme selector #5116

Merged
merged 2 commits into from
Oct 31, 2024

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Oct 31, 2024

Fixes

Fixes #5085 by @obulat

Description

This PR

  • removes <ClientOnly> around VThemeSelect in the footer
  • updates the VThemeSelect component to use Refs instead of ComputedRefss
  • uses onMounted and watch to keep the refs updated

These in combination lead to the layout shift being eliminated and avoid server-client hydration mismatches.

Testing Instructions

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@openverse-bot openverse-bot added 🧱 stack: frontend Related to the Nuxt frontend 🟧 priority: high Stalls work on the project or its dependents ✨ goal: improvement Improvement to an existing user-facing feature 🕹 aspect: interface Concerns end-users' experience with the software labels Oct 31, 2024
Copy link

github-actions bot commented Oct 31, 2024

Latest k6 run output1

     ✓ status was 200

     checks.........................: 100.00% ✓ 6400      ✗ 0   
     data_received..................: 1.5 GB  8.8 MB/s
     data_sent......................: 837 kB  5.0 kB/s
     http_req_blocked...............: avg=9.67µs   min=1.98µs  med=3.76µs   max=4.27ms  p(90)=5.35µs   p(95)=5.77µs  
     http_req_connecting............: avg=4.81µs   min=0s      med=0s       max=3.71ms  p(90)=0s       p(95)=0s      
     http_req_duration..............: avg=585.29ms min=58.03ms med=508.53ms max=2.24s   p(90)=1.05s    p(95)=1.16s   
       { expected_response:true }...: avg=585.29ms min=58.03ms med=508.53ms max=2.24s   p(90)=1.05s    p(95)=1.16s   
   ✓ http_req_failed................: 0.00%   ✓ 0         ✗ 6400
     http_req_receiving.............: avg=142.25µs min=43.32µs med=110.89µs max=16.09ms p(90)=175.45µs p(95)=211.26µs
     http_req_sending...............: avg=19.97µs  min=6.91µs  med=19.12µs  max=2.5ms   p(90)=24.87µs  p(95)=26.9µs  
     http_req_tls_handshaking.......: avg=0s       min=0s      med=0s       max=0s      p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=585.12ms min=57.9ms  med=508.4ms  max=2.24s   p(90)=1.05s    p(95)=1.16s   
     http_reqs......................: 6400    37.967938/s
     iteration_duration.............: avg=3.12s    min=1.21s   med=2.54s    max=8.89s   p(90)=6.13s    p(95)=6.46s   
     iterations.....................: 1200    7.118988/s
     vus............................: 8       min=8       max=30
     vus_max........................: 30      min=30      max=30

Footnotes

  1. This comment will automatically update with new output each time k6 runs for this PR

@dhruvkb dhruvkb marked this pull request as ready for review October 31, 2024 03:01
@dhruvkb dhruvkb requested a review from a team as a code owner October 31, 2024 03:01
@dhruvkb dhruvkb requested review from krysal and obulat October 31, 2024 03:01
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Awesome, no shift anymore ✨

One request for change during the initialization.

frontend/src/components/VThemeSelect/VThemeSelect.vue Outdated Show resolved Hide resolved
@dhruvkb dhruvkb merged commit 040906e into main Oct 31, 2024
48 checks passed
@dhruvkb dhruvkb deleted the themer_layout_shift branch October 31, 2024 04:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕹 aspect: interface Concerns end-users' experience with the software ✨ goal: improvement Improvement to an existing user-facing feature 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Prevent layout shift when the theme switcher is rendered
3 participants