Definitionscomponent

Definitions({ children, ...props }: DefinitionsProps): ReactElement
ParamType
propsDefinitionsProps
Props for Definitions — colour, gap, space, and typography variants plus optional children. required
Return
ReactElement

Description list — a sequence of term/value pairs rendered as a <dl>.

  • Children are raw <dt> / <dd> elements — <dt> is the term label, <dd> the value, stacked term-above-value.
  • The spacing between pairs is overridable via the --definitions-gap hook.

Examples

<Definitions><dt>Name</dt><dd>Acme</dd></Definitions>