Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Refactor SCREEN_SIZES to match z-indices.js #1985

Merged
merged 5 commits into from
Nov 22, 2022
Merged

Refactor SCREEN_SIZES to match z-indices.js #1985

merged 5 commits into from
Nov 22, 2022

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Nov 18, 2022

Description

This PR changes SCREEN_SIZES, which is currently a Map into a Record, which makes it more ergonomic to use and improves type-safety.

Checklist

  • My pull request has a descriptive title (not a vague title like Update 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.

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.

@dhruvkb dhruvkb added 🟩 priority: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository labels Nov 18, 2022
@github-actions
Copy link

github-actions bot commented Nov 18, 2022 •
edited
Loading

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1985
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1985/tailwind

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@github-actions
Copy link

github-actions bot commented Nov 18, 2022 •
edited
Loading

Size Change: -2.88 kB (0%)

Total Size: 821 kB

Filename Size Change
./.nuxt/dist/client/232.js 0 B -272 B (removed) 🏆
./.nuxt/dist/client/232.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/233.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 129 kB -1.18 kB (-1%)
./.nuxt/dist/client/app.modern.js 120 kB -1.22 kB (-1%)
./.nuxt/dist/client/commons/app.js 88.1 kB -250 B (0%)
./.nuxt/dist/client/commons/app.modern.js 76.9 kB -137 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.js 5.15 kB +10 B (0%)
./.nuxt/dist/client/pages/index.js 5.06 kB +29 B (+1%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB -11 B (-1%)
./.nuxt/dist/client/pages/search/audio.js 3.83 kB +16 B (0%)
./.nuxt/dist/client/runtime.js 2.65 kB -52 B (-2%)
./.nuxt/dist/client/runtime.modern.js 2.65 kB -52 B (-2%)
./.nuxt/dist/client/vendors/app.js 62.2 kB -24 B (0%)
./.nuxt/dist/client/222.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/222.modern.js 276 B +276 B (new file) 🆕
./.nuxt/dist/client/223.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/components/loading-icon.js 745 B -2 B (0%)
./.nuxt/dist/client/components/loading-icon.modern.js 750 B 0 B
./.nuxt/dist/client/components/table-sort-icon.js 509 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 513 B 0 B
./.nuxt/dist/client/components/v-all-results-grid.modern.js 5.01 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-cell.js 357 B -1 B (0%)
./.nuxt/dist/client/components/v-audio-cell.modern.js 360 B 0 B
./.nuxt/dist/client/components/v-audio-details.js 1.81 kB 0 B
./.nuxt/dist/client/components/v-audio-details.modern.js 1.79 kB 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.01 kB 0 B
./.nuxt/dist/client/components/v-audio-track.js 5.13 kB -6 B (0%)
./.nuxt/dist/client/components/v-audio-track.modern.js 5.07 kB +2 B (0%)
./.nuxt/dist/client/components/v-back-to-search-results-link.js 537 B 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 539 B -3 B (-1%)
./.nuxt/dist/client/components/v-bone.js 684 B -1 B (0%)
./.nuxt/dist/client/components/v-bone.modern.js 689 B 0 B
./.nuxt/dist/client/components/v-box-layout.js 1.2 kB +1 B (0%)
./.nuxt/dist/client/components/v-box-layout.modern.js 1.2 kB 0 B
./.nuxt/dist/client/components/v-content-link.js 1.11 kB +1 B (0%)
./.nuxt/dist/client/components/v-content-link.modern.js 1.09 kB 0 B
./.nuxt/dist/client/components/v-content-page.js 467 B 0 B
./.nuxt/dist/client/components/v-content-page.modern.js 471 B 0 B
./.nuxt/dist/client/components/v-content-report-button.js 778 B +1 B (0%)
./.nuxt/dist/client/components/v-content-report-button.modern.js 785 B 0 B
./.nuxt/dist/client/components/v-content-report-form.js 3.75 kB -2 B (0%)
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.56 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.js 4.41 kB -3 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.22 kB 0 B
./.nuxt/dist/client/components/v-copy-button.js 3.98 kB -2 B (0%)
./.nuxt/dist/client/components/v-copy-button.modern.js 4 kB 0 B
./.nuxt/dist/client/components/v-copy-license.js 999 B +1 B (0%)
./.nuxt/dist/client/components/v-copy-license.modern.js 1 kB 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.51 kB +2 B (0%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.modern.js 9.48 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 747 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 753 B 0 B
./.nuxt/dist/client/components/v-error-image.js 1.69 kB +2 B (0%)
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB +2 B (0%)
./.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./.nuxt/dist/client/components/v-error-section.modern.js 376 B 0 B
./.nuxt/dist/client/components/v-external-search-form.js 3.09 kB +1 B (0%)
./.nuxt/dist/client/components/v-external-search-form.modern.js 3.06 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.js 2.54 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.modern.js 2.52 kB 0 B
./.nuxt/dist/client/components/v-full-layout.js 1.48 kB -6 B (0%)
./.nuxt/dist/client/components/v-full-layout.modern.js 1.49 kB +1 B (0%)
./.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.modern.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-image-cell.js 1.43 kB 0 B
./.nuxt/dist/client/components/v-image-cell.modern.js 1.42 kB 0 B
./.nuxt/dist/client/components/v-image-details.js 1.44 kB -1 B (0%)
./.nuxt/dist/client/components/v-image-details.modern.js 1.44 kB 0 B
./.nuxt/dist/client/components/v-image-grid.js 2.54 kB +1 B (0%)
./.nuxt/dist/client/components/v-image-grid.modern.js 2.42 kB 0 B
./.nuxt/dist/client/components/v-license-tab-panel.js 521 B 0 B
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 525 B 0 B
./.nuxt/dist/client/components/v-load-more.js 790 B 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 682 B 0 B
./.nuxt/dist/client/components/v-media-license.js 800 B 0 B
./.nuxt/dist/client/components/v-media-license.modern.js 808 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.62 kB +1 B (0%)
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-media-tag.js 430 B 0 B
./.nuxt/dist/client/components/v-media-tag.modern.js 434 B 0 B
./.nuxt/dist/client/components/v-no-results.js 2.75 kB 0 B
./.nuxt/dist/client/components/v-no-results.modern.js 2.72 kB 0 B
./.nuxt/dist/client/components/v-radio.js 1.51 kB +1 B (0%)
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB 0 B
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB +1 B (0%)
./.nuxt/dist/client/components/v-related-audio.modern.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-related-images.js 3.09 kB -2 B (0%)
./.nuxt/dist/client/components/v-related-images.modern.js 2.98 kB 0 B
./.nuxt/dist/client/components/v-report-desc-form.js 965 B 0 B
./.nuxt/dist/client/components/v-report-desc-form.modern.js 964 B 0 B
./.nuxt/dist/client/components/v-row-layout.js 1.7 kB -3 B (0%)
./.nuxt/dist/client/components/v-row-layout.modern.js 1.71 kB 0 B
./.nuxt/dist/client/components/v-scroll-button.js 813 B +1 B (0%)
./.nuxt/dist/client/components/v-scroll-button.modern.js 818 B 0 B
./.nuxt/dist/client/components/v-search-grid.js 5.43 kB -2 B (0%)
./.nuxt/dist/client/components/v-search-grid.modern.js 5.38 kB +2 B (0%)
./.nuxt/dist/client/components/v-search-results-title.js 656 B -1 B (0%)
./.nuxt/dist/client/components/v-search-results-title.modern.js 652 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.js 793 B -1 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.modern.js 771 B +2 B (0%)
./.nuxt/dist/client/components/v-server-timeout.js 299 B 0 B
./.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./.nuxt/dist/client/components/v-sidebar-target.js 318 B 0 B
./.nuxt/dist/client/components/v-sidebar-target.modern.js 321 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 996 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 894 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.js 888 B -1 B (0%)
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 894 B 0 B
./.nuxt/dist/client/components/v-snackbar.js 1.18 kB +3 B (0%)
./.nuxt/dist/client/components/v-snackbar.modern.js 1.19 kB 0 B
./.nuxt/dist/client/components/v-sources-table.js 15.8 kB -3 B (0%)
./.nuxt/dist/client/components/v-sources-table.modern.js 15.8 kB 0 B
./.nuxt/dist/client/components/v-warning-suppressor.js 298 B 0 B
./.nuxt/dist/client/components/v-warning-suppressor.modern.js 303 B 0 B
./.nuxt/dist/client/pages/about.js 1.14 kB -4 B (0%)
./.nuxt/dist/client/pages/about.modern.js 1.14 kB 0 B
./.nuxt/dist/client/pages/audio/_id.js 4.89 kB -3 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 4.72 kB 0 B
./.nuxt/dist/client/pages/external-sources.js 1.52 kB -2 B (0%)
./.nuxt/dist/client/pages/external-sources.modern.js 1.53 kB +1 B (0%)
./.nuxt/dist/client/pages/feedback.js 1.31 kB +2 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 1.31 kB +1 B (0%)
./.nuxt/dist/client/pages/image/_id.js 5.31 kB +3 B (0%)
./.nuxt/dist/client/pages/image/_id.modern.js 7.25 kB -1 B (0%)
./.nuxt/dist/client/pages/index.modern.js 4.93 kB +2 B (0%)
./.nuxt/dist/client/pages/preferences.modern.js 1.2 kB 0 B
./.nuxt/dist/client/pages/search-help.js 1.62 kB -1 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.61 kB 0 B
./.nuxt/dist/client/pages/search.js 2.72 kB -3 B (0%)
./.nuxt/dist/client/pages/search.modern.js 2.57 kB -1 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 3.7 kB +2 B (0%)
./.nuxt/dist/client/pages/search/image.js 2.85 kB +6 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.73 kB 0 B
./.nuxt/dist/client/pages/search/index.js 545 B +4 B (+1%)
./.nuxt/dist/client/pages/search/index.modern.js 547 B -1 B (0%)
./.nuxt/dist/client/pages/search/model-3d.js 243 B 0 B
./.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.js 266 B +1 B (0%)
./.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B 0 B
./.nuxt/dist/client/pages/search/video.js 240 B 0 B
./.nuxt/dist/client/pages/search/video.modern.js 243 B 0 B
./.nuxt/dist/client/pages/sources.js 1.51 kB -5 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.51 kB 0 B
./.nuxt/dist/client/vendors/app.modern.js 61.9 kB +6 B (0%)

compressed-size-action

@dhruvkb dhruvkb marked this pull request as ready for review November 18, 2022 10:52
@dhruvkb dhruvkb requested a review from a team as a code owner November 18, 2022 10:52
obulat
obulat approved these changes Nov 18, 2022
View reviewed changes
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.

I like the ease with which we can use the screens. Approving, but would like to see more documentation about why xs is not real 😆

src/constants/screens.js Show resolved Hide resolved
zackkrida
zackkrida approved these changes Nov 22, 2022
View reviewed changes
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

Agreed with @obulat about the special handling of xs being confusing (I sadly don't remember why it's an exception, so documentation would be useful) but this LGTM.

@dhruvkb dhruvkb changed the title Make SCREEN_SIZES a Record instead of a Map Refactor SCREEN_SIZES to match z-indices.js Nov 22, 2022
@dhruvkb dhruvkb merged commit 0c1caa0 into main Nov 22, 2022
@dhruvkb dhruvkb deleted the screens_cleanup branch November 22, 2022 08:56
github-actions bot pushed a commit that referenced this pull request Nov 22, 2022
@openverse-bot
Clean preview for PR #1985
8d0797c
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@zackkrida zackkrida zackkrida approved these changes

@obulat obulat obulat approved these changes

Assignees
No one assigned
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dhruvkb @zackkrida @obulat