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

Fix design mismatch in VMediaLicense #2025

Merged
merged 12 commits into from
Dec 5, 2022
Merged

Fix design mismatch in VMediaLicense #2025

merged 12 commits into from
Dec 5, 2022

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Dec 1, 2022

Fixes

Fixes #764 by @krysal

Description

This PR

  • fixes the margins and spacings in the component to match the desktop and mobile mockups
  • moves the full name logic into the VMediaLicense component as it's more relevant there instead of VMediaReuse
  • removes the .uppercase class to prevent 'CC Sampling+' from being rendered as 'CC SAMPLING+'
  • adds missing stories
  • adds tests for both a desktop and a mobile breakpoint
  • prevents changes in other usages of VLicenseElements such as license explanations in the filter sidebar

Concern

Since there are no mockups for CC0 or PDM, the design for it looks different from the regular licenses and falls into dangerously into undefined UI terrority, notably the bold "Read more about the tool here" text that's not present in other licenses.

I've left a comment for @panchovm in Figma too and we can update the component (hopefully in a separate issue and PR) if changes are needed.

Testing Instructions

Compare the mockups linked in the issue against the updated components. You should see the spacings and dimensions in the UI match the mockups.

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 requested a review from a team as a code owner December 1, 2022 20:08
@dhruvkb dhruvkb requested review from zackkrida and obulat December 1, 2022 20:08
@github-actions
Copy link

github-actions bot commented Dec 1, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/2025
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/2025/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.

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

github-actions bot commented Dec 1, 2022

Size Change: -3.29 kB (0%)

Total Size: 807 kB

Filename Size Change
./.nuxt/dist/client/165.js 0 B -273 B (removed) 🏆
./.nuxt/dist/client/165.modern.js 0 B -278 B (removed) 🏆
./.nuxt/dist/client/166.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 121 kB -1.61 kB (-1%)
./.nuxt/dist/client/app.modern.js 112 kB -1.57 kB (-1%)
./.nuxt/dist/client/components/v-media-license.js 820 B +19 B (+2%)
./.nuxt/dist/client/components/v-media-license.modern.js 828 B +18 B (+2%)
./.nuxt/dist/client/runtime.js 2.29 kB -64 B (-3%)
./.nuxt/dist/client/runtime.modern.js 2.29 kB -65 B (-3%)
./.nuxt/dist/client/152.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/152.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/153.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/commons/app.js 88.1 kB +6 B (0%)
./.nuxt/dist/client/commons/app.modern.js 77 kB +5 B (0%)
./.nuxt/dist/client/components/loading-icon.js 745 B 0 B
./.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.js 5.14 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid.modern.js 5.01 kB 0 B
./.nuxt/dist/client/components/v-audio-cell.js 357 B 0 B
./.nuxt/dist/client/components/v-audio-cell.modern.js 360 B 0 B
./.nuxt/dist/client/components/v-audio-details.js 1.81 kB -2 B (0%)
./.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 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.01 kB 0 B
./.nuxt/dist/client/components/v-audio-track.js 5.21 kB -3 B (0%)
./.nuxt/dist/client/components/v-audio-track.modern.js 5.16 kB 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.js 540 B 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 544 B 0 B
./.nuxt/dist/client/components/v-bone.js 684 B 0 B
./.nuxt/dist/client/components/v-bone.modern.js 689 B 0 B
./.nuxt/dist/client/components/v-box-layout.js 1.2 kB 0 B
./.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 0 B
./.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 779 B 0 B
./.nuxt/dist/client/components/v-content-report-button.modern.js 782 B 0 B
./.nuxt/dist/client/components/v-content-report-form.js 3.75 kB 0 B
./.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 -1 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 0 B
./.nuxt/dist/client/components/v-copy-button.modern.js 4 kB 0 B
./.nuxt/dist/client/components/v-copy-license.js 1 kB 0 B
./.nuxt/dist/client/components/v-copy-license.modern.js 999 B 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.86 kB 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.modern.js 9.83 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 747 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 754 B 0 B
./.nuxt/dist/client/components/v-error-image.js 1.69 kB -1 B (0%)
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB 0 B
./.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 -2 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.55 kB -1 B (0%)
./.nuxt/dist/client/components/v-external-source-list.modern.js 2.52 kB 0 B
./.nuxt/dist/client/components/v-full-layout.js 1.59 kB 0 B
./.nuxt/dist/client/components/v-full-layout.modern.js 1.59 kB 0 B
./.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 0 B
./.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 0 B
./.nuxt/dist/client/components/v-image-grid.modern.js 2.42 kB 0 B
./.nuxt/dist/client/components/v-license-tab-panel.js 522 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 789 B 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 683 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.62 kB -3 B (0%)
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.61 kB -1 B (0%)
./.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 -2 B (0%)
./.nuxt/dist/client/components/v-no-results.modern.js 2.72 kB 0 B
./.nuxt/dist/client/components/v-radio.js 1.51 kB 0 B
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB 0 B
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-related-audio.modern.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-related-images.js 3.1 kB 0 B
./.nuxt/dist/client/components/v-related-images.modern.js 2.98 kB 0 B
./.nuxt/dist/client/components/v-report-desc-form.js 966 B 0 B
./.nuxt/dist/client/components/v-report-desc-form.modern.js 963 B 0 B
./.nuxt/dist/client/components/v-row-layout.js 1.7 kB 0 B
./.nuxt/dist/client/components/v-row-layout.modern.js 1.71 kB 0 B
./.nuxt/dist/client/components/v-scroll-button.js 813 B 0 B
./.nuxt/dist/client/components/v-scroll-button.modern.js 819 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 0 B
./.nuxt/dist/client/components/v-search-results-title.js 657 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 653 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.js 793 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.modern.js 769 B 0 B
./.nuxt/dist/client/components/v-server-timeout.js 298 B 0 B
./.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 998 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 895 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.js 887 B 0 B
./.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 0 B
./.nuxt/dist/client/components/v-snackbar.modern.js 1.19 kB 0 B
./.nuxt/dist/client/components/v-sources-table.js 15.7 kB 0 B
./.nuxt/dist/client/components/v-sources-table.modern.js 15.8 kB 0 B
./.nuxt/dist/client/components/v-warning-suppressor.js 299 B 0 B
./.nuxt/dist/client/components/v-warning-suppressor.modern.js 303 B 0 B
./.nuxt/dist/client/pages/about.js 1.51 kB -1 B (0%)
./.nuxt/dist/client/pages/about.modern.js 1.51 kB 0 B
./.nuxt/dist/client/pages/audio/_id.js 4.95 kB -9 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 4.78 kB -2 B (0%)
./.nuxt/dist/client/pages/external-sources.js 1.52 kB 0 B
./.nuxt/dist/client/pages/external-sources.modern.js 1.53 kB +1 B (0%)
./.nuxt/dist/client/pages/feedback.js 1.31 kB 0 B
./.nuxt/dist/client/pages/feedback.modern.js 1.31 kB 0 B
./.nuxt/dist/client/pages/image/_id.js 5.34 kB +3 B (0%)
./.nuxt/dist/client/pages/image/_id.modern.js 7.34 kB 0 B
./.nuxt/dist/client/pages/index.js 5.14 kB -1 B (0%)
./.nuxt/dist/client/pages/index.modern.js 5 kB +2 B (0%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB 0 B
./.nuxt/dist/client/pages/preferences.modern.js 1.21 kB +2 B (0%)
./.nuxt/dist/client/pages/privacy.js 980 B 0 B
./.nuxt/dist/client/pages/privacy.modern.js 982 B -1 B (0%)
./.nuxt/dist/client/pages/search-help.js 1.62 kB 0 B
./.nuxt/dist/client/pages/search-help.modern.js 1.62 kB 0 B
./.nuxt/dist/client/pages/search.js 2.71 kB 0 B
./.nuxt/dist/client/pages/search.modern.js 2.56 kB 0 B
./.nuxt/dist/client/pages/search/audio.js 3.75 kB +1 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 3.65 kB -2 B (0%)
./.nuxt/dist/client/pages/search/image.js 2.85 kB 0 B
./.nuxt/dist/client/pages/search/image.modern.js 2.73 kB -1 B (0%)
./.nuxt/dist/client/pages/search/index.js 543 B 0 B
./.nuxt/dist/client/pages/search/index.modern.js 548 B -1 B (0%)
./.nuxt/dist/client/pages/search/model-3d.js 243 B +1 B (0%)
./.nuxt/dist/client/pages/search/model-3d.modern.js 246 B -1 B (0%)
./.nuxt/dist/client/pages/search/search-page.types.js 265 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B +1 B (0%)
./.nuxt/dist/client/pages/search/video.js 240 B +1 B (0%)
./.nuxt/dist/client/pages/search/video.modern.js 243 B 0 B
./.nuxt/dist/client/pages/sources.js 1.51 kB 0 B
./.nuxt/dist/client/pages/sources.modern.js 1.51 kB 0 B
./.nuxt/dist/client/vendors/app.js 62.6 kB -2 B (0%)
./.nuxt/dist/client/vendors/app.modern.js 62.1 kB +1 B (0%)

compressed-size-action

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.

LGTM! I compared to the mockups and this is a fantastic improvement.

@fcoveram
Copy link

fcoveram commented Dec 2, 2022

The component does exist in the Design Library's License page. The element missed is the link to see the license details.

I like the Read more sentence as a solution, but I would follow the popover design instead. The popover shows a "See more about the license" and the style is regular instead of bold.

CleanShot 2022-12-02 at 16 46 36@2x

On the other hand, I noticed an odd gap between the license item and the read more sentence. The spacing is 16px, but there is a strange white space in between, marked in red in the screenshot below.

@dhruvkb
Copy link
Member Author

dhruvkb commented Dec 3, 2022

@obulat using uiStore with Storybook seemed not to work because those components are not wrapped inside the layouts which update the UI store when the width changes.

I added a Storybook decorator to enable that in f42aa9c. Hopefully this decorator should allow us to test more components that use UI store inside Storybook.

@dhruvkb dhruvkb force-pushed the license_design branch 2 times, most recently from 2c68133 to 7721d12 Compare December 3, 2022 09:25
@dhruvkb dhruvkb requested a review from obulat December 3, 2022 09:47
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 love the Storybook helper :) The license icons look correct to me.

@dhruvkb dhruvkb merged commit fcd4d0a into main Dec 5, 2022
@dhruvkb dhruvkb deleted the license_design branch December 5, 2022 16:44
github-actions bot pushed a commit that referenced this pull request Dec 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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
Development

Successfully merging this pull request may close these issues.

Update LicenseElements according to the new design
5 participants