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

Hide the recent searches when navigating with the keyboard #1889

Merged
merged 6 commits into from
Oct 11, 2022
Merged

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Oct 7, 2022

Fixes

Fixes #1886 by @zackkrida

Description

This PR hides the recent searches when the keyboard focus moves past the 'Clear' button in the recent searches dropdown.

Testing Instructions

  1. Check out the PR and run the dev server.
  2. Repeatedly press Tab.

Screenshots

Screen.Recording.2022-10-07.at.8.48.12.AM.mov

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 October 7, 2022 04:55
@dhruvkb dhruvkb requested review from zackkrida and obulat October 7, 2022 04:55
@github-actions
Copy link

github-actions bot commented Oct 7, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1889
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1889/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 🕹 aspect: interface Concerns end-users' experience with the software 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents labels Oct 7, 2022
@github-actions
Copy link

github-actions bot commented Oct 7, 2022

Size Change: -2.52 kB (0%)

Total Size: 820 kB

Filename Size Change
./.nuxt/dist/client/231.js 0 B -272 B (removed) 🏆
./.nuxt/dist/client/231.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/232.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 134 kB -1.24 kB (-1%)
./.nuxt/dist/client/app.modern.js 125 kB -1.21 kB (-1%)
./.nuxt/dist/client/pages/index.js 5.05 kB +34 B (+1%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB -11 B (-1%)
./.nuxt/dist/client/runtime.js 2.65 kB -58 B (-2%)
./.nuxt/dist/client/runtime.modern.js 2.65 kB -57 B (-2%)
./.nuxt/dist/client/220.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/220.modern.js 276 B +276 B (new file) 🆕
./.nuxt/dist/client/221.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/commons/app.js 88.2 kB 0 B
./.nuxt/dist/client/commons/app.modern.js 77 kB 0 B
./.nuxt/dist/client/components/loading-icon.js 745 B 0 B
./.nuxt/dist/client/components/loading-icon.modern.js 749 B 0 B
./.nuxt/dist/client/components/table-sort-icon.js 509 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 514 B 0 B
./.nuxt/dist/client/components/v-all-results-grid.js 2.75 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid.modern.js 2.73 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.js 3.01 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.modern.js 2.92 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.82 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 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.11 kB 0 B
./.nuxt/dist/client/components/v-audio-track.modern.js 5.06 kB 0 B
./.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 542 B 0 B
./.nuxt/dist/client/components/v-bone.js 685 B 0 B
./.nuxt/dist/client/components/v-bone.modern.js 690 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 778 B 0 B
./.nuxt/dist/client/components/v-content-report-button.modern.js 784 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.43 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.24 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 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/09090664.js 9.48 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.45 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 749 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 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-external-search-form.js 3.11 kB 0 B
./.nuxt/dist/client/components/v-external-search-form.modern.js 3.09 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.js 2.57 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.modern.js 2.54 kB 0 B
./.nuxt/dist/client/components/v-full-layout.js 1.48 kB 0 B
./.nuxt/dist/client/components/v-full-layout.modern.js 1.48 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.js 1.6 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.01 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.43 kB 0 B
./.nuxt/dist/client/components/v-image-grid.js 2.53 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 524 B 0 B
./.nuxt/dist/client/components/v-load-more.js 788 B 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 683 B 0 B
./.nuxt/dist/client/components/v-media-license.js 799 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.63 kB 0 B
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.62 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.77 kB 0 B
./.nuxt/dist/client/components/v-no-results.modern.js 2.74 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.97 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 965 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.7 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.45 kB 0 B
./.nuxt/dist/client/components/v-search-grid.modern.js 5.41 kB 0 B
./.nuxt/dist/client/components/v-search-results-title.js 658 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 651 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 771 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 997 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 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 893 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.7 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.06 kB -1 B (0%)
./.nuxt/dist/client/pages/about.modern.js 1.07 kB 0 B
./.nuxt/dist/client/pages/audio/_id.js 4.9 kB +3 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 4.73 kB 0 B
./.nuxt/dist/client/pages/external-sources.js 1.45 kB +5 B (0%)
./.nuxt/dist/client/pages/external-sources.modern.js 1.45 kB 0 B
./.nuxt/dist/client/pages/feedback.js 1.24 kB +2 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 1.24 kB +1 B (0%)
./.nuxt/dist/client/pages/image/_id.js 5.28 kB 0 B
./.nuxt/dist/client/pages/image/_id.modern.js 7.22 kB -1 B (0%)
./.nuxt/dist/client/pages/index.modern.js 4.91 kB 0 B
./.nuxt/dist/client/pages/preferences.modern.js 1.21 kB 0 B
./.nuxt/dist/client/pages/search-help.js 1.55 kB 0 B
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB 0 B
./.nuxt/dist/client/pages/search.js 2.75 kB 0 B
./.nuxt/dist/client/pages/search.modern.js 2.6 kB 0 B
./.nuxt/dist/client/pages/search/audio.js 1.19 kB -3 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 1.2 kB 0 B
./.nuxt/dist/client/pages/search/image.js 2.79 kB +5 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.67 kB +1 B (0%)
./.nuxt/dist/client/pages/search/index.js 2.96 kB +8 B (0%)
./.nuxt/dist/client/pages/search/index.modern.js 2.94 kB -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 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 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.44 kB -1 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB 0 B
./.nuxt/dist/client/vendors/app.js 57.2 kB 0 B
./.nuxt/dist/client/vendors/app.modern.js 56.5 kB 0 B

compressed-size-action

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.

This solves the happy path problem, and I really love the size of this PR :)

One issue I found is if you navigate to the 'Clear' button, press Enter while on it, and then press Tab again, the recent searches does not close.

We could add a 'Tab' keydown handler to the Search Button and close the Recent searches if they are open.

@dhruvkb
Copy link
Member Author

dhruvkb commented Oct 10, 2022

@obulat since the Recent searches dialog come after the Search button in the tab order, if we always hid the recent searches when Tab is pressed on the Search button, the Clear button would become unreachable. So in f6d01f6 I've set the Search button Tab handler to only hide Recent searches if there are 0 entries.

@dhruvkb dhruvkb requested a review from obulat October 10, 2022 14:01
@obulat
Copy link
Contributor

obulat commented Oct 10, 2022

@obulat since the Recent searches dialog come after the Search button in the tab order, if we always hid the recent searches when Tab is pressed on the Search button, the Clear button would become unreachable. So in f6d01f6 I've set the Search button Tab handler to only hide Recent searches if there are 0 entries.

I knew there was a caveat! 😆

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.

There's one more problem: if you click 'Clear', and then press 'Tab', you don't get to go to the Search button, and you don't trigger the Recent searches Tab handler (why?), so the popup remains open:

Recent.tab.mov

@dhruvkb
Copy link
Member Author

dhruvkb commented Oct 10, 2022

Should we immediately hide the popup when the 'Clear' button is pressed? That would fix this case.

@obulat
Copy link
Contributor

obulat commented Oct 10, 2022

Should we immediately hide the popup when the 'Clear' button is pressed? That would fix this case.

I wonder if hiding it after a short delay is better? This way, the users are not surprised when it is closed immediately, and might even have time to see that the list was emptied and that is why the popup closed?

@zackkrida
Copy link
Member

Alternatively, should the clear button remain visible, but disabled, so it can still hold focus? The timing-based approach sounds good but like it could introduce some confusion or further complexity.

@obulat
Copy link
Contributor

obulat commented Oct 11, 2022

What if we focus the input when clicking the 'Clear' button? Then the user can 1. start typing the new value right away or 2. tab away and close the popover.

diff --git a/src/components/VHeader/VSearchBar/VSearchBar.vue b/src/components/VHeader/VSearchBar/VSearchBar.vue
index c962ca78f9..b6cf421aa6 100644
--- a/src/components/VHeader/VSearchBar/VSearchBar.vue
+++ b/src/components/VHeader/VSearchBar/VSearchBar.vue
@@ -6,6 +6,7 @@
       @submit.prevent="handleSearch"
     >
       <VInputField
+        ref="inputFieldRef"
         v-bind="$attrs"
         v-model="modelMedium"
         :placeholder="placeholder || $t('hero.search.placeholder')"
@@ -115,6 +116,7 @@ export default defineComponent({
   },
   setup(props, { emit }) {
     const searchBarEl = ref<HTMLElement | null>(null)
+    const inputFieldRef = ref<InstanceType<typeof VInputField> | null>(null)
 
     const { matches: isHomeRoute } = useMatchHomeRoute()
 
@@ -228,9 +230,11 @@ export default defineComponent({
     /* Clear all recent searches from the store. */
     const handleClear = () => {
       searchStore.clearRecentSearches()
+      inputFieldRef.value?.focusInput()
     }
 
     return {
+      inputFieldRef,
       searchBarEl,
 
       handleSearch,
diff --git a/src/components/VInputField/VInputField.vue b/src/components/VInputField/VInputField.vue
index 3137dd64b7..1325cef7f3 100644
--- a/src/components/VInputField/VInputField.vue
+++ b/src/components/VInputField/VInputField.vue
@@ -12,6 +12,7 @@
   >
     <input
       :id="fieldId"
+      ref="inputRef"
       v-bind="$attrs"
       :type="type"
       class="h-full w-full appearance-none rounded-none bg-tx text-2xl font-semibold leading-none placeholder-dark-charcoal-70 ms-4 focus:outline-none md:text-base"
@@ -27,9 +28,15 @@
 </template>
 
 <script lang="ts">
-import { computed, defineComponent, PropType } from '@nuxtjs/composition-api'
+import {
+  computed,
+  defineComponent,
+  PropType,
+  ref,
+} from '@nuxtjs/composition-api'
 
 import { defineEvent } from '~/types/emits'
+import { ensureFocus } from '~/utils/reakit-utils/focus'
 
 export const FIELD_SIZES = {
   small: 'h-10 text-md',
@@ -99,6 +106,8 @@ export default defineComponent({
     'update:modelValue': defineEvent<[string]>(),
   },
   setup(props, { emit, attrs }) {
+    const inputRef = ref<HTMLInputElement | null>(null)
+
     const type = typeof attrs['type'] === 'string' ? attrs['type'] : 'text'
 
     const updateModelValue = (event: Event) => {
@@ -106,12 +115,20 @@ export default defineComponent({
     }
     const sizeClass = computed(() => FIELD_SIZES[props.size])
 
+    const focusInput = () => {
+      if (inputRef.value) {
+        ensureFocus(inputRef.value)
+      }
+    }
+
     return {
+      inputRef,
       emit,
       type,
 
       sizeClass,
       updateModelValue,
+      focusInput,
     }
   },
 })

@dhruvkb
Copy link
Member Author

dhruvkb commented Oct 11, 2022

@obulat I tried your suggestion (almost verbatim, I realise now) and it works pretty well. The UX is pretty good and functionality-wise it does what one would expect. Thanks!

@dhruvkb dhruvkb requested a review from obulat October 11, 2022 11:26
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.

Works well! 👍
It needs rebasing / merge now that ClientOnly is merged.

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 but we also need to handle the case when tabbing backwards (to the Openverse logo), which currently keeps the popup open. A separate PR and issue is fine there.

@dhruvkb dhruvkb changed the title Hide the recent searches when the focus moves past the 'Clear' button Hide the recent searches when navigating with the keyboard Oct 11, 2022
@dhruvkb dhruvkb merged commit 7559155 into main Oct 11, 2022
@dhruvkb dhruvkb deleted the hide_recent branch October 11, 2022 20:18
github-actions bot pushed a commit that referenced this pull request Oct 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🕹 aspect: interface Concerns end-users' experience with the software 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recent searches combobox doesn't close when focus is lost
4 participants