HeadingText

Typography styles are used throughout the UI. If used consistently they will help you maintain a hierarchy that is clear to your users.

Usage

import { HeadingText } from 'nr1'

Examples

Basic

<>
  <HeadingText>Heading 4 (default)</HeadingText>
</>;

1
<>
2
  <HeadingText>Heading 4 (default)</HeadingText>
3
</>;

ReferenceError: HeadingText is not defined

Basic

<>
  <HeadingText type={HeadingText.TYPE.HEADING_1}>Heading 1</HeadingText>
  <HeadingText type={HeadingText.TYPE.HEADING_2}>Heading 2</HeadingText>
  <HeadingText type={HeadingText.TYPE.HEADING_3}>Heading 3</HeadingText>
  <HeadingText type={HeadingText.TYPE.HEADING_4}>Heading 4</HeadingText>
  <HeadingText type={HeadingText.TYPE.HEADING_5}>Heading 5</HeadingText>
  <HeadingText type={HeadingText.TYPE.HEADING_6}>Heading 6</HeadingText>
</>;

1
<>
2
  <HeadingText type={HeadingText.TYPE.HEADING_1}>Heading 1</HeadingText>
3
  <HeadingText type={HeadingText.TYPE.HEADING_2}>Heading 2</HeadingText>
4
  <HeadingText type={HeadingText.TYPE.HEADING_3}>Heading 3</HeadingText>
5
  <HeadingText type={HeadingText.TYPE.HEADING_4}>Heading 4</HeadingText>
6
  <HeadingText type={HeadingText.TYPE.HEADING_5}>Heading 5</HeadingText>
7
  <HeadingText type={HeadingText.TYPE.HEADING_6}>Heading 6</HeadingText>
8
</>;

ReferenceError: HeadingText is not defined

Changing semantic

<HeadingText
  type={HeadingText.TYPE.HEADING_1}
  tagType={HeadingText.TAG_TYPE.DIV}
>
  This is a div element styled as a h1
</HeadingText>;

1
<HeadingText
2
  type={HeadingText.TYPE.HEADING_1}
3
  tagType={HeadingText.TAG_TYPE.DIV}
4
>
5
  This is a div element styled as a h1
6
</HeadingText>;

ReferenceError: HeadingText is not defined

Props

childrennode

Text to display.

classNamestring

Appends class names to the component.

Should be used only for positioning and spacing purposes.

spacingTypeenum[]

Spacing property. Spacing is defined as a tuple of zero to four values, which follow the same conventions as CSS properties like margin or padding. To omit a value, use SPACING_TYPE.OMIT.

<Array of<One ofHeadingText.SPACING_TYPE.EXTRA_LARGE,
HeadingText.SPACING_TYPE.LARGE,
HeadingText.SPACING_TYPE.MEDIUM,
HeadingText.SPACING_TYPE.NONE,
HeadingText.SPACING_TYPE.OMIT,
HeadingText.SPACING_TYPE.SMALL,
>
>

styleobject

Inline style for custom styling.

Should be used only for positioning and spacing purposes.

tagTypeenum

Tag in which to wrap the text.

Useful for changing the semantic meaning of the text. This does not apply any style.

<One ofHeadingText.TAG_TYPE.DIV,
HeadingText.TAG_TYPE.H1,
HeadingText.TAG_TYPE.H2,
HeadingText.TAG_TYPE.H3,
HeadingText.TAG_TYPE.H4,
HeadingText.TAG_TYPE.H5,
HeadingText.TAG_TYPE.H6,
>

testIdstring

Adds a data-test-id.

Used to target the component in unit and e2e testing.

typeenum

DEFAULT

HeadingText.TYPE.HEADING_4

Type of text that you want to display.

This applies styles according to the type.

<One ofHeadingText.TYPE.HEADING_1,
HeadingText.TYPE.HEADING_2,
HeadingText.TYPE.HEADING_3,
HeadingText.TYPE.HEADING_4,
HeadingText.TYPE.HEADING_5,
HeadingText.TYPE.HEADING_6,
>

Methods

`HeadingText.render`

function () => undefined