Skip to content

Commit 4767bbb

Browse files
committed
address pr feedback
1 parent e4b993a commit 4767bbb

27 files changed

Lines changed: 56 additions & 56 deletions

File tree

.changeset/plural-sequences.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
"@tanstack/react-hotkeys": minor
3-
"@tanstack/preact-hotkeys": minor
4-
"@tanstack/vue-hotkeys": minor
5-
"@tanstack/solid-hotkeys": minor
6-
"@tanstack/svelte-hotkeys": minor
7-
"@tanstack/angular-hotkeys": minor
2+
'@tanstack/react-hotkeys': minor
3+
'@tanstack/preact-hotkeys': minor
4+
'@tanstack/vue-hotkeys': minor
5+
'@tanstack/solid-hotkeys': minor
6+
'@tanstack/svelte-hotkeys': minor
7+
'@tanstack/angular-hotkeys': minor
88
---
99

1010
Add plural sequence registration APIs: `useHotkeySequences` (React/Preact/Vue), `createHotkeySequences` and `createHotkeySequencesAttachment` (Svelte), `createHotkeySequences` (Solid), and `injectHotkeySequences` (Angular).

docs/framework/angular/guides/sequences.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ export class AppComponent {
2626
Use `injectHotkeySequences` when you want several sequences (or a list built from data) in one injection context, instead of many `injectHotkeySequence` calls.
2727

2828
```ts
29+
import { Component } from '@angular/core'
2930
import { injectHotkeySequences } from '@tanstack/angular-hotkeys'
3031

3132
@Component({ standalone: true, template: `` })

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

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

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

1414
Angular inject-based API for registering multiple keyboard shortcut sequences at once (Vim-style).
1515

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

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

66
# Interface: InjectHotkeySequenceDefinition
77

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

1010
A single sequence definition for use with `injectHotkeySequences`.
1111

@@ -17,7 +17,7 @@ A single sequence definition for use with `injectHotkeySequences`.
1717
callback: HotkeyCallback;
1818
```
1919

20-
Defined in: injectHotkeySequences.ts:18
20+
Defined in: [injectHotkeySequences.ts:18](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequences.ts#L18)
2121

2222
The function to call when the sequence is completed
2323

@@ -31,7 +31,7 @@ optional options:
3131
| () => InjectHotkeySequenceOptions;
3232
```
3333

34-
Defined in: injectHotkeySequences.ts:20
34+
Defined in: [injectHotkeySequences.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequences.ts#L20)
3535

3636
Per-sequence options (merged on top of commonOptions)
3737

@@ -43,6 +43,6 @@ Per-sequence options (merged on top of commonOptions)
4343
sequence: HotkeySequence | () => HotkeySequence;
4444
```
4545

46-
Defined in: injectHotkeySequences.ts:16
46+
Defined in: [injectHotkeySequences.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequences.ts#L16)
4747

4848
Array of hotkey strings that form the sequence

docs/framework/preact/reference/functions/useHotkeySequences.md

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

12-
Defined in: useHotkeySequences.ts:65
12+
Defined in: [useHotkeySequences.ts:65](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequences.ts#L65)
1313

1414
Preact hook for registering multiple keyboard shortcut sequences at once (Vim-style).
1515

docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md

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

66
# Interface: UseHotkeySequenceDefinition
77

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

1010
A single sequence definition for use with `useHotkeySequences`.
1111

@@ -17,7 +17,7 @@ A single sequence definition for use with `useHotkeySequences`.
1717
callback: HotkeyCallback;
1818
```
1919

20-
Defined in: useHotkeySequences.ts:19
20+
Defined in: [useHotkeySequences.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequences.ts#L19)
2121

2222
The function to call when the sequence is completed
2323

@@ -29,7 +29,7 @@ The function to call when the sequence is completed
2929
optional options: UseHotkeySequenceOptions;
3030
```
3131

32-
Defined in: useHotkeySequences.ts:21
32+
Defined in: [useHotkeySequences.ts:21](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequences.ts#L21)
3333

3434
Per-sequence options (merged on top of commonOptions)
3535

@@ -41,6 +41,6 @@ Per-sequence options (merged on top of commonOptions)
4141
sequence: HotkeySequence;
4242
```
4343

44-
Defined in: useHotkeySequences.ts:17
44+
Defined in: [useHotkeySequences.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequences.ts#L17)
4545

4646
Array of hotkey strings that form the sequence

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

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

12-
Defined in: useHotkeySequences.ts:65
12+
Defined in: [useHotkeySequences.ts:65](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequences.ts#L65)
1313

1414
React hook for registering multiple keyboard shortcut sequences at once (Vim-style).
1515

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

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

66
# Interface: UseHotkeySequenceDefinition
77

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

1010
A single sequence definition for use with `useHotkeySequences`.
1111

@@ -17,7 +17,7 @@ A single sequence definition for use with `useHotkeySequences`.
1717
callback: HotkeyCallback;
1818
```
1919

20-
Defined in: useHotkeySequences.ts:19
20+
Defined in: [useHotkeySequences.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequences.ts#L19)
2121

2222
The function to call when the sequence is completed
2323

@@ -29,7 +29,7 @@ The function to call when the sequence is completed
2929
optional options: UseHotkeySequenceOptions;
3030
```
3131

32-
Defined in: useHotkeySequences.ts:21
32+
Defined in: [useHotkeySequences.ts:21](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequences.ts#L21)
3333

3434
Per-sequence options (merged on top of commonOptions)
3535

@@ -41,6 +41,6 @@ Per-sequence options (merged on top of commonOptions)
4141
sequence: HotkeySequence;
4242
```
4343

44-
Defined in: useHotkeySequences.ts:17
44+
Defined in: [useHotkeySequences.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequences.ts#L17)
4545

4646
Array of hotkey strings that form the sequence

docs/framework/solid/reference/functions/createHotkeySequences.md

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

12-
Defined in: createHotkeySequences.ts:61
12+
Defined in: [createHotkeySequences.ts:61](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequences.ts#L61)
1313

1414
SolidJS primitive for registering multiple keyboard shortcut sequences at once (Vim-style).
1515

docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md

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

66
# Interface: CreateHotkeySequenceDefinition
77

8-
Defined in: createHotkeySequences.ts:14
8+
Defined in: [createHotkeySequences.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequences.ts#L14)
99

1010
A single sequence definition for use with `createHotkeySequences`.
1111

@@ -17,7 +17,7 @@ A single sequence definition for use with `createHotkeySequences`.
1717
callback: HotkeyCallback;
1818
```
1919

20-
Defined in: createHotkeySequences.ts:18
20+
Defined in: [createHotkeySequences.ts:18](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequences.ts#L18)
2121

2222
The function to call when the sequence is completed
2323

@@ -29,7 +29,7 @@ The function to call when the sequence is completed
2929
optional options: CreateHotkeySequenceOptions;
3030
```
3131

32-
Defined in: createHotkeySequences.ts:20
32+
Defined in: [createHotkeySequences.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequences.ts#L20)
3333

3434
Per-sequence options (merged on top of commonOptions)
3535

@@ -41,6 +41,6 @@ Per-sequence options (merged on top of commonOptions)
4141
sequence: HotkeySequence;
4242
```
4343

44-
Defined in: createHotkeySequences.ts:16
44+
Defined in: [createHotkeySequences.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequences.ts#L16)
4545

4646
Array of hotkey strings that form the sequence

0 commit comments

Comments
 (0)