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

Use a modal for external sources on mobile #2078

Merged
merged 10 commits into from
Feb 1, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Dec 30, 2022

Fixes

Fixes #734 by @panchovm

Description

This PR uses a modal for mobile external sources. To make this possible, it also adds another modal variant that is always centered and fits the content.
If the external sources button focus ring is incorrect, it will be fixed in a separate PR that will fix buttons focus rings.

Testing Instructions

Search for something and scroll down to see the external sources form. When you're on a mobile screen, you should see a modal if you click on the External sources button.

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.

@obulat obulat requested a review from a team as a code owner December 30, 2022 12:51
@openverse-bot openverse-bot added this to Needs review in Openverse PRs Dec 30, 2022
@github-actions
Copy link

github-actions bot commented Dec 30, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/2078
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/2078/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: medium Not blocking but should be addressed soon labels Dec 30, 2022
@github-actions
Copy link

github-actions bot commented Dec 30, 2022

Size Change: +385 B (0%)

Total Size: 901 kB

Filename Size Change
./.nuxt/dist/client/236.js 0 B -272 B (removed) 🏆
./.nuxt/dist/client/236.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/237.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 149 kB -136 B (0%)
./.nuxt/dist/client/app.modern.js 124 kB -188 B (0%)
./.nuxt/dist/client/commons/app.modern.js 77.4 kB -11 B (0%)
./.nuxt/dist/client/components/v-external-search-form.js 2.06 kB +344 B (+20%) 🚨
./.nuxt/dist/client/components/v-external-search-form.modern.js 2.05 kB +329 B (+19%) ⚠️
./.nuxt/dist/client/components/v-external-source-list.js 900 B -245 B (-21%) 🎉
./.nuxt/dist/client/components/v-external-source-list.modern.js 898 B -246 B (-22%) 🎉
./.nuxt/dist/client/components/v-search-grid.js 5.87 kB +329 B (+6%) 🔍
./.nuxt/dist/client/components/v-search-grid.modern.js 5.8 kB +304 B (+6%) 🔍
./.nuxt/dist/client/components/v-sources-table.js 16.5 kB -32 B (0%)
./.nuxt/dist/client/components/v-sources-table.modern.js 16.6 kB -32 B (0%)
./.nuxt/dist/client/runtime.js 2.72 kB -16 B (-1%)
./.nuxt/dist/client/runtime.modern.js 2.72 kB -16 B (-1%)
./.nuxt/dist/client/233.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/233.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/234.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/commons/app.js 86.7 kB -6 B (0%)
./.nuxt/dist/client/components/loading-icon.js 746 B 0 B
./.nuxt/dist/client/components/loading-icon.modern.js 751 B 0 B
./.nuxt/dist/client/components/table-sort-icon.js 508 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 7.49 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 361 B 0 B
./.nuxt/dist/client/components/v-audio-details.js 2.54 kB 0 B
./.nuxt/dist/client/components/v-audio-details.modern.js 1.78 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.02 kB 0 B
./.nuxt/dist/client/components/v-audio-track.js 5.21 kB 0 B
./.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 538 B 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 543 B 0 B
./.nuxt/dist/client/components/v-bone.js 684 B 0 B
./.nuxt/dist/client/components/v-bone.modern.js 688 B 0 B
./.nuxt/dist/client/components/v-box-layout.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-box-layout.modern.js 1.23 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 776 B 0 B
./.nuxt/dist/client/components/v-content-report-button.modern.js 781 B 0 B
./.nuxt/dist/client/components/v-content-report-form.js 6.09 kB 0 B
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.58 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.23 kB 0 B
./.nuxt/dist/client/components/v-copy-button.js 3.99 kB 0 B
./.nuxt/dist/client/components/v-copy-button.modern.js 3.99 kB 0 B
./.nuxt/dist/client/components/v-copy-license.js 1 kB 0 B
./.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/d219393b.js 9.88 kB 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.modern.js 9.86 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 749 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 752 B 0 B
./.nuxt/dist/client/components/v-error-image.js 1.69 kB 0 B
./.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-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.62 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB 0 B
./.nuxt/dist/client/components/v-home-gallery.js 4.79 kB 0 B
./.nuxt/dist/client/components/v-home-gallery.modern.js 4.79 kB 0 B
./.nuxt/dist/client/components/v-homepage-content.js 1.73 kB -1 B (0%)
./.nuxt/dist/client/components/v-homepage-content.modern.js 1.69 kB 0 B
./.nuxt/dist/client/components/v-image-carousel.js 4.76 kB 0 B
./.nuxt/dist/client/components/v-image-carousel.modern.js 4.74 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.js 993 B 0 B
./.nuxt/dist/client/components/v-image-cell-square.modern.js 996 B 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 2.15 kB 0 B
./.nuxt/dist/client/components/v-image-details.modern.js 1.42 kB 0 B
./.nuxt/dist/client/components/v-image-grid.js 4.88 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 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 3.16 kB 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 683 B 0 B
./.nuxt/dist/client/components/v-media-license.js 819 B 0 B
./.nuxt/dist/client/components/v-media-license.modern.js 828 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.62 kB 0 B
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-media-tag.js 428 B 0 B
./.nuxt/dist/client/components/v-media-tag.modern.js 434 B 0 B
./.nuxt/dist/client/components/v-no-results.js 751 B 0 B
./.nuxt/dist/client/components/v-no-results.modern.js 751 B 0 B
./.nuxt/dist/client/components/v-old-homepage-content.js 1.88 kB +1 B (0%)
./.nuxt/dist/client/components/v-old-homepage-content.modern.js 1.85 kB -2 B (0%)
./.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.25 kB 0 B
./.nuxt/dist/client/components/v-related-audio.modern.js 1.25 kB 0 B
./.nuxt/dist/client/components/v-related-images.js 1.05 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 965 B 0 B
./.nuxt/dist/client/components/v-report-desc-form.modern.js 969 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-results-title.js 595 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 598 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.js 791 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 299 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 3.37 kB 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 888 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-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 0 B
./.nuxt/dist/client/pages/about.modern.js 1.51 kB 0 B
./.nuxt/dist/client/pages/audio/_id/index.js 7.96 kB 0 B
./.nuxt/dist/client/pages/audio/_id/index.modern.js 4.79 kB -1 B (0%)
./.nuxt/dist/client/pages/external-sources.js 1.53 kB 0 B
./.nuxt/dist/client/pages/external-sources.modern.js 1.53 kB 0 B
./.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/index.js 9.26 kB +3 B (0%)
./.nuxt/dist/client/pages/image/_id/index.modern.js 7.33 kB 0 B
./.nuxt/dist/client/pages/image/_id/report.js 3.6 kB +1 B (0%)
./.nuxt/dist/client/pages/image/_id/report.modern.js 4.2 kB 0 B
./.nuxt/dist/client/pages/index.js 8.63 kB +1 B (0%)
./.nuxt/dist/client/pages/index.modern.js 8.52 kB 0 B
./.nuxt/dist/client/pages/preferences.js 1.22 kB 0 B
./.nuxt/dist/client/pages/preferences.modern.js 1.21 kB +2 B (0%)
./.nuxt/dist/client/pages/privacy.js 983 B 0 B
./.nuxt/dist/client/pages/privacy.modern.js 983 B 0 B
./.nuxt/dist/client/pages/search-help.js 1.61 kB 0 B
./.nuxt/dist/client/pages/search-help.modern.js 1.61 kB 0 B
./.nuxt/dist/client/pages/search.js 5.1 kB +3 B (0%)
./.nuxt/dist/client/pages/search.modern.js 2.6 kB 0 B
./.nuxt/dist/client/pages/search/audio.js 6.14 kB +2 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 3.65 kB +1 B (0%)
./.nuxt/dist/client/pages/search/image.js 660 B +1 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.73 kB 0 B
./.nuxt/dist/client/pages/search/index.js 542 B -1 B (0%)
./.nuxt/dist/client/pages/search/index.modern.js 547 B 0 B
./.nuxt/dist/client/pages/search/model-3d.js 244 B +1 B (0%)
./.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.js 266 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.modern.js 270 B -1 B (0%)
./.nuxt/dist/client/pages/search/video.js 240 B 0 B
./.nuxt/dist/client/pages/search/video.modern.js 243 B -1 B (0%)
./.nuxt/dist/client/pages/sources.js 1.55 kB 0 B
./.nuxt/dist/client/pages/sources.modern.js 1.54 kB -1 B (0%)
./.nuxt/dist/client/vendors/app.js 63.7 kB -1 B (0%)
./.nuxt/dist/client/vendors/app.modern.js 62.9 kB 0 B

compressed-size-action

@obulat obulat force-pushed the use_modal_for_external_search_on_mobile branch from 67a2072 to 6c3ff7a Compare January 3, 2023 16:36
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.

This is not rendering properly for me.

@obulat
Copy link
Contributor Author

obulat commented Jan 6, 2023

This is not rendering properly for me.

This PR is for external sources under the search results. I've added the screenshot to the PR description.
The external sources buttons on the "No results" page are handled in #2077.

@zackkrida
Copy link
Member

@panchovm could you review this for design?

@fcoveram
Copy link

The overall implementation looks good, but I think it is based on an old mockup version. The spacings and buttons are from depracated components of the Design Library, so it is my duty to bring up an updated solution.

Despite the design comment, I noticed an unintentional zoom-in bug. Put attention in the background of this screen recording

CleanShot.2023-01-12.at.18.34.39.mp4

Should I share a design ticket with an updated version of this modal or share the mockup here? The three improvement aspects are modal width, popover item, and text styles.

@openverse-bot
Copy link
Contributor

Based on the medium urgency of this PR, the following reviewers are being gently reminded to review this PR:

@panchovm
@zackkrida
@dhruvkb
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was updated 4 day(s) ago. PRs labelled with medium urgency are expected to be reviewed within 4 weekday(s)2.

@obulat, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

@obulat obulat force-pushed the use_modal_for_external_search_on_mobile branch 2 times, most recently from 6ced6a4 to 7c75b4a Compare January 31, 2023 11:19
Copy link

@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.

It works great ✨

I need to revisit the modal design as some styles applied are old, but that doesn't block this progress and will be tacked in a design issue.

@zackkrida
Copy link
Member

@obulat I'm noticing one peculiarity in this PR, if I resize my browser to a mobile width I'm no longer able to scroll the page. Could merging in the recent changes to main fix this?

@obulat obulat force-pushed the use_modal_for_external_search_on_mobile branch from 7c75b4a to 03bf85e Compare February 1, 2023 04:38
@github-actions
Copy link

github-actions bot commented Feb 1, 2023

Playwright Failure Test Results

It looks like some of the Playwright tests failed. You can download the Playwright trace
output for both Storybook and Nuxt Playwright tests that have failed at the bottom of this
page, under the "Artifacts" section:

https://github.com/WordPress/openverse-frontend/actions/runs/4061257032

Read more about how to use this artifact here: https://github.com/WordPress/openverse-frontend/blob/main/test/playwright/README.md#debugging

@obulat
Copy link
Contributor Author

obulat commented Feb 1, 2023

@obulat I'm noticing one peculiarity in this PR, if I resize my browser to a mobile width I'm no longer able to scroll the page. Could merging in the recent changes to main fix this?

Were you resizing the browser to mobile width when the external sources popover is open or closed?
I rebased the PR, and I think the scroll lock works correctly now.

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.

Works perfectly now, lgtm!

Openverse PRs automation moved this from Needs review to Reviewer approved Feb 1, 2023
@obulat obulat merged commit 4fbfe92 into main Feb 1, 2023
Openverse PRs automation moved this from Reviewer approved to Merged! Feb 1, 2023
@obulat obulat deleted the use_modal_for_external_search_on_mobile branch February 1, 2023 13:09
github-actions bot pushed a commit that referenced this pull request Feb 1, 2023
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: medium Not blocking but should be addressed soon
Projects
No open projects
Openverse PRs
  
Merged!
Development

Successfully merging this pull request may close these issues.

Update the meta search section with the new design
5 participants