Documentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
KBD
In progress | Storybook link coming soonWhen to use
- To accelerate common tasks for power users.
- When an action is frequently repeated and benefits from faster execution.
- To complement menu items and Buttons by offering an alternative input method.
When to use something else
- For critical actions without clear undo (e.g., delete all), unless safeguarded by confirmation—prefer explicit Button or Dialog flows.
- As the only means of accessing an action; always provide a visible control (Button, Menu item).
- Where discoverability matters and users won’t learn shortcuts.
- When key chords would conflict with the browser, OS, or assistive tech.
Dos and don’ts
- Do use letters for meaning. Letters make shortcuts more memorable, as they can convey meaning (e.g., C for Comments).
- Do always use modifiers (e.g., ⌘, Ctrl) with letters to prevent accidental triggers and to avoid overriding focus states.
- Do show shortcuts next to the action they trigger, e.g., inside Menus, Dialogs, or Tooltips.
- Do be selective: Not every action needs a shortcut. Consider how often users perform the action and where its trigger point is in the UI.
- Don’t use two-letter shortcuts: Two-letter shortcuts can conflict with single-letter ones.
- Don’t override native Shortcuts: Respect browser and OS defaults to avoid confusion and conflicts.
- Don’t assign shortcuts to critical actions (like “Delete all”) without an undo or confirmation option.
Behavior
- Decorative display of key chords next to actions; implementing code must register the same shortcuts they surface in UI.
- Modifiers reduce accidental activation; single-letter chords without modifiers are risky in text fields.