useHotkeyScopesState

function useHotkeyScopesState(): Ref<HotkeyScopesState>;

Defined in: useHotkeyScopesState.ts:26

Vue composable that returns a ref of the hotkey manager's scope state: the active scopes, the exclusive scope that owns the keyboard, and the scopes it allows or suspends. Updates when scopes activate or release.

Returns#

Ref<HotkeyScopesState>

Reactive ref of the current scope state

Example#

<script setup>
import { useHotkeyScopesState } from '@tanstack/vue-hotkeys'

const scopes = useHotkeyScopesState()
</script>

<template>
  <p v-if="scopes.exclusive">Shortcuts belong to {{ scopes.exclusive }}</p>
</template>