useHotkeyRegistrations | TanStack Hotkeys Vue Docs

function useHotkeyRegistrations(): Readonly<Ref<HotkeyRegistrationView[]>>;

function useHotkeyRegistrations(): Readonly<Ref<HotkeyRegistrationView[]>>;

Defined in: useHotkeyRegistrations.ts:26

Vue composable that reactively reads every hotkey registration, chords and sequences, from the singleton HotkeyManager. Narrow each view with kind.

This composable does NOT require the HotkeysProvider.

Returns

Readonly<Ref<HotkeyRegistrationView[]>>

A ref of all registrations, without callbacks

Example

vue

<script setup>
const registrations = useHotkeyRegistrations()
</script>
<template>
  <li v-for="reg in registrations" :key="reg.id">
    {{ reg.options.meta?.name }}: {{ formatForDisplay(reg.hotkey) }}
  </li>
</template>

<script setup>
const registrations = useHotkeyRegistrations()
</script>
<template>
  <li v-for="reg in registrations" :key="reg.id">
    {{ reg.options.meta?.name }}: {{ formatForDisplay(reg.hotkey) }}
  </li>
</template>