FoundationsInteractive playground
Kbd
Display readable keyboard shortcuts.
Preparing the playground…
Text and Markdown example
Kbd · Example
1<div style={{ display: "flex", alignItems: "center", gap: 12, flexWrap: "wrap" }}>
2 <Kbd>⌘</Kbd><Kbd>K</Kbd>
3</div>How to use it
Describe an existing shortcut in your application. Kbd only displays the keys; register the keyboard event in your own code.
Import
React / Next.js
1import { Kbd } from "@kivora/nextjs";Interactive examples run inside a component with "use client". The playground's Copy button includes the imports needed for the current example.
API reference 0.2.0
Types from the installed published version, including component properties and common HTML attributes. “Optional” does not imply a default value; omitting a property lets the component decide.
| Property | Type | Description |
|---|---|---|
aria-label | string | Accessible name of the control. |
children | ReactNode | Content or child elements of the component. |
className | string | Additional CSS classes to customize the element. |
defaultChecked | boolean | Initial selection of the control. |
defaultValue | string | number | readonly string[] | Initial value when the component manages its own state. |
id | string | Element identifier; associates labels and descriptions. |
onChange | ChangeEventHandler<HTMLElement, Element> | Change event. Check the type: some controls return an object, others a DOM event. |
onClick | MouseEventHandler<HTMLElement> | Action performed when the element is activated. |
onSubmit | SubmitEventHandler<HTMLElement> | Form submission event. |
role | AriaRole | Semantic role of the element. Keep the default role unless a change is justified. |
size | "sm" | "lg" | "md" | null | Visual size of the component. |
style | CSSProperties | React inline styles. |
tabIndex | number | Keyboard focus order and availability. |
title | string | Title or supplementary information. |
variant | "default" | "outline" | "solid" | null | Visual variant. Use a value supported by this component. |
TypeScript definition
Review each component's properties and published declaration. Native and accessibility attributes are inherited from the element specified by its type.
Kbd15 properties
Kbd · TypeScript
1Kbd: React.ForwardRefExoticComponent<KbdProps & React.RefAttributes<HTMLElement>>API generated from @kivora/nextjs 0.2.0View package