HelixOverviewDocsComponentsSandboxTheme builderCortexDocsEngramBuildingTraceBuildingRecallDeclaredServicesInsightsGet in touchSource on GitHub
Loading the reference
KbdView SourceEdit in SandboxView MarkdownCopy MarkdownOpen in ClaudeOpen in CursorA keyboard key or chord, set inline with text.StableSince 0.1.0TypographyUsageimport'@fusion.dev/helix/kbd'import'@fusion.dev/helix-headless/kbd'Preview
API ReferenceRoothelix-kbdA keyboard key or chord, set inline with text.
PropTypeDefaultDescriptionkeysstring""The chord, written plainly: `mod+k`, `shift+?`, `/`.within"control"|"document"Where the chord is listened for, and whether it is listened for at all.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The key's label, where `keys` is not set.
EventTypeDescriptionhelix-shortcutHelixShortcutEventFired when the chord is pressed, and cancelable.
PartDescriptionkbdThe key.
CSS PropertyDescription--kbd-background-colorFill of the key.--kbd-border-colorColor of the hairline and the edge.
Roothelix-headless-kbdA keyboard key or chord, set inline with text.
PropTypeDefaultDescriptionkeysstring""The chord, written plainly: `mod+k`, `shift+?`, `/`.within"control"|"document"Where the chord is listened for, and whether it is listened for at all.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The key's label, where `keys` is not set.
EventTypeDescriptionhelix-shortcutHelixShortcutEventFired when the chord is pressed, and cancelable.
PartDescriptionkbdThe key.
ExamplesNameDescriptionEventsA key that binds as well as draws, and says so where it is bound.PreviewA key, and a chord of keys, as a reader would see them written.PreviewA key, and a chord of keys, as a reader would see them written.ShortcutA chord written once, drawn for whichever keyboard is reading it.ShortcutA chord written once, drawn for whichever keyboard is reading it.