Keyboard command hints
Present discoverable command shortcuts in a scannable reference panel.
Live preview
- Open search
- Ctrl + K
- Close dialog
- Esc
- Navigate tabs
- ← →
HTML
<dl class="xsh-command-list">
<div>
<dt>Open search</dt>
<dd>
<kbd class="xsh-kbd">Ctrl</kbd> + <kbd class="xsh-kbd">K</kbd>
</dd>
</div>
<div>
<dt>Close dialog</dt>
<dd>
<kbd class="xsh-kbd">Esc</kbd>
</dd>
</div>
<div>
<dt>Navigate tabs</dt>
<dd>
<kbd class="xsh-kbd">←</kbd> <kbd class="xsh-kbd">→</kbd>
</dd>
</div>
</dl>Installation & markup
Include the local stylesheet and script once on the page, then place the component inside a data-xsh-ui root. The example above works without a build system.
<link rel="stylesheet" href="/dist/xshna-ui.css">
<div data-xsh-ui>
<!-- Add the HTML example above -->
</div>
<script defer src="/dist/xshna-ui.js"></script>Component API
Public classes, attributes and hooks used by this example. Keep the xsh- prefix intact.
| Identifier | Contract |
|---|---|
xsh-command-list | Used by the example markup and component styles or behavior. |
kbd | Used by the example markup and component styles or behavior. |
Accessibility & keyboard
This is a descriptive hint list; the site search shortcut is implemented.
Implementation note. Only advertise keyboard shortcuts that are actually connected to an action.
Interaction contract
Behavioral components use the shared delegated runtime; visual-only primitives rely on semantic HTML and CSS. Runtime controls emit bubbling xsh:* CustomEvents; bind application handlers to those events when server persistence, API data or navigation is required.