Documentation

useKeyboardShortcut

Register global keyboard shortcuts for command palettes and actions.

Installation

pnpm add @rouf-dev/pantheon-ui

Usage

"use client";

import { useKeyboardShortcut } from "@rouf-dev/pantheon-ui";
import { useState } from "react";

export function CommandPaletteDemo() {
  const [isOpen, setIsOpen] = useState(false);

  useKeyboardShortcut(['Meta', 'k'], () => {
    setIsOpen(true);
  });

  useKeyboardShortcut(['Control', 's'], (e) => {
    e.preventDefault();
    console.log('Save triggered');
  });

  return <div>{isOpen && <div>Command Palette</div>}</div>;
}

Parameters

keys: Array of key names (e.g., ['Meta', 'k'])

callback: Function to execute when shortcut is pressed