Skip to main content

validateHotkey

还没翻译译自英文(tanstack.com)本页 13 段都还没译

function validateHotkey(hotkey): ValidationResult;

Defined in: validate.ts:25

Validates a hotkey string and returns any warnings or errors.

Checks for:

  • Valid syntax (modifier+...+key format)
  • Known modifiers
  • Known keys

Parameters

hotkey

Hotkey | string & object

The hotkey string to validate

Returns

ValidationResult

A ValidationResult with validity status, warnings, and errors

Example

validateHotkey('Mod+S')
// { valid: true, warnings: [], errors: [] }

validateHotkey('')
// { valid: false, warnings: [], errors: ['Hotkey cannot be empty'] }