Skip to content

Commit f2ae091

Browse files
ci: apply automated fixes
1 parent 513d22c commit f2ae091

29 files changed

Lines changed: 100 additions & 45 deletions

docs/reference/functions/detectPlatform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: detectPlatform
99
function detectPlatform(): "mac" | "windows" | "linux";
1010
```
1111

12-
Defined in: [constants.ts:30](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/constants.ts#L30)
12+
Defined in: [constants.ts:31](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/constants.ts#L31)
1313

1414
Detects the current platform based on browser navigator properties.
1515

docs/reference/functions/normalizeKeyName.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: normalizeKeyName
99
function normalizeKeyName(key): string;
1010
```
1111

12-
Defined in: [constants.ts:422](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/constants.ts#L422)
12+
Defined in: [constants.ts:471](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/constants.ts#L471)
1313

1414
Normalizes a key name to its canonical form.
1515

docs/reference/functions/resolveModifier.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: resolveModifier
99
function resolveModifier(modifier, platform): CanonicalModifier;
1010
```
1111

12-
Defined in: [constants.ts:155](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/constants.ts#L155)
12+
Defined in: [constants.ts:156](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/constants.ts#L156)
1313

1414
Resolves the platform-adaptive 'Mod' modifier to the appropriate canonical modifier.
1515

docs/reference/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ title: "@tanstack/hotkeys"
4444
- [Modifier](type-aliases/Modifier.md)
4545
- [NavigationKey](type-aliases/NavigationKey.md)
4646
- [NumberKey](type-aliases/NumberKey.md)
47+
- [NumpadKey](type-aliases/NumpadKey.md)
4748
- [PunctuationKey](type-aliases/PunctuationKey.md)
4849
- [RegisterableHotkey](type-aliases/RegisterableHotkey.md)
4950

@@ -60,6 +61,7 @@ title: "@tanstack/hotkeys"
6061
- [MODIFIER\_ORDER](variables/MODIFIER_ORDER.md)
6162
- [NAVIGATION\_KEYS](variables/NAVIGATION_KEYS.md)
6263
- [NUMBER\_KEYS](variables/NUMBER_KEYS.md)
64+
- [NUMPAD\_KEYS](variables/NUMPAD_KEYS.md)
6365
- [PUNCTUATION\_KEYS](variables/PUNCTUATION_KEYS.md)
6466
- [STANDARD\_MODIFIER\_LABELS](variables/STANDARD_MODIFIER_LABELS.md)
6567

docs/reference/interfaces/FormatDisplayOptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: FormatDisplayOptions
55

66
# Interface: FormatDisplayOptions
77

8-
Defined in: [hotkey.ts:367](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L367)
8+
Defined in: [hotkey.ts:390](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L390)
99

1010
Options for formatting hotkeys for display.
1111

@@ -17,6 +17,6 @@ Options for formatting hotkeys for display.
1717
optional platform: "mac" | "windows" | "linux";
1818
```
1919

20-
Defined in: [hotkey.ts:369](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L369)
20+
Defined in: [hotkey.ts:392](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L392)
2121

2222
The target platform. Defaults to auto-detection.

docs/reference/interfaces/HotkeyCallbackContext.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: HotkeyCallbackContext
55

66
# Interface: HotkeyCallbackContext
77

8-
Defined in: [hotkey.ts:387](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L387)
8+
Defined in: [hotkey.ts:410](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L410)
99

1010
Context passed to hotkey callbacks along with the keyboard event.
1111

@@ -17,7 +17,7 @@ Context passed to hotkey callbacks along with the keyboard event.
1717
hotkey: Hotkey;
1818
```
1919

20-
Defined in: [hotkey.ts:389](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L389)
20+
Defined in: [hotkey.ts:412](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L412)
2121

2222
The original hotkey string that was registered
2323

@@ -29,6 +29,6 @@ The original hotkey string that was registered
2929
parsedHotkey: ParsedHotkey;
3030
```
3131

32-
Defined in: [hotkey.ts:391](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L391)
32+
Defined in: [hotkey.ts:414](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L414)
3333

3434
The parsed representation of the hotkey

docs/reference/interfaces/ParsedHotkey.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -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:331](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L331)
99

1010
A parsed representation of a hotkey string.
1111

@@ -33,7 +33,7 @@ useHotkey(parsed, handler) // Works even if userInput isn't in Hotkey type
3333
alt: 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:339](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L339)
3737

3838
Whether the Alt key is required
3939

@@ -45,7 +45,7 @@ Whether the Alt key is required
4545
ctrl: 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:335](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L335)
4949

5050
Whether the Control key is required
5151

@@ -57,7 +57,7 @@ Whether the Control key is required
5757
key: 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:333](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L333)
6161

6262
The 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
6969
meta: 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:341](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L341)
7373

7474
Whether the Meta (Command) key is required
7575

@@ -81,7 +81,7 @@ Whether the Meta (Command) key is required
8181
modifiers: 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:343](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L343)
8585

8686
List 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
9393
shift: 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:337](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L337)
9797

9898
Whether the Shift key is required

docs/reference/interfaces/RawHotkey.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: RawHotkey
55

66
# Interface: RawHotkey
77

8-
Defined in: [hotkey.ts:343](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L343)
8+
Defined in: [hotkey.ts:366](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L366)
99

1010
A raw hotkey object for programmatic registration.
1111

@@ -35,7 +35,7 @@ useHotkey({ key: 'S', mod: true, shift: true }, handler) // Mod+Shift+S
3535
optional alt: boolean;
3636
```
3737

38-
Defined in: [hotkey.ts:353](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L353)
38+
Defined in: [hotkey.ts:376](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L376)
3939

4040
Whether the Alt key is required. Defaults to false.
4141

@@ -47,7 +47,7 @@ Whether the Alt key is required. Defaults to false.
4747
optional ctrl: boolean;
4848
```
4949

50-
Defined in: [hotkey.ts:349](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L349)
50+
Defined in: [hotkey.ts:372](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L372)
5151

5252
Whether the Control key is required. Defaults to false.
5353

@@ -59,7 +59,7 @@ Whether the Control key is required. Defaults to false.
5959
key: Key | string & object;
6060
```
6161

62-
Defined in: [hotkey.ts:345](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L345)
62+
Defined in: [hotkey.ts:368](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L368)
6363

6464
The non-modifier key (e.g., 'S', 'Escape', 'F1').
6565

@@ -71,7 +71,7 @@ The non-modifier key (e.g., 'S', 'Escape', 'F1').
7171
optional meta: boolean;
7272
```
7373

74-
Defined in: [hotkey.ts:355](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L355)
74+
Defined in: [hotkey.ts:378](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L378)
7575

7676
Whether the Meta (Command) key is required. Defaults to false.
7777

@@ -83,7 +83,7 @@ Whether the Meta (Command) key is required. Defaults to false.
8383
optional mod: boolean;
8484
```
8585

86-
Defined in: [hotkey.ts:347](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L347)
86+
Defined in: [hotkey.ts:370](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L370)
8787

8888
Platform-adaptive modifier: Command on macOS, Control on Windows/Linux. Defaults to false.
8989

@@ -95,6 +95,6 @@ Platform-adaptive modifier: Command on macOS, Control on Windows/Linux. Defaults
9595
optional shift: boolean;
9696
```
9797

98-
Defined in: [hotkey.ts:351](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L351)
98+
Defined in: [hotkey.ts:374](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L374)
9999

100100
Whether the Shift key is required. Defaults to false.

docs/reference/interfaces/ValidationResult.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: ValidationResult
55

66
# Interface: ValidationResult
77

8-
Defined in: [hotkey.ts:375](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L375)
8+
Defined in: [hotkey.ts:398](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L398)
99

1010
Result of validating a hotkey string.
1111

@@ -17,7 +17,7 @@ Result of validating a hotkey string.
1717
errors: string[];
1818
```
1919

20-
Defined in: [hotkey.ts:381](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L381)
20+
Defined in: [hotkey.ts:404](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L404)
2121

2222
Error messages about invalid syntax
2323

@@ -29,7 +29,7 @@ Error messages about invalid syntax
2929
valid: boolean;
3030
```
3131

32-
Defined in: [hotkey.ts:377](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L377)
32+
Defined in: [hotkey.ts:400](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L400)
3333

3434
Whether the hotkey is valid (can still have warnings)
3535

@@ -41,6 +41,6 @@ Whether the hotkey is valid (can still have warnings)
4141
warnings: string[];
4242
```
4343

44-
Defined in: [hotkey.ts:379](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L379)
44+
Defined in: [hotkey.ts:402](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L402)
4545

4646
Warning messages about potential issues

docs/reference/type-aliases/HeldKey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: HeldKey
99
type HeldKey = CanonicalModifier | Key;
1010
```
1111

12-
Defined in: [hotkey.ts:154](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L154)
12+
Defined in: [hotkey.ts:177](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L177)
1313

1414
Keys that can be tracked as "held" (pressed down).
1515
Includes both modifier keys and regular keys.

0 commit comments

Comments
 (0)