Skip to main content

Keyboard

Renders keyboard shortcut keys with consistent styling.

VEF-specific component. Not part of Ant Design.

Basic Usage

import { Keyboard } from '@vef-framework-react/components';

export default function Demo() {
return (
<span>
Press <Keyboard>Ctrl</Keyboard> + <Keyboard>K</Keyboard> to search
</span>
);
}

Sizes

import { Keyboard, Space } from '@vef-framework-react/components';

export default function Demo() {
return (
<Space>
<Keyboard size="small">Esc</Keyboard>
<Keyboard>Enter</Keyboard>
<Keyboard size="large">Space</Keyboard>
</Space>
);
}

API

Keyboard extends all native <kbd> element props, plus:

PropTypeDefaultDescription
size'small' | 'middle' | 'large''middle'Key size
childrenReactNodeKey label
classNamestringCSS class
styleCSSPropertiesInline style