Skip to content

Commit 8c0195d

Browse files
ci: apply automated fixes
1 parent da6ddd3 commit 8c0195d

File tree

7 files changed

+22
-24
lines changed

7 files changed

+22
-24
lines changed

docs/framework/react/reference/functions/useHotkeyRecorder.md

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

12-
Defined in: [useHotkeyRecorder.ts:60](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L60)
12+
Defined in: [useHotkeyRecorder.ts:57](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L57)
1313

1414
React hook for recording keyboard shortcuts.
1515

docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md

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

66
# Interface: ReactHotkeyRecorder
77

8-
Defined in: [useHotkeyRecorder.ts:9](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L9)
8+
Defined in: [useHotkeyRecorder.ts:6](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L6)
99

1010
## Properties
1111

@@ -15,7 +15,7 @@ Defined in: [useHotkeyRecorder.ts:9](https://github.com/TanStack/keys/blob/main/
1515
cancelRecording: () => void;
1616
```
1717

18-
Defined in: [useHotkeyRecorder.ts:19](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L19)
18+
Defined in: [useHotkeyRecorder.ts:16](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L16)
1919

2020
Cancel recording without saving
2121

@@ -31,7 +31,7 @@ Cancel recording without saving
3131
isRecording: boolean;
3232
```
3333

34-
Defined in: [useHotkeyRecorder.ts:11](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L11)
34+
Defined in: [useHotkeyRecorder.ts:8](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L8)
3535

3636
Whether recording is currently active
3737

@@ -43,7 +43,7 @@ Whether recording is currently active
4343
recordedHotkey: Hotkey | null;
4444
```
4545

46-
Defined in: [useHotkeyRecorder.ts:13](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L13)
46+
Defined in: [useHotkeyRecorder.ts:10](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L10)
4747

4848
The currently recorded hotkey (for live preview)
4949

@@ -55,7 +55,7 @@ The currently recorded hotkey (for live preview)
5555
startRecording: () => void;
5656
```
5757

58-
Defined in: [useHotkeyRecorder.ts:15](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L15)
58+
Defined in: [useHotkeyRecorder.ts:12](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L12)
5959

6060
Start recording a new hotkey
6161

@@ -71,7 +71,7 @@ Start recording a new hotkey
7171
stopRecording: () => void;
7272
```
7373

74-
Defined in: [useHotkeyRecorder.ts:17](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L17)
74+
Defined in: [useHotkeyRecorder.ts:14](https://github.com/TanStack/keys/blob/main/packages/react-keys/src/useHotkeyRecorder.ts#L14)
7575

7676
Stop recording (same as cancel)
7777

docs/reference/classes/HotkeyManager.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ unregister()
3434
destroy(): void;
3535
```
3636

37-
Defined in: [manager.ts:526](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L526)
37+
Defined in: [manager.ts:520](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L520)
3838

3939
Destroys the manager and removes all listeners.
4040

@@ -50,7 +50,7 @@ Destroys the manager and removes all listeners.
5050
getRegistrationCount(): number;
5151
```
5252

53-
Defined in: [manager.ts:497](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L497)
53+
Defined in: [manager.ts:491](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L491)
5454

5555
Gets the number of registered hotkeys.
5656

@@ -66,7 +66,7 @@ Gets the number of registered hotkeys.
6666
isRegistered(hotkey, target?): boolean;
6767
```
6868
69-
Defined in: [manager.ts:508](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L508)
69+
Defined in: [manager.ts:502](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L502)
7070
7171
Checks if a specific hotkey is registered.
7272
@@ -101,7 +101,7 @@ register(
101101
options): HotkeyRegistrationHandle;
102102
```
103103
104-
Defined in: [manager.ts:122](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L122)
104+
Defined in: [manager.ts:120](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L120)
105105
106106
Registers a hotkey handler and returns a handle for updating the registration.
107107
@@ -157,7 +157,7 @@ handle.unregister()
157157
static getInstance(): HotkeyManager;
158158
```
159159
160-
Defined in: [manager.ts:80](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L80)
160+
Defined in: [manager.ts:78](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L78)
161161
162162
Gets the singleton instance of HotkeyManager.
163163
@@ -173,7 +173,7 @@ Gets the singleton instance of HotkeyManager.
173173
static resetInstance(): void;
174174
```
175175
176-
Defined in: [manager.ts:90](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L90)
176+
Defined in: [manager.ts:88](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L88)
177177
178178
Resets the singleton instance. Useful for testing.
179179

docs/reference/classes/HotkeyRecorder.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Use this to subscribe to state changes or access current state.
8787
cancel(): void;
8888
```
8989

90-
Defined in: [recorder.ts:212](https://github.com/TanStack/keys/blob/main/packages/keys/src/recorder.ts#L212)
90+
Defined in: [recorder.ts:214](https://github.com/TanStack/keys/blob/main/packages/keys/src/recorder.ts#L214)
9191

9292
Cancel recording without saving.
9393

@@ -106,7 +106,7 @@ the onCancel callback if provided.
106106
destroy(): void;
107107
```
108108

109-
Defined in: [recorder.ts:257](https://github.com/TanStack/keys/blob/main/packages/keys/src/recorder.ts#L257)
109+
Defined in: [recorder.ts:259](https://github.com/TanStack/keys/blob/main/packages/keys/src/recorder.ts#L259)
110110

111111
Clean up event listeners and reset state.
112112

@@ -168,7 +168,7 @@ a valid hotkey is recorded, Escape is pressed, or stop/cancel is called.
168168
stop(): void;
169169
```
170170

171-
Defined in: [recorder.ts:192](https://github.com/TanStack/keys/blob/main/packages/keys/src/recorder.ts#L192)
171+
Defined in: [recorder.ts:194](https://github.com/TanStack/keys/blob/main/packages/keys/src/recorder.ts#L194)
172172

173173
Stop recording (same as cancel, but doesn't call onCancel).
174174

docs/reference/functions/getHotkeyManager.md

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

12-
Defined in: [manager.ts:542](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L542)
12+
Defined in: [manager.ts:536](https://github.com/TanStack/keys/blob/main/packages/keys/src/manager.ts#L536)
1313

1414
Gets the singleton HotkeyManager instance.
1515
Convenience function for accessing the manager.

packages/keys/src/recorder.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,9 @@ export class HotkeyRecorder {
163163
// Validate: must have at least one non-modifier key
164164
if (hasNonModifierKey(finalHotkey, this.#platform)) {
165165
// Remove listener FIRST to prevent any additional events
166-
const handlerToRemove = this.#keydownHandler as ((event: KeyboardEvent) => void) | null
166+
const handlerToRemove = this.#keydownHandler as
167+
| ((event: KeyboardEvent) => void)
168+
| null
167169
if (handlerToRemove) {
168170
this.#removeListener(handlerToRemove)
169171
this.#keydownHandler = null

packages/react-keys/src/useHotkeyRecorder.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
import { useEffect, useRef } from 'react'
22
import { useStore } from '@tanstack/react-store'
3-
import {
4-
5-
HotkeyRecorder
6-
7-
} from '@tanstack/keys'
8-
import type {Hotkey, HotkeyRecorderOptions} from '@tanstack/keys';
3+
import { HotkeyRecorder } from '@tanstack/keys'
4+
import type { Hotkey, HotkeyRecorderOptions } from '@tanstack/keys'
95

106
export interface ReactHotkeyRecorder {
117
/** Whether recording is currently active */

0 commit comments

Comments
 (0)