Skip to content

🎨 Palette: [UX improvement] Add keyboard shortcut hint to search bar #16

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.

Sign up for GitHub

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

Open
jspann21 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🎨 Palette: [UX improvement] Add keyboard shortcut hint to search bar #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .Jules/palette.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## 2024-06-03 - Search Shortcut Accessibility
**Learning:** Adding dynamic keyboard shortcut hints (`⌘F` on Mac, `Ctrl F` on Windows/Linux) inside the search bar significantly improves discoverability without cluttering the UI. When checking for platform (`navigator.platform`), adding a `typeof navigator !== 'undefined'` safety check is vital to prevent potential SSR crashes, even if the app is currently a SPA.
**Action:** Next time I add OS-specific visual hints, I will ensure proper SSR-safe navigator checks are included, and ensure padding adjustments are made for interactive elements replacing placeholders.
11 changes: 9 additions & 2 deletions src/features/library/components/LibraryHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ export function LibraryHeader({
}: LibraryHeaderProps) {
const searchInputRef = useRef<HTMLInputElement>(null)

const isMac = typeof navigator !== 'undefined' ? navigator.platform.toLowerCase().includes('mac') : false
const shortcutText = isMac ? '⌘F' : 'Ctrl F'

useEffect(() => {
const handleKeyDown = (event: KeyboardEvent) => {
if (event.defaultPrevented || isEditableElement(event.target)) return
Expand All @@ -80,7 +83,7 @@ export function LibraryHeader({
type="text"
aria-label="Search your library"
placeholder="Search your library..."
className="w-full rounded-xl border border-slate-200 bg-white py-2 pl-10 pr-10 text-sm text-slate-900 outline-none transition-all placeholder:text-slate-400 focus:border-accent-500 focus:ring-2 focus:ring-accent-500/20 dark:border-slate-700 dark:bg-slate-800 dark:text-slate-100"
className="w-full rounded-xl border border-slate-200 bg-white py-2 pl-10 pr-16 text-sm text-slate-900 outline-none transition-all placeholder:text-slate-400 focus:border-accent-500 focus:ring-2 focus:ring-accent-500/20 dark:border-slate-700 dark:bg-slate-800 dark:text-slate-100"
value={query}
onChange={(event) => onSetQuery(event.target.value)}
/>
Expand All @@ -94,7 +97,11 @@ export function LibraryHeader({
>
<X size={14} />
</button>
) : null}
) : (
<div className="pointer-events-none absolute right-3 top-1/2 flex -translate-y-1/2 items-center rounded border border-slate-200 bg-slate-50 px-1.5 py-0.5 text-[10px] font-medium text-slate-400 dark:border-slate-700 dark:bg-slate-800 dark:text-slate-500">
{shortcutText}
</div>
)}
</div>
</div>
<div className="flex items-center gap-2">
Expand Down