#useKeyModifier

const isModifierPressed = useKeyModifier(keyModifier, options)

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

export type UseModifierOptions<Initial> = {
  /**
   * 将提示修改器状态更新的事件名称
   *
   * @defaultValue ['mousedown', 'mouseup', 'keydown', 'keyup']
   */
  events?: WindowEventName[]
  /**
   * 返回的 ref 的初始值
   *
   * @defaultValue null
   */
  initial?: Initial
}

export type UseKeyModifierReturns<Initial> = Initial extends boolean ? boolean : boolean | null