Kbd

Server component, no client JS

ImportCopy Anchor Link

import { Kbd } from '@nizivo/react/kbd';

// Once per app (Getting started), after
// @nizivo/tokens/tokens.css and @nizivo/react/css/base.css
import '@nizivo/react/css/kbd.css';

Static or interactiveCopy Anchor Link

Server. It ships no client JavaScript when a Server Component renders it, in every Next.js build mode; its code is bundled only when a client component (a 'use client' file) imports it. It renders both platforms' keys and CSS shows one, from the data-nz-platform attribute that ThemeScript sets; without ThemeScript the Ctrl spelling shows. How to choose.

In a client app (a Vite or React Router single-page app, or a 'use client' file) it is an ordinary React component: event handlers, refs and state work as usual. In a client app.

ExamplesCopy Anchor Link

import type { JSX } from 'react';
import { Kbd } from '@nizivo/react/kbd';

export function KbdExample(): JSX.Element {
  return (
    <p>
      Search with <Kbd keys="mod+k" />, duplicate with <Kbd keys="mod+shift+d" />, move with{' '}
      <Kbd>↑↓</Kbd> and close with <Kbd keys="esc" />.
    </p>
  );
}

PropsCopy Anchor Link

Other exportsCopy Anchor Link

KbdPlatform type

import type { KbdPlatform } from '@nizivo/react/kbd'

The data-platform values of the glyph spans; they match data-nz-platform (§8.3).

type KbdPlatform = "apple" | "other"

KbdProps type

import type { KbdProps } from '@nizivo/react/kbd'

The props of Kbd, listed above.

Data attributes and slotsCopy Anchor Link

Style parts by class (.nz-<slot>) and state by data attribute. Attribute meanings come from contracts/vocabulary.json.

CSS hooksCopy Anchor Link

Set a hook on the component's class or any ancestor to restyle it without specificity games; leave it unset for the default shown.

Layers: nz.components. Classes: .nz-kbd, .nz-kbd-glyphs.

AccessibilityCopy Anchor Link

Nothing in this component takes focus or keyboard input.

KeyboardCopy Anchor Link

None.

FigmaCopy Anchor Link

Node ids from design/component-map.json, which nz gen writes from component.json. The links open the Nizivo Figma library, which may ask you to sign in.

• Canonical: none
• Ghost masters: none