Skip to content

Commit 41a8d20

Browse files
committed
chore: update docs
1 parent 44078c4 commit 41a8d20

10 files changed

Lines changed: 142 additions & 353 deletions

File tree

docs/framework/angular/reference/functions/injectHotkeyRecorder.md

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

12-
Defined in: [injectHotkeyRecorder.ts:50](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L50)
12+
Defined in: [injectHotkeyRecorder.ts:58](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L58)
1313

1414
Angular inject-based API for recording keyboard shortcuts.
1515

docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md

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

66
# Interface: AngularHotkeyRecorder
77

8-
Defined in: [injectHotkeyRecorder.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L7)
8+
Defined in: [injectHotkeyRecorder.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L15)
99

1010
## Properties
1111

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

18-
Defined in: [injectHotkeyRecorder.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L17)
18+
Defined in: [injectHotkeyRecorder.ts:25](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L25)
1919

2020
Cancel recording without saving
2121

@@ -31,7 +31,7 @@ Cancel recording without saving
3131
readonly isRecording: () => boolean;
3232
```
3333

34-
Defined in: [injectHotkeyRecorder.ts:9](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L9)
34+
Defined in: [injectHotkeyRecorder.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L17)
3535

3636
Whether recording is currently active
3737

@@ -47,7 +47,7 @@ Whether recording is currently active
4747
readonly recordedHotkey: () => Hotkey | null;
4848
```
4949

50-
Defined in: [injectHotkeyRecorder.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L11)
50+
Defined in: [injectHotkeyRecorder.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L19)
5151

5252
The currently recorded hotkey (for live preview)
5353

@@ -63,7 +63,7 @@ The currently recorded hotkey (for live preview)
6363
readonly startRecording: () => void;
6464
```
6565

66-
Defined in: [injectHotkeyRecorder.ts:13](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L13)
66+
Defined in: [injectHotkeyRecorder.ts:21](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L21)
6767

6868
Start recording a new hotkey
6969

@@ -79,7 +79,7 @@ Start recording a new hotkey
7979
readonly stopRecording: () => void;
8080
```
8181

82-
Defined in: [injectHotkeyRecorder.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L15)
82+
Defined in: [injectHotkeyRecorder.ts:23](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L23)
8383

8484
Stop recording (same as cancel)
8585

docs/framework/angular/reference/interfaces/HotkeysContextValue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Defined in: [hotkeys-provider.ts:13](https://github.com/TanStack/hotkeys/blob/ma
1212
### defaultOptions
1313

1414
```ts
15-
defaultOptions: HotkeysProviderOptions;
15+
readonly defaultOptions: HotkeysProviderOptions;
1616
```
1717

1818
Defined in: [hotkeys-provider.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L14)

0 commit comments

Comments
 (0)