UNPKG

a17t

Version:

Atomic design toolkit. Build beautiful interfaces without reinventing the wheel. Tailwind CSS plugin.

43 lines (30 loc) 1.28 kB
--- layout: element tab: elements subtab: element-kbd category: Typography title: Kbd description: An inline element for representing the keyboard source: https://github.com/milesmcc/a17t/blob/master/src/typography/kbd.js selectors: - .kbd display: Inline examples: - "To print, press <kbd class='kbd'>Cmd</kbd> + <kbd class='kbd'>P</kbd>" --- # Overview The kbd element makes text look like a button on the keyboard (perhaps not skeuomorphically, but at least figuratively). Inside of a [content element](/typography/content), it is applied to the `<kbd>` tag automatically. It applies a dark background and a monospace font. # Considerations **Spacing** --- Unless used inside a content element, the kbd element defines no margin. That means that you'll need to manually position it inside your layout. # Variants Beyond customization, the kbd element has no variants. # Accessibility **Use with kbd (`<kbd>`) elements.** Using the `.kbd` element on `<kbd>` tags will help screenreaders and other assistive technologies better represent your content. {% include accessibility_defaults.html %} # Examples {% capture example %} Press <kbd class="kbd">F</kbd> to pay respects {% endcapture %} {% include example.html code=example %} {% include todo_more.html %}