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

Update banner spacing and add rounded corners #2117

Merged
merged 7 commits into from
May 19, 2023
Merged

Conversation

zackkrida
Copy link
Member

@zackkrida zackkrida commented May 17, 2023

Fixes

Related to #2015 by @zackkrida

Description

Updates the banner styles to have padding and rounded edges.

Testing Instructions

Check out some localhost page(s) with banners, like:

localhost:8443/ar?referrer=creativecommons.org
localhost:8443/search-help?referrer=creativecommons.org

CleanShot 2023-05-16 at 19 56 26@2x CleanShot 2023-05-16 at 19 56 01@2x

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 (if 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.

@zackkrida zackkrida requested a review from a team as a code owner May 17, 2023 00:18
@zackkrida zackkrida requested review from AetherUnbound and obulat May 17, 2023 00:18
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label May 17, 2023
@zackkrida zackkrida added 🟧 priority: high Stalls work on the project or its dependents ✨ goal: improvement Improvement to an existing user-facing feature 🖼️ aspect: design Concerns related to design labels May 17, 2023
@zackkrida zackkrida requested review from fcoveram and dhruvkb and removed request for AetherUnbound and obulat May 17, 2023 00:20
@github-actions
Copy link

github-actions bot commented May 17, 2023

Size Change: -6.82 kB (-1%)

Total Size: 834 kB

Filename Size Change
./frontend/.nuxt/dist/client/234.js 1.85 kB +1.58 kB (+581%) 🆘
./frontend/.nuxt/dist/client/234.modern.js 0 B -277 B (removed) 🏆
./frontend/.nuxt/dist/client/235.js 0 B -1.85 kB (removed) 🏆
./frontend/.nuxt/dist/client/app.js 127 kB +47 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 118 kB -22 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 5.75 kB -12 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.62 kB -22 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.26 kB +10 B (0%)
./frontend/.nuxt/dist/client/components/v-content-link.js 1.04 kB -51 B (-5%)
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.04 kB -56 B (-5%)
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.09 kB +960 B (+85%) 🆘
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.06 kB +927 B (+82%) 🆘
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.js 0 B -10 kB (removed) 🏆
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.modern.js 0 B -10 kB (removed) 🏆
./frontend/.nuxt/dist/client/components/v-error-image.js 2.6 kB +909 B (+54%) 🆘
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.57 kB +883 B (+52%) 🆘
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.68 kB +62 B (+4%)
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.67 kB +64 B (+4%)
./frontend/.nuxt/dist/client/components/v-image-grid.js 3.91 kB +47 B (+1%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 3.79 kB +46 B (+1%)
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.69 kB +950 B (+55%) 🆘
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.65 kB +913 B (+53%) 🆘
./frontend/.nuxt/dist/client/components/v-no-results.js 814 B -10 B (-1%)
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.55 kB +880 B (+16%) ⚠️
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.47 kB +852 B (+15%) ⚠️
./frontend/.nuxt/dist/client/components/v-sources-table.js 15.2 kB -22 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 15.2 kB -18 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.52 kB +890 B (+16%) ⚠️
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 5.9 kB +860 B (+17%) ⚠️
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.46 kB +884 B (+13%) ⚠️
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 6.77 kB +847 B (+14%) ⚠️
./frontend/.nuxt/dist/client/pages/image/_id/report.js 2.23 kB +966 B (+76%) 🆘
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 5.21 kB +861 B (+20%) 🚨
./frontend/.nuxt/dist/client/pages/preferences.js 1.3 kB -20 B (-2%)
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.3 kB -21 B (-2%)
./frontend/.nuxt/dist/client/pages/privacy.js 1.23 kB +223 B (+22%) 🚨
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.24 kB +222 B (+22%) 🚨
./frontend/.nuxt/dist/client/runtime.js 2.69 kB -30 B (-1%)
./frontend/.nuxt/dist/client/runtime.modern.js 2.69 kB -31 B (-1%)
./frontend/.nuxt/dist/client/vendors/app.js 64.6 kB +11 B (0%)
./frontend/.nuxt/dist/client/vendors/app.modern.js 63.9 kB +215 B (0%)
./frontend/.nuxt/dist/client/233.js 272 B +272 B (new file) 🆕
./frontend/.nuxt/dist/client/233.modern.js 277 B +277 B (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/commons/app.js 90.4 kB -7 B (0%)
./frontend/.nuxt/dist/client/commons/app.modern.js 78.5 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.js 766 B +1 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 769 B +1 B (0%)
./frontend/.nuxt/dist/client/components/table-sort-icon.js 514 B 0 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 519 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.js 392 B +2 B (+1%)
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 396 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.js 2.35 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.77 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.21 kB +8 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 636 B 0 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 642 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.js 688 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-bone.modern.js 692 B 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.28 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.27 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-page.js 524 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 528 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 493 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 497 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.86 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.69 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 914 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 4.15 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.js 4 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 791 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 799 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 375 B 0 B
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.88 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.87 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.js 893 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 897 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.56 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.55 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.92 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.9 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.77 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.74 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.74 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.7 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.js 1.96 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.41 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 641 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 649 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.js 846 B +2 B (0%)
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 740 B -2 B (0%)
./frontend/.nuxt/dist/client/components/v-media-license.js 828 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 836 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B 0 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 421 B 0 B
./frontend/.nuxt/dist/client/components/v-modal.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-modal.modern.js 995 B 0 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 816 B -9 B (-1%)
./frontend/.nuxt/dist/client/components/v-radio.js 1.54 kB 0 B
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.5 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.29 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.29 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-images.js 1.1 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 1.1 kB 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 977 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 979 B 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.68 kB 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.68 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-scroll-button.js 824 B 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 829 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.js 618 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 622 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 299 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.01 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 912 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.16 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.17 kB 0 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B 0 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B 0 B
./frontend/.nuxt/dist/client/pages/about.js 1.39 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB 0 B
./frontend/.nuxt/dist/client/pages/external-sources.js 1.55 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.56 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.js 1.34 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB 0 B
./frontend/.nuxt/dist/client/pages/index.js 7.03 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 6.96 kB 0 B
./frontend/.nuxt/dist/client/pages/search-help.js 1.59 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.58 kB 0 B
./frontend/.nuxt/dist/client/pages/search.js 2.2 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.js 3.69 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.58 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.js 545 B 0 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 550 B +2 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.js 443 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.modern.js 446 B -2 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.js 266 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.js 240 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 243 B 0 B
./frontend/.nuxt/dist/client/pages/sources.js 1.51 kB 0 B
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.51 kB 0 B

compressed-size-action

@fcoveram
Copy link
Contributor

Here is an idea: One alert banner with four variants, and one customized banner.

Screenshot of two Figma components: Alert and customized banner

The alert banner has four variants (Info, Warning, Success, Error) and the customized banner is in dark charcoal and allows changing the icon as in the former types.

These two banners are due to having yellow and white backgrounds, and since Openverse is mostly white, I prioritized a style without border color and rely on icon taxonomy to convey the banner's purpose. In that vein, the color contrast requirement is met between icon and banner background color.

Our current case shows banners in the homepage, but I think we can address cases like Openverse is not working correctly. See the right side of the image below.

image

Reaching consistency is hard as the component needs to work over two different backgrounds, but if we use the customized dark banner for some cases, we can handle the alerts confidently.


What do you think of this idea? Pinging @dhruvkb for visibility

@zackkrida
Copy link
Member Author

@fcoveram this PR was only focused on the spacing and rounded corners you mentioned previously, but I love your designs for an alert system! That would also require very little work—it is only a matter of small styling adjustments. Could you move those designs to their own issue for additional discussion?

@dhruvkb
Copy link
Member

dhruvkb commented May 17, 2023

I like the alerts, but that would increase the scope of the PR considerably. It would be best to spin it out into its own issue.

@fcoveram
Copy link
Contributor

Sorry for extending the PR scope, last comments in #2015 mention style specs and that's what the design shared is about.

Putting aside the alert variants, the style specs for the dark banner are:

Small (for xs, sm, md)

  • Height: auto
  • Text: "Caption regular" style
  • Info icon in 24px size
  • Close icon in 24px size
  • Padding: 12px for top and bottom; 8px for left and right
  • Margin: 8px for top, left, and right. Margin bottom is 0.
  • Gap between icons and texts: 8px.
  • Gap between banners: 8px.
  • Close action and link do not have hover style

Large (for lg, xl, 2xl)

  • Height: auto
  • Text: "Paragraph small" style
  • Info icon in 24px size
  • Close icon in 24px size
  • Padding: 16px for all sides.
  • Margin: 8px for top, left, and right. Margin bottom is 0.
  • Gap between icons and texts: 8px.
  • Gap between banners: 8px.
  • Close action and link do not have hover style

Here is the Figma file where mockups for all breakpoints are. The banner doesn't exist in the Design Library yet.

@zackkrida
Copy link
Member Author

Thanks, @fcoveram! This PR now uses 8px for the banner gap and top/side margins and is ready for review. We'll implement the dark banner styles and/or the alert styles in a separate PR.

Copy link
Contributor

@fcoveram fcoveram left a comment

Choose a reason for hiding this comment

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

The changes applied look correct 👍

@zackkrida zackkrida changed the title Update banner styles Update banner spacing and add rounded corners May 19, 2023
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

LGTM, tested extensively and couldn't find any problems except for a known issue #1159 with a prepared fix #2128.

@zackkrida zackkrida merged commit 5988b06 into main May 19, 2023
@zackkrida zackkrida deleted the banner-style-refresh branch May 19, 2023 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🖼️ aspect: design Concerns related to design ✨ 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.

3 participants