@@ -5,7 +5,7 @@ title: ParsedHotkey
55
66# Interface: ParsedHotkey
77
8- Defined in: [ hotkey.ts:308 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L308 )
8+ Defined in: [ hotkey.ts:309 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L309 )
99
1010A parsed representation of a hotkey string.
1111
@@ -33,7 +33,7 @@ useHotkey(parsed, handler) // Works even if userInput isn't in Hotkey type
3333alt : boolean ;
3434```
3535
36- Defined in: [ hotkey.ts:316 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L316 )
36+ Defined in: [ hotkey.ts:317 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L317 )
3737
3838Whether the Alt key is required
3939
@@ -45,7 +45,7 @@ Whether the Alt key is required
4545ctrl : boolean ;
4646```
4747
48- Defined in: [ hotkey.ts:312 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L312 )
48+ Defined in: [ hotkey.ts:313 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L313 )
4949
5050Whether the Control key is required
5151
@@ -57,7 +57,7 @@ Whether the Control key is required
5757key : Key | string & object ;
5858```
5959
60- Defined in: [ hotkey.ts:310 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L310 )
60+ Defined in: [ hotkey.ts:311 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L311 )
6161
6262The non-modifier key (e.g., 'S', 'Escape', 'F1', '/', '[ '). Can be any string for flexibility.
6363
@@ -69,7 +69,7 @@ The non-modifier key (e.g., 'S', 'Escape', 'F1', '/', '['). Can be any string fo
6969meta : boolean ;
7070```
7171
72- Defined in: [ hotkey.ts:318 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L318 )
72+ Defined in: [ hotkey.ts:319 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L319 )
7373
7474Whether the Meta (Command) key is required
7575
@@ -81,7 +81,7 @@ Whether the Meta (Command) key is required
8181modifiers : CanonicalModifier [];
8282```
8383
84- Defined in: [ hotkey.ts:320 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L320 )
84+ Defined in: [ hotkey.ts:321 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L321 )
8585
8686List of canonical modifier names that are required, in canonical order
8787
@@ -93,6 +93,6 @@ List of canonical modifier names that are required, in canonical order
9393shift : boolean ;
9494```
9595
96- Defined in: [ hotkey.ts:314 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L314 )
96+ Defined in: [ hotkey.ts:315 ] ( https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L315 )
9797
9898Whether the Shift key is required
0 commit comments