Skip to content

feat: add keyboard shortcut highlight on "?" press #440

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

Merged
danielroe merged 8 commits into from
Jan 31, 2026
Merged

feat: add keyboard shortcut highlight on "?" press #440

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d2a7229
Highlight kbd elements on '?' press
jhroemer Jan 30, 2026
b79e7f8
Make animation restart/cancel work properly
jhroemer Jan 30, 2026
f09e42e
Animate keyboard shortcut highlights with data-attribute approach
jhroemer Jan 31, 2026
1b17f8c
Merge remote-tracking branch 'origin/main' into feat-add-keyboard-sho…
danielroe Jan 31, 2026
8be5e9b
chore: merge in https://github.com/npmx-dev/npmx.dev/pull/461
danielroe Jan 31, 2026
0373843
chore: add co-authored
danielroe Jan 31, 2026
e17c552
chore: add co-authored
danielroe Jan 31, 2026
5f102e4
chore: add co-authored
danielroe Jan 31, 2026
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
46 changes: 40 additions & 6 deletions app/app.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const { locale, locales } = useI18n()
initPreferencesOnPrehydrate()

const isHomepage = computed(() => route.name === 'index')
const showKbdHints = shallowRef(false)

const localeMap = locales.value.reduce(
(acc, l) => {
Expand All @@ -21,8 +22,9 @@ const localeMap = locales.value.reduce(

useHead({
htmlAttrs: {
lang: () => locale.value,
dir: () => localeMap[locale.value] ?? 'ltr',
'lang': () => locale.value,
'dir': () => localeMap[locale.value] ?? 'ltr',
'data-kbd-hints': () => showKbdHints.value,
},
titleTemplate: titleChunk => {
return titleChunk ? titleChunk : 'npmx - Better npm Package Browser'
Expand All @@ -33,16 +35,16 @@ if (import.meta.server) {
setJsonLd(createWebSiteSchema())
}

// Global keyboard shortcut: "/" focuses search or navigates to search page
// Global keyboard shortcut:
// "/" focuses search or navigates to search page
// "?" highlights all keyboard shortcut elements
function handleGlobalKeydown(e: KeyboardEvent) {
const target = e.target as HTMLElement

const isEditableTarget =
target.tagName === 'INPUT' || target.tagName === 'TEXTAREA' || target.isContentEditable

if (isEditableTarget) {
return
}
if (isEditableTarget) return

if (e.key === '/') {
e.preventDefault()
Expand All @@ -59,10 +61,20 @@ function handleGlobalKeydown(e: KeyboardEvent) {

router.push('/search')
}

if (e.key === '?') {
e.preventDefault()
showKbdHints.value = true
}
}

function handleGlobalKeyup() {
showKbdHints.value = false
}

if (import.meta.client) {
useEventListener(document, 'keydown', handleGlobalKeydown)
useEventListener(document, 'keyup', handleGlobalKeyup)
}
</script>

Expand All @@ -82,3 +94,25 @@ if (import.meta.client) {
<ScrollToTop />
</div>
</template>

<style>
/* Keyboard shortcut highlight on "?" key press */
kbd {
position: relative;
}

kbd::before {
content: '';
position: absolute;
inset: 0;
border-radius: inherit;
box-shadow: 0 0 4px 2px var(--accent);
opacity: 0;
transition: opacity 200ms ease-out;
pointer-events: none;
}

html[data-kbd-hints='true'] kbd::before {
opacity: 1;
}
</style>
Loading