Add keyboard navigation hook for universal search
Co-authored-by: cloud8421 <537608+cloud8421@users.noreply.github.com>
This commit is contained in:
committed by
Claudio Ortolina
parent
31f6eb0a4c
commit
df55065b32
@@ -24,12 +24,14 @@ import { hooks as colocatedHooks } from "phoenix-colocated/music_library";
|
|||||||
import topbar from "../vendor/topbar";
|
import topbar from "../vendor/topbar";
|
||||||
import { Hooks as FluxonHooks, DOM as FluxonDOM } from "fluxon";
|
import { Hooks as FluxonHooks, DOM as FluxonDOM } from "fluxon";
|
||||||
import FormatNumberHook from "./hooks/format-number";
|
import FormatNumberHook from "./hooks/format-number";
|
||||||
|
import UniversalSearchNavigationHook from "./hooks/universal-search-navigation";
|
||||||
import confetti from "canvas-confetti";
|
import confetti from "canvas-confetti";
|
||||||
import { createLiveToastHook } from "live_toast";
|
import { createLiveToastHook } from "live_toast";
|
||||||
import banner from "./banner";
|
import banner from "./banner";
|
||||||
|
|
||||||
let Hooks = FluxonHooks;
|
let Hooks = FluxonHooks;
|
||||||
Hooks.FormatNumber = FormatNumberHook;
|
Hooks.FormatNumber = FormatNumberHook;
|
||||||
|
Hooks.UniversalSearchNavigation = UniversalSearchNavigationHook;
|
||||||
Hooks.LiveToast = createLiveToastHook();
|
Hooks.LiveToast = createLiveToastHook();
|
||||||
|
|
||||||
const csrfToken = document
|
const csrfToken = document
|
||||||
|
|||||||
@@ -0,0 +1,122 @@
|
|||||||
|
export default {
|
||||||
|
mounted() {
|
||||||
|
this.searchInput = document.getElementById("universal-search-input");
|
||||||
|
this.selectedIndex = -1; // -1 means search input is focused
|
||||||
|
|
||||||
|
this.keydownHandler = (event) => {
|
||||||
|
// Only handle keyboard navigation when the modal is open
|
||||||
|
const modal = document.getElementById("universal-search-root");
|
||||||
|
if (!modal) return;
|
||||||
|
|
||||||
|
switch (event.key) {
|
||||||
|
case "ArrowDown":
|
||||||
|
event.preventDefault();
|
||||||
|
this.navigateDown();
|
||||||
|
break;
|
||||||
|
case "ArrowUp":
|
||||||
|
event.preventDefault();
|
||||||
|
this.navigateUp();
|
||||||
|
break;
|
||||||
|
case "Enter":
|
||||||
|
if (this.selectedIndex >= 0) {
|
||||||
|
event.preventDefault();
|
||||||
|
this.selectCurrentResult();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case "Escape":
|
||||||
|
// Let the modal's built-in escape handling work
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
document.addEventListener("keydown", this.keydownHandler);
|
||||||
|
},
|
||||||
|
|
||||||
|
updated() {
|
||||||
|
// Reset selection when results change
|
||||||
|
this.selectedIndex = -1;
|
||||||
|
this.updateSelection();
|
||||||
|
},
|
||||||
|
|
||||||
|
destroyed() {
|
||||||
|
if (this.keydownHandler) {
|
||||||
|
document.removeEventListener("keydown", this.keydownHandler);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
navigateDown() {
|
||||||
|
const results = this.getResultElements();
|
||||||
|
|
||||||
|
if (results.length === 0) return;
|
||||||
|
|
||||||
|
// Move to next result or wrap to search input
|
||||||
|
if (this.selectedIndex < results.length - 1) {
|
||||||
|
this.selectedIndex++;
|
||||||
|
} else {
|
||||||
|
// Wrap back to search input
|
||||||
|
this.selectedIndex = -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.updateSelection();
|
||||||
|
},
|
||||||
|
|
||||||
|
navigateUp() {
|
||||||
|
const results = this.getResultElements();
|
||||||
|
|
||||||
|
if (results.length === 0) return;
|
||||||
|
|
||||||
|
// Move to previous result or wrap to last result
|
||||||
|
if (this.selectedIndex > -1) {
|
||||||
|
this.selectedIndex--;
|
||||||
|
} else {
|
||||||
|
// Wrap to last result
|
||||||
|
this.selectedIndex = results.length - 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.updateSelection();
|
||||||
|
},
|
||||||
|
|
||||||
|
selectCurrentResult() {
|
||||||
|
const results = this.getResultElements();
|
||||||
|
|
||||||
|
if (this.selectedIndex >= 0 && this.selectedIndex < results.length) {
|
||||||
|
const selectedResult = results[this.selectedIndex];
|
||||||
|
// Trigger the click event on the result
|
||||||
|
selectedResult.click();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
updateSelection() {
|
||||||
|
const results = this.getResultElements();
|
||||||
|
|
||||||
|
// Remove all aria-selected attributes and return focus to search input
|
||||||
|
results.forEach((result) => {
|
||||||
|
result.removeAttribute("aria-selected");
|
||||||
|
});
|
||||||
|
|
||||||
|
if (this.selectedIndex === -1) {
|
||||||
|
// Focus search input
|
||||||
|
if (this.searchInput) {
|
||||||
|
this.searchInput.focus();
|
||||||
|
}
|
||||||
|
} else if (this.selectedIndex >= 0 && this.selectedIndex < results.length) {
|
||||||
|
// Mark selected result
|
||||||
|
const selectedResult = results[this.selectedIndex];
|
||||||
|
selectedResult.setAttribute("aria-selected", "true");
|
||||||
|
|
||||||
|
// Scroll into view if needed
|
||||||
|
selectedResult.scrollIntoView({
|
||||||
|
block: "nearest",
|
||||||
|
behavior: "smooth"
|
||||||
|
});
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
getResultElements() {
|
||||||
|
// Get all result items with role="option"
|
||||||
|
const modal = document.getElementById("universal-search-root");
|
||||||
|
if (!modal) return [];
|
||||||
|
|
||||||
|
return Array.from(modal.querySelectorAll('[role="option"]'));
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -182,6 +182,15 @@ defmodule MusicLibraryWeb.SearchComponents do
|
|||||||
<div class="p-4 bg-zinc-50 dark:bg-zinc-900 rounded-b-lg border-t border-zinc-200 dark:border-zinc-700">
|
<div class="p-4 bg-zinc-50 dark:bg-zinc-900 rounded-b-lg border-t border-zinc-200 dark:border-zinc-700">
|
||||||
<div class="flex items-center justify-between text-xs text-zinc-500 dark:text-zinc-400">
|
<div class="flex items-center justify-between text-xs text-zinc-500 dark:text-zinc-400">
|
||||||
<div class="flex items-center space-x-4">
|
<div class="flex items-center space-x-4">
|
||||||
|
<div :if={@total_results > 0} class="flex items-center">
|
||||||
|
<kbd class="px-2 py-1 bg-zinc-200 dark:bg-zinc-700 rounded">↑</kbd>
|
||||||
|
<kbd class="px-2 py-1 bg-zinc-200 dark:bg-zinc-700 rounded ml-1">↓</kbd>
|
||||||
|
<span class="ml-1">{gettext("Navigate")}</span>
|
||||||
|
</div>
|
||||||
|
<div :if={@total_results > 0} class="flex items-center">
|
||||||
|
<kbd class="px-2 py-1 bg-zinc-200 dark:bg-zinc-700 rounded">Enter</kbd>
|
||||||
|
<span class="ml-1">{gettext("Select")}</span>
|
||||||
|
</div>
|
||||||
<div class="flex items-center">
|
<div class="flex items-center">
|
||||||
<kbd class="px-2 py-1 bg-zinc-200 dark:bg-zinc-700 rounded">Esc</kbd>
|
<kbd class="px-2 py-1 bg-zinc-200 dark:bg-zinc-700 rounded">Esc</kbd>
|
||||||
<span class="ml-1">{gettext("Close")}</span>
|
<span class="ml-1">{gettext("Close")}</span>
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
<div id={@id}>
|
<div id={@id} phx-hook="UniversalSearchNavigation">
|
||||||
<.structured_modal
|
<.structured_modal
|
||||||
:if={@show_modal}
|
:if={@show_modal}
|
||||||
id="universal-search-root"
|
id="universal-search-root"
|
||||||
|
|||||||
Reference in New Issue
Block a user