Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/autofix.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
persist-credentials: false
- name: Setup Tools
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
fetch-depth: 0
persist-credentials: false
Expand All @@ -36,7 +36,7 @@
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
persist-credentials: false
- name: Setup Tools
Expand All @@ -53,10 +53,10 @@
pull-requests: write
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
persist-credentials: false
- name: Setup Tools
uses: TanStack/config/.github/setup@e4b48f16568324f76f467aa4c2aac2f05db632c3
- name: Changeset Preview
uses: TanStack/config/.github/changeset-preview@e4b48f16568324f76f467aa4c2aac2f05db632c3 # main

Check warning on line 62 in .github/workflows/pr.yml

View workflow job for this annotation

GitHub Actions / Run zizmor

ref-version-mismatch

pr.yml:62: action's hash pin has mismatched or missing version comment: branch points to commit 0b5996988cf0
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
fetch-depth: 0
persist-credentials: false
Expand All @@ -33,7 +33,7 @@
run: pnpm run test:ci
- name: Run Changesets (version or publish)
id: changesets
uses: changesets/action@6a0a831ff30acef54f2c6aa1cbbc1096b066edaf # v1.7.0
uses: changesets/action@a45c4d594aa4e2c509dc14a9f2b3b67ba3780d0d # v1.9.0
with:
version: pnpm run changeset:version
publish: pnpm run changeset:publish
Expand All @@ -41,6 +41,6 @@
title: 'ci: Version Packages'
- name: Comment on PRs about release
if: steps.changesets.outputs.published == 'true'
uses: TanStack/config/.github/comment-on-release@e4b48f16568324f76f467aa4c2aac2f05db632c3 # main

Check warning on line 44 in .github/workflows/release.yml

View workflow job for this annotation

GitHub Actions / Run zizmor

ref-version-mismatch

release.yml:44: action's hash pin has mismatched or missing version comment: branch points to commit 0b5996988cf0
with:
published-packages: ${{ steps.changesets.outputs.publishedPackages }}
4 changes: 2 additions & 2 deletions .github/workflows/zizmor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0
with:
persist-credentials: false

- name: Run zizmor
uses: zizmorcore/zizmor-action@b1d7e1fb5de872772f31590499237e7cce841e8e # v0.5.3
uses: zizmorcore/zizmor-action@cc914d7f3750a2d13d75c7f184a1060aa0e9d482 # v0.6.4
with:
advanced-security: false
annotations: true
13 changes: 7 additions & 6 deletions docs/framework/angular/reference/functions/injectHotkey.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: injectHotkey
function injectHotkey(
hotkey,
callback,
options): void;
options?): void;
```

Defined in: [injectHotkey.ts:85](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkey.ts#L85)
Expand All @@ -28,21 +28,22 @@ handle is updated instead of unregistering and re-registering when identity is u

### hotkey

The hotkey string (e.g. 'Mod+S', 'Escape') or getter function
`RegisterableHotkey` \| (() => `RegisterableHotkey`)

`RegisterableHotkey` | () => `RegisterableHotkey`
The hotkey string (e.g. 'Mod+S', 'Escape') or getter function

### callback

`HotkeyCallback`

The function to call when the hotkey is pressed

### options
### options?

Options for the hotkey behavior, or getter for reactive options
\| [`InjectHotkeyOptions`](../interfaces/InjectHotkeyOptions.md)
\| (() => [`InjectHotkeyOptions`](../interfaces/InjectHotkeyOptions.md))

[`InjectHotkeyOptions`](../interfaces/InjectHotkeyOptions.md) | () => [`InjectHotkeyOptions`](../interfaces/InjectHotkeyOptions.md)
Options for the hotkey behavior, or getter for reactive options

## Returns

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ cancel or Backspace/Delete to clear.

### options

Configuration options for the recorder (or getter)
`HotkeyRecorderOptions` \| (() => `HotkeyRecorderOptions`)

`HotkeyRecorderOptions` | () => `HotkeyRecorderOptions`
Configuration options for the recorder (or getter)

## Returns

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: injectHotkeySequence
function injectHotkeySequence(
sequence,
callback,
options): void;
options?): void;
```

Defined in: [injectHotkeySequence.ts:58](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequence.ts#L58)
Expand All @@ -26,23 +26,24 @@ advance the sequence or reset progress.

### sequence

Array of hotkey strings that form the sequence (or getter function)
`HotkeySequence` \| (() => `HotkeySequence`)

`HotkeySequence` | () => `HotkeySequence`
Array of hotkey strings that form the sequence (or getter function)

### callback

`HotkeyCallback`

Function to call when the sequence is completed

### options
### options?

\| [`InjectHotkeySequenceOptions`](../interfaces/InjectHotkeySequenceOptions.md)
\| (() => [`InjectHotkeySequenceOptions`](../interfaces/InjectHotkeySequenceOptions.md))

Options for the sequence behavior (or getter function). `enabled: false` still registers
the sequence (visible in devtools); only execution is suppressed.

[`InjectHotkeySequenceOptions`](../interfaces/InjectHotkeySequenceOptions.md) | () => [`InjectHotkeySequenceOptions`](../interfaces/InjectHotkeySequenceOptions.md)

## Returns

`void`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Angular inject-based API for recording multi-chord sequences.

### options

`HotkeySequenceRecorderOptions` | () => `HotkeySequenceRecorderOptions`
`HotkeySequenceRecorderOptions` \| (() => `HotkeySequenceRecorderOptions`)

## Returns

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: injectHotkeySequences
---

```ts
function injectHotkeySequences(sequences, commonOptions): void;
function injectHotkeySequences(sequences, commonOptions?): void;
```

Defined in: [injectHotkeySequences.ts:51](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequences.ts#L51)
Expand All @@ -24,16 +24,18 @@ remain registered so they stay visible in devtools; the core manager suppresses

### sequences

\| [`InjectHotkeySequenceDefinition`](../interfaces/InjectHotkeySequenceDefinition.md)[]
\| (() => [`InjectHotkeySequenceDefinition`](../interfaces/InjectHotkeySequenceDefinition.md)[])

Array of sequence definitions, or getter returning them

[`InjectHotkeySequenceDefinition`](../interfaces/InjectHotkeySequenceDefinition.md)[] | () => [`InjectHotkeySequenceDefinition`](../interfaces/InjectHotkeySequenceDefinition.md)[]
### commonOptions?

### commonOptions
\| [`InjectHotkeySequenceOptions`](../interfaces/InjectHotkeySequenceOptions.md)
\| (() => [`InjectHotkeySequenceOptions`](../interfaces/InjectHotkeySequenceOptions.md))

Shared options for all sequences, or getter

[`InjectHotkeySequenceOptions`](../interfaces/InjectHotkeySequenceOptions.md) | () => [`InjectHotkeySequenceOptions`](../interfaces/InjectHotkeySequenceOptions.md)

## Returns

`void`
Expand Down
12 changes: 7 additions & 5 deletions docs/framework/angular/reference/functions/injectHotkeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: injectHotkeys
---

```ts
function injectHotkeys(hotkeys, commonOptions): void;
function injectHotkeys(hotkeys, commonOptions?): void;
```

Defined in: [injectHotkeys.ts:75](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeys.ts#L75)
Expand All @@ -25,16 +25,18 @@ provideHotkeys defaults < commonOptions < per-definition options

### hotkeys

\| [`InjectHotkeyDefinition`](../interfaces/InjectHotkeyDefinition.md)[]
\| (() => [`InjectHotkeyDefinition`](../interfaces/InjectHotkeyDefinition.md)[])

Array of hotkey definitions, or getter returning them

[`InjectHotkeyDefinition`](../interfaces/InjectHotkeyDefinition.md)[] | () => [`InjectHotkeyDefinition`](../interfaces/InjectHotkeyDefinition.md)[]
### commonOptions?

### commonOptions
\| [`InjectHotkeyOptions`](../interfaces/InjectHotkeyOptions.md)
\| (() => [`InjectHotkeyOptions`](../interfaces/InjectHotkeyOptions.md))

Shared options for all hotkeys, or getter

[`InjectHotkeyOptions`](../interfaces/InjectHotkeyOptions.md) | () => [`InjectHotkeyOptions`](../interfaces/InjectHotkeyOptions.md)

## Returns

`void`
Expand Down
4 changes: 2 additions & 2 deletions docs/framework/angular/reference/functions/injectKeyHold.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ if the specified key is held.

### key

The key to check (e.g. 'Shift', 'Control', 'Space') - can be a getter function
`IndividualKey` \| (() => `IndividualKey`)

`IndividualKey` | () => `IndividualKey`
The key to check (e.g. 'Shift', 'Control', 'Space') - can be a getter function

## Returns

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Defined in: [injectHotkeyRecorder.ts:15](https://github.com/TanStack/hotkeys/blo

## Properties

### cancelRecording()
### cancelRecording

```ts
readonly cancelRecording: () => void;
Expand All @@ -23,7 +23,7 @@ Cancel recording without saving

***

### isRecording()
### isRecording

```ts
readonly isRecording: () => boolean;
Expand All @@ -39,7 +39,7 @@ Whether recording is currently active

***

### recordedHotkey()
### recordedHotkey

```ts
readonly recordedHotkey: () => Hotkey | null;
Expand All @@ -55,7 +55,7 @@ The currently recorded hotkey (for live preview)

***

### startRecording()
### startRecording

```ts
readonly startRecording: () => void;
Expand All @@ -71,7 +71,7 @@ Start recording a new hotkey

***

### stopRecording()
### stopRecording

```ts
readonly stopRecording: () => void;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Defined in: [injectHotkeySequenceRecorder.ts:18](https://github.com/TanStack/hot

## Properties

### cancelRecording()
### cancelRecording

```ts
readonly cancelRecording: () => void;
Expand All @@ -21,7 +21,7 @@ Defined in: [injectHotkeySequenceRecorder.ts:24](https://github.com/TanStack/hot

***

### commitRecording()
### commitRecording

```ts
readonly commitRecording: () => void;
Expand All @@ -35,7 +35,7 @@ Defined in: [injectHotkeySequenceRecorder.ts:25](https://github.com/TanStack/hot

***

### isRecording()
### isRecording

```ts
readonly isRecording: () => boolean;
Expand All @@ -49,7 +49,7 @@ Defined in: [injectHotkeySequenceRecorder.ts:19](https://github.com/TanStack/hot

***

### recordedSequence()
### recordedSequence

```ts
readonly recordedSequence: () => HotkeySequence | null;
Expand All @@ -63,7 +63,7 @@ Defined in: [injectHotkeySequenceRecorder.ts:21](https://github.com/TanStack/hot

***

### startRecording()
### startRecording

```ts
readonly startRecording: () => void;
Expand All @@ -77,7 +77,7 @@ Defined in: [injectHotkeySequenceRecorder.ts:22](https://github.com/TanStack/hot

***

### steps()
### steps

```ts
readonly steps: () => HotkeySequence;
Expand All @@ -91,7 +91,7 @@ Defined in: [injectHotkeySequenceRecorder.ts:20](https://github.com/TanStack/hot

***

### stopRecording()
### stopRecording

```ts
readonly stopRecording: () => void;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Defined in: [hotkeys-provider.ts:10](https://github.com/TanStack/hotkeys/blob/ma
### hotkey?

```ts
optional hotkey: Partial<InjectHotkeyOptions>;
optional hotkey?: Partial<InjectHotkeyOptions>;
```

Defined in: [hotkeys-provider.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L11)
Expand All @@ -20,7 +20,7 @@ Defined in: [hotkeys-provider.ts:11](https://github.com/TanStack/hotkeys/blob/ma
### hotkeyRecorder?

```ts
optional hotkeyRecorder: Partial<HotkeyRecorderOptions>;
optional hotkeyRecorder?: Partial<HotkeyRecorderOptions>;
```

Defined in: [hotkeys-provider.ts:12](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L12)
Expand All @@ -30,7 +30,7 @@ Defined in: [hotkeys-provider.ts:12](https://github.com/TanStack/hotkeys/blob/ma
### hotkeySequence?

```ts
optional hotkeySequence: Partial<InjectHotkeySequenceOptions>;
optional hotkeySequence?: Partial<InjectHotkeySequenceOptions>;
```

Defined in: [hotkeys-provider.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L14)
Expand All @@ -40,7 +40,7 @@ Defined in: [hotkeys-provider.ts:14](https://github.com/TanStack/hotkeys/blob/ma
### hotkeySequenceRecorder?

```ts
optional hotkeySequenceRecorder: Partial<HotkeySequenceRecorderOptions>;
optional hotkeySequenceRecorder?: Partial<HotkeySequenceRecorderOptions>;
```

Defined in: [hotkeys-provider.ts:13](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L13)
Loading
Loading