Show Keyboard Shortcut Hints While a Modifier Is Held in Vue

Some apps show each button's shortcut only while the user holds a modifier, so the hints are there when the user reaches for the keyboard, and out of the way otherwise. useHotkeyHint returns a computed ref that's true while the user holds modifiers that belong to a hotkey. It's an optional helper, and it doesn't register anything, so use it alongside useHotkey.

Show a hint next to a button#

<script setup lang="ts">
import {
  formatForDisplay,
  useHotkey,
  useHotkeyHint,
} from '@tanstack/vue-hotkeys'

const saveHotkey = 'Mod+S'

useHotkey(saveHotkey, save)
const showHint = useHotkeyHint(saveHotkey)
</script>

<template>
  <button @click="save">
    Save <kbd v-if="showHint">{{ formatForDisplay(saveHotkey) }}</kbd>
  </button>
</template>

While the user holds Command on macOS, or Control elsewhere, the button reads "Save ⌘ S" or "Save Ctrl+S". Formatting & Display covers labels and keycaps.

When a hint shows#

• Holding any of the hotkey's modifiers shows the hint. For Alt+Shift+[KeyK], holding Alt, Shift, or both shows it.
• Holding a modifier the hotkey doesn't use hides the hint, so holding Control and Alt shows only the hints for hotkeys that use both.
• Releasing every modifier, or the window losing focus, hides the hint.
• Other held keys don't matter. AltGr never shows hints, because it types characters.
• A hotkey without modifiers, such as Escape or G, never shows a hint.

To show a hint only while every modifier is held, pass exact:

const showHint = useHotkeyHint('Alt+Shift+[KeyK]', { exact: true }) // Needs Alt and Shift

If the hotkey sets platform, pass the same platform to useHotkeyHint, so Mod resolves the same way. The hotkey and the options can also be refs or getters.

Hints for sequences#

A sequence shows its hint while the user holds the modifiers of its first step:

const showHint = useHotkeyHint(['Mod+K', 'Mod+C']) // true while Mod is held

Hints for app hotkeys#

Pass an app hotkey to show the user's current hotkey, including one they changed. An app hotkey with no hotkey assigned shows no hint. A small component keeps every button's hint the same:

<!-- Hint.vue -->
<script setup lang="ts">
import { computed } from 'vue'
import {
  formatForDisplay,
  useAppHotkeys,
  useHotkeyHint,
} from '@tanstack/vue-hotkeys'
import type { AppHotkeyId } from '@tanstack/vue-hotkeys'

const props = defineProps<{ id: AppHotkeyId }>()
const appHotkeys = useAppHotkeys()
const appHotkey = computed(() => appHotkeys.value[props.id])
const showHint = useHotkeyHint(appHotkey)
</script>

<template>
  <kbd v-if="showHint && appHotkey.hotkey">
    {{ formatForDisplay(appHotkey.hotkey) }}
  </kbd>
</template>

<template>
  <button @click="save">Save <Hint id="doc.save" /></button>
</template>

Hide hints for hotkeys that can't fire#

useHotkeyHint only looks at held keys. It doesn't know whether the hotkey is enabled, its scope is active, or its target has focus. When a hotkey can be off, combine the hint with the same state:

useHotkey(saveHotkey, save, { enabled: isDirty })
const hint = useHotkeyHint(saveHotkey)
const showHint = computed(() => hint.value && isDirty.value)

Check held modifiers without the composable#

To check outside a component, such as while drawing on a canvas, pass the held keys to matchesHeldModifiers. It takes the same options:

import { getKeyStateTracker, matchesHeldModifiers } from '@tanstack/vue-hotkeys'

const tracker = getKeyStateTracker()

matchesHeldModifiers('Mod+S', tracker.getHeldKeys()) // true while Mod is held

Held Key State Helpers covers the tracker and the other held-key composables.

The Kitchen Sink example shows hints next to its navigation links and buttons while Alt or Option is held.