useHotkeyShortcut

Import

import { useHotkeyShortcut } from "@videojs/react";

Usage

Look up a registered action to keep a custom control’s visible shortcut and aria-keyshortcuts value synchronized.

function PlayShortcut() {
  const { aria, shortcut } = useHotkeyShortcut("togglePaused");

  return <button aria-keyshortcuts={aria}>Play ({shortcut})</button>;
}

The hook subscribes to registration changes and returns HotkeyShortcutDetails: aria for the aria-keyshortcuts value and shortcut for display text. Both are undefined when the player container or action is unavailable, or the action has no registered shortcut; pass value for actions with value-specific registrations.