useHotkeyScopesState

function useHotkeyScopesState(): HotkeyScopesState;

Defined in: useHotkeyScopesState.ts:21

React hook that returns the hotkey manager's scope state: the active scopes, the exclusive scope that owns the keyboard, and the scopes it allows or suspends. Re-renders when scopes activate or release.

Returns#

HotkeyScopesState

The current scope state

Example#

function KeyboardOwner() {
  const { exclusive } = useHotkeyScopesState()

  return exclusive ? <p>Shortcuts belong to {exclusive}</p> : null
}