TipBox

A tinted hint box for tips and shortcuts, with built-in kbd styling.

Import

import { TipBox } from "@gumtree/ui/TipBox";

Props

PropTypeDefaultDescription
labelstring"Tip:"Bold label prefix
childrenComponentChildren-Tip content, supports <kbd> elements

Examples

Default

A tip box with keyboard shortcuts.

Tip: Press / to search, g d for dashboard, or ? for all shortcuts.
<TipBox>
  Press <kbd>/</kbd> to search, <kbd>g</kbd> <kbd>d</kbd> for dashboard, or <kbd>?</kbd> for all shortcuts.
</TipBox>

Custom Label

Use a different label prefix.

Note: Repository names must be unique within an organisation.
<TipBox label="Note:">
  Repository names must be unique within an organisation.
</TipBox>