[dependabot]

Bumps @tanstack/solid-hotkeys from 0.10.0 to 0.15.0.

Release notes

Sourced from @​tanstack/solid-hotkeys's releases.

@​tanstack/solid-hotkeys@​0.15.0

Minor Changes

• #189 dd1f39d - Types and functions now follow one naming rule: a hotkey is a chord or a sequence, a chord is keys pressed together, and a sequence is chords pressed one after another. A name with Hotkey alone accepts both kinds. Names for one kind say Chord or Sequence.

  Hotkey callbacks receive a context with the same chord and sequence shapes as registration views. A chord's callback gets { kind: 'chord', hotkey, parsedChord }. A sequence's callback gets { kind: 'sequence', hotkey, parsedSequence } with every step parsed. Before, a sequence's parsedHotkey held only its last step. The recorder's validate context is split the same way: { kind: 'chord', event, parsedChord } or { kind: 'sequence', events, parsedSequence }.

  useHotkey, HotkeyManager.register, the Lit @hotkey decorator, and the other APIs that take one hotkey type the context from the hotkey you pass, so a chord's callback can read parsedChord without a check. Callbacks in useHotkeys arrays, and callbacks typed HotkeyCallback, receive either shape. Check context.kind before reading parsedChord or parsedSequence. A one-step array such as ['Escape'] now gets chord options and chord context, which matches how it registers.

  Sequence steps can be chord objects as well as strings, such as [{ key: 'K', mod: true }, 'C']. The new RegisterableHotkeySequence type describes them. Registered sequences store each step as a string.

  Every step that advances a sequence now calls preventDefault, not only the last one. In ['Mod+K', 'Mod+C'], the browser no longer runs its own Ctrl+K on the first step. stopPropagation still applies only on the last step, so earlier steps reach other listeners. To let the browser act on every step, set preventDefault: false.

  A sequence's progress now clears when its timeout passes, and registration subscribers are notified. Before, progress cleared only on the next key press, so matchedStepCount could stay above 0 after the timeout.

  Renamed:

  • RawHotkey to RawHotkeyChord
  • ParsedHotkey to ParsedHotkeyChord
  • SingleModifierHotkey, TwoModifierHotkey, ThreeModifierHotkey, and FourModifierHotkey to SingleModifierHotkeyChord, TwoModifierHotkeyChord, ThreeModifierHotkeyChord, and FourModifierHotkeyChord
  • parsedHotkey to parsedChord on chord registration views, callback contexts, and recorder validation contexts
  • createHotkeyHandler to createHotkeyChordHandler, createMultiHotkeyHandler to createMultiHotkeyChordHandler, MultiHotkeyHandler to MultiHotkeyChordHandler, and CreateHotkeyHandlerOptions to CreateHotkeyChordHandlerOptions

  Merged:

  • parseHotkey parses chord strings, chord objects, and sequences. It replaces parseRegisterableHotkey and rawHotkeyToParsedHotkey.
  • normalizeHotkey normalizes chord strings, chord objects, parsed chords, and sequences. It replaces normalizeRegisterableHotkey and normalizeHotkeyFromParsed. Replace normalizeHotkeyFromEvent(event) with normalizeHotkey(parseKeyboardEvent(event)).
  • formatHotkey also formats a parsed sequence, returning one string per step.

• #189 dd1f39d - Add hotkey scopes, which turn groups of hotkeys on and off together, such as everything in a dialog.

  • Every hotkey belongs to a scope. The default scope, 'global', is always active. Pass scope to a hotkey to put it in another scope.
  • HotkeyManager.activateScope(scope, options) activates a scope until you call the function it returns. When hotkeys in two active scopes match the same key, a nested scope beats the scopes around it, and otherwise the most recently activated scope wins.
  • An exclusive scope suspends every other scope, including 'global', while it's active. Pass exclusive: { allow: ['global'] } to keep some scopes working.
  • HotkeyManager.scopes publishes which scopes are active, suspended, allowed, and exclusive. isScopeActive(scope) reports whether a scope's hotkeys can fire.
  • In React, Preact, Solid, Vue, Svelte, and Octane, HotkeysProvider takes scope, exclusive, and enabled. Hotkeys registered inside a scoped provider belong to its scope, which is active while the provider is mounted and enabled. Vue's provideHotkeysContext and Svelte's setHotkeysContext take the same options. In Angular, pass them to provideHotkeys in a component's providers.
  • In Lit, Alpine, and Ember, activate scopes with the hotkey manager, and pass scope to the hotkeys that belong to them.
  • App hotkeys can declare a scope. App hotkeys in different scopes can share a hotkey without a conflict. The app hotkey list reports 'suspended' for an app hotkey whose enabled registrations are all in inactive scopes.
  • Devtools group registrations by scope and show which scopes are active, suspended, allowed, or exclusive.

Patch Changes

• Updated dependencies [dd1f39d, dd1f39d]:
  • @​tanstack/hotkeys@​0.16.0

@​tanstack/solid-hotkeys@​0.14.5

Patch Changes

• Updated dependencies [f5a9816]:
  • @​tanstack/hotkeys@​0.15.1

... (truncated)

Changelog

Sourced from @​tanstack/solid-hotkeys's changelog.

0.15.0

Minor Changes

• #189 dd1f39d - Types and functions now follow one naming rule: a hotkey is a chord or a sequence, a chord is keys pressed together, and a sequence is chords pressed one after another. A name with Hotkey alone accepts both kinds. Names for one kind say Chord or Sequence.

  Hotkey callbacks receive a context with the same chord and sequence shapes as registration views. A chord's callback gets { kind: 'chord', hotkey, parsedChord }. A sequence's callback gets { kind: 'sequence', hotkey, parsedSequence } with every step parsed. Before, a sequence's parsedHotkey held only its last step. The recorder's validate context is split the same way: { kind: 'chord', event, parsedChord } or { kind: 'sequence', events, parsedSequence }.

  useHotkey, HotkeyManager.register, the Lit @hotkey decorator, and the other APIs that take one hotkey type the context from the hotkey you pass, so a chord's callback can read parsedChord without a check. Callbacks in useHotkeys arrays, and callbacks typed HotkeyCallback, receive either shape. Check context.kind before reading parsedChord or parsedSequence. A one-step array such as ['Escape'] now gets chord options and chord context, which matches how it registers.

  Sequence steps can be chord objects as well as strings, such as [{ key: 'K', mod: true }, 'C']. The new RegisterableHotkeySequence type describes them. Registered sequences store each step as a string.

  Every step that advances a sequence now calls preventDefault, not only the last one. In ['Mod+K', 'Mod+C'], the browser no longer runs its own Ctrl+K on the first step. stopPropagation still applies only on the last step, so earlier steps reach other listeners. To let the browser act on every step, set preventDefault: false.

  A sequence's progress now clears when its timeout passes, and registration subscribers are notified. Before, progress cleared only on the next key press, so matchedStepCount could stay above 0 after the timeout.

  Renamed:

  • RawHotkey to RawHotkeyChord
  • ParsedHotkey to ParsedHotkeyChord
  • SingleModifierHotkey, TwoModifierHotkey, ThreeModifierHotkey, and FourModifierHotkey to SingleModifierHotkeyChord, TwoModifierHotkeyChord, ThreeModifierHotkeyChord, and FourModifierHotkeyChord
  • parsedHotkey to parsedChord on chord registration views, callback contexts, and recorder validation contexts
  • createHotkeyHandler to createHotkeyChordHandler, createMultiHotkeyHandler to createMultiHotkeyChordHandler, MultiHotkeyHandler to MultiHotkeyChordHandler, and CreateHotkeyHandlerOptions to CreateHotkeyChordHandlerOptions

  Merged:

  • parseHotkey parses chord strings, chord objects, and sequences. It replaces parseRegisterableHotkey and rawHotkeyToParsedHotkey.
  • normalizeHotkey normalizes chord strings, chord objects, parsed chords, and sequences. It replaces normalizeRegisterableHotkey and normalizeHotkeyFromParsed. Replace normalizeHotkeyFromEvent(event) with normalizeHotkey(parseKeyboardEvent(event)).
  • formatHotkey also formats a parsed sequence, returning one string per step.

• #189 dd1f39d - Add hotkey scopes, which turn groups of hotkeys on and off together, such as everything in a dialog.

  • Every hotkey belongs to a scope. The default scope, 'global', is always active. Pass scope to a hotkey to put it in another scope.
  • HotkeyManager.activateScope(scope, options) activates a scope until you call the function it returns. When hotkeys in two active scopes match the same key, a nested scope beats the scopes around it, and otherwise the most recently activated scope wins.
  • An exclusive scope suspends every other scope, including 'global', while it's active. Pass exclusive: { allow: ['global'] } to keep some scopes working.
  • HotkeyManager.scopes publishes which scopes are active, suspended, allowed, and exclusive. isScopeActive(scope) reports whether a scope's hotkeys can fire.
  • In React, Preact, Solid, Vue, Svelte, and Octane, HotkeysProvider takes scope, exclusive, and enabled. Hotkeys registered inside a scoped provider belong to its scope, which is active while the provider is mounted and enabled. Vue's provideHotkeysContext and Svelte's setHotkeysContext take the same options. In Angular, pass them to provideHotkeys in a component's providers.
  • In Lit, Alpine, and Ember, activate scopes with the hotkey manager, and pass scope to the hotkeys that belong to them.
  • App hotkeys can declare a scope. App hotkeys in different scopes can share a hotkey without a conflict. The app hotkey list reports 'suspended' for an app hotkey whose enabled registrations are all in inactive scopes.
  • Devtools group registrations by scope and show which scopes are active, suspended, allowed, or exclusive.

Patch Changes

• Updated dependencies [dd1f39d, dd1f39d]:
  • @​tanstack/hotkeys@​0.16.0

0.14.5

Patch Changes

... (truncated)

Commits

• ad56a4b ci: Version Packages (#190)
• dd1f39d feat(hotkeys): Add hotkey scopes, chord and sequence naming, and new guides (...
• 2a5a38a ci: Version Packages (#188)
• 9263ac7 ci: Version Packages (#186)
• 5ce675b ci: Version Packages (#181)
• f8f02f0 feat(hotkeys): Add capture-phase shortcut registration (#167)
• 82fe836 ci: Version Packages (#180)
• 1a4bc38 ci: Version Packages (#179)
• 72f5d4c ci: Version Packages (#176)
• a71180e feat: Unify hotkeys and sequences, and add app hotkeys (#175)
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

[dependabot]

Superseded by #10.