useHotkey

Import

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

Usage

Call the hook inside Player with the accepted keys and activation callback.

function CustomPlayHotkey() {
  useHotkey({
    keys: "k",
    onActivate: (_event, key) => console.log(`Activated by ${key}`),
  });

  return null;
}

Shortcuts target the player by default and accept repeated keydown events. Set target to "document", repeatable to false, or disabled to change those behaviors. The hook still requires a surrounding Player for its coordinator.

{ keys: string; onActivate: ((event: KeyboardEvent, key: string) => void); target?: 'player' | 'document'; repeatable?: boolean; disabled?: boolean }