useKeyModifier

跟蹤按鍵是否被按下

useKeyModifier 響應式追蹤鍵盤修飾鍵（如 Alt、Control、Shift 等）的按下狀態。它回傳一個布林值，指示指定修飾鍵當前是否處於活動狀態。此 hook 監聽鍵盤和滑鼠事件，使用 KeyboardEvent.getModifierState() 來查詢狀態。

使用場景

  • 在修飾鍵按下時啟用替代行為（例如，按住 Shift 多選，按住 Alt 進行替代拖曳）
  • 在 UI 中顯示鍵盤修飾鍵指示器（例如 Caps Lock 警告）
  • 建構依賴修飾鍵狀態的鍵盤快捷鍵系統

注意事項

  • SSR 安全：在伺服器端渲染時回傳 initial 值（預設：false）。伺服器上不會附加事件監聽器。
  • 支援的修飾鍵：支援 Alt、AltGraph、CapsLock、Control、Fn、FnLock、Meta、NumLock、ScrollLock、Shift、Symbol 和 SymbolLock。並非所有修飾鍵在所有瀏覽器中都可用——請參閱 MDN 相容性。
  • 事件自訂：預設事件（mousedown、mouseup、keydown、keyup）可透過 events 選項覆寫。

Usage

Live Editor

function Demo() {
  const Button = (props: { mode: boolean; name: string }) => {
    const { mode, name } = props;
    return (
      <button style={mode ? { background: "var(--c-input-border-focus)" } : {}}>
        {name}
      </button>
    );
  };

  const capsLock = useKeyModifier("CapsLock");
  const numLock = useKeyModifier("NumLock");
  const scrollLock = useKeyModifier("ScrollLock");
  const shift = useKeyModifier("Shift");
  const control = useKeyModifier("Control");
  const alt = useKeyModifier("Alt");

  return (
    <div>
      <div style={{ marginBottom: 10 }}>
        <Button mode={capsLock} name="CapsLock" />
        <Button mode={numLock} name="NumLock" />
        <Button mode={scrollLock} name="ScrollLock" />
      </div>
      <div>
        <Button mode={shift} name="Shift" />
        <Button mode={control} name="Control" />
        <Button mode={alt} name="Alt" />
      </div>
    </div>
  );
};
Result

API

useKeyModifier

Returns

boolean: 按鍵是否被按下

Arguments

參數名描述類型預設值
modifier键位KeyModifier (必填)-
options可选参数UseModifierOptions | undefined-

UseModifierOptions

參數名描述類型預設值
events更新按键状态的事件(keyof WindowEventMap)[]['mousedown', 'mouseup', 'keydown', 'keyup']
initial初始值booleanfalse

KeyModifier

export type KeyModifier = 'Alt' | 'AltGraph' | 'CapsLock' | 'Control' | 'Fn' | 'FnLock' | 'Meta' | 'NumLock' | 'ScrollLock' | 'Shift' | 'Symbol' | 'SymbolLock';