Key icon v0.1.0 · @behivetech

The key icon: a 24 by 24 stroke glyph that takes its colour from the text around it.

Usage

1import { KeyIcon } from '@behivetech/icons.key';
2
3<KeyIcon />
4<KeyIcon size="lg" titleAccess="Key" />

The icon is hidden from assistive technology unless it is named: pass titleAccess (rendered as the svg's <title>) or aria-label. It sizes through size (sm, md, lg, xl) with the stylesheet of @behivetech/icons.base, which the app imports once. The default export is the same component.

Examples

Open all 2 →

Key Icon Sizes

1const KeyIconSizes = () => (
2  <>
3    <KeyIcon size="sm" />
4    <KeyIcon />
5    <KeyIcon size="lg" />
6    <KeyIcon size="xl" />
7  </>
8);
9
10render(<KeyIconSizes />);

Named Key Icon

1const NamedKeyIcon = () => <KeyIcon titleAccess="Key" />;
2
3render(<NamedKeyIcon />);

Properties

`KeyIcon` props

Prop	Type	Default	Description
`className`	`string`	—	Additional class names to merge with the component root element
`ref`	`Ref<SVGSVGElement>`	—	Ref to the root svg element
`size`	`"sm" \| "md" \| "lg" \| "xl"`	—	Controls width/height; defaults to md
`titleAccess`	`string`	—	Accessible name of the icon, rendered as the svg's `<title>`. When set the icon is exposed as an image with this name; without it (and without `aria-label` or `aria-labelledby`) the icon is decorative and hidden from assistive technology. Pass an already translated string.

Functions

`KeyIcon` function

The key icon: a stroke glyph on a 24 by 24 grid that inherits the text colour.

KeyIcon(props: import("@behivetech/icons.base").IconBaseProps): import("react").ReactNode

Parameter	Type	Default	Description
`props`	`import("@behivetech/icons.base").IconBaseProps`	—	—

Returns import("react").ReactNode