Skip to content

CAP-PFM-CSH-003Reach common actions with keyboard shortcuts

Markdown

CAP-PFM-CSH-003

Reach common actions with keyboard shortcuts

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

KindCapabilityProduct areaPlatformModuleConsole Shell and NavigationRevision2

Read atreact-console baf6dae3services-platform ad3f6a65

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
Common actions remain reachable without pointer navigation.Search shortcuts respect the person’s search authority.
Surfaces
console

Controls

18 controls apply, from the corpus control catalogue.

TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-DAT-001 TC-DAT-003 TC-LOG-005 TC-PI-001 TC-PI-003 TC-PI-005 TC-PRV-001 TC-PRV-002 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

Permissions

KeyChecked atScope
console.quick-searchconsoletenant
platform.quick-search.readapitenant

Business Rules

7 rules, 4 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01must prove
Proposed
The console handles a recognized search command only when search is permitted and otherwise leaves the event to the browser.
no proof recorded yet
permissionconsoleobserved
02must prove
Proposed
Quick Search does not recognize bare K, Shift+K, Alt+K or a different modified letter as its search chord.
no proof recorded yet
validationconsoletest
react-console:lib/quick-search/__tests__/shortcut.test.ts#leaves a bare K alone, so typing a name never opens a dialog
03must prove
Proposed
An unmodified slash opens permitted Quick Search except when focus is in an input, textarea, select or editable element.
no proof recorded yet
policyconsoleobserved
04
Proposed
Command or Ctrl with comma navigates to Configuration’s first destination, while the same modifier with J toggles the assistant panel.
policyconsoleobserved
05
Proposed
Command or Ctrl with B toggles navigation between expanded and collapsed states.
policyconsoletest
react-console:e2e/layout/page-layouts.spec.ts#the keyboard shortcut collapses it too
06
Proposed
Quick Search labels its shortcut for Apple or other hardware, while Configuration’s menu label always uses the Command symbol.
policyconsoleobserved
07must prove
Proposed
The search-command matcher accepts Command with K or Ctrl with K on any device, including uppercase K.
no proof recorded yet
validationconsoletest
react-console:lib/quick-search/__tests__/shortcut.test.ts#accepts Cmd+K and Ctrl+K, whatever the machine is; lib/quick-search/__tests__/shortcut.test.ts#accepts an upper-case K, which is what some layouts report

Scenarios

IdGivenWhenThenProvenance
01Search is not permitted for the current person.They press Ctrl+K.The frame leaves the chord unhandled and opens no search dialog.observed
02Focus is in a contact-name input.The person enters a slash.The field receives the character without opening search.observed

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.