BlockText

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 { BlockText } from 'nr1'

Examples

Basic

<>
  <BlockText>
    Typography is at the core of <strong>great</strong> user interface design.
  </BlockText>
</>;

1
<>
2
  <BlockText>
3
    Typography is at the core of <strong>great</strong> user interface design.
4
  </BlockText>
5
</>;

ReferenceError: BlockText is not defined

Types

<>
  <BlockText type={BlockText.TYPE.NORMAL}>
    Typography is at the core of <strong>great</strong> user interface design.
  </BlockText>
  <BlockText type={BlockText.TYPE.PARAGRAPH}>
    Typography is at the core of <strong>great</strong> user interface design.
  </BlockText>
</>;

1
<>
2
  <BlockText type={BlockText.TYPE.NORMAL}>
3
    Typography is at the core of <strong>great</strong> user interface design.
4
  </BlockText>
5
  <BlockText type={BlockText.TYPE.PARAGRAPH}>
6
    Typography is at the core of <strong>great</strong> user interface design.
7
  </BlockText>
8
</>;

ReferenceError: BlockText is not defined

Changing semantic

<BlockText type={BlockText.TYPE.PARAGRAPH} tagType={BlockText.TYPE.DIV}>
  This is a div element styled as a paragraph
</BlockText>;

1
<BlockText type={BlockText.TYPE.PARAGRAPH} tagType={BlockText.TYPE.DIV}>
2
  This is a div element styled as a paragraph
3
</BlockText>;

ReferenceError: BlockText 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 ofBlockText.SPACING_TYPE.EXTRA_LARGE,
BlockText.SPACING_TYPE.LARGE,
BlockText.SPACING_TYPE.MEDIUM,
BlockText.SPACING_TYPE.NONE,
BlockText.SPACING_TYPE.OMIT,
BlockText.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 ofBlockText.TAG_TYPE.DIV,
BlockText.TAG_TYPE.P,
>

testIdstring

Adds a data-test-id.

Used to target the component in unit and e2e testing.

typeenum

DEFAULT

BlockText.TYPE.NORMAL

Type of text that you want to display.

This applies styles according to the type.

<One ofBlockText.TYPE.NORMAL,
BlockText.TYPE.PARAGRAPH,
>

Methods

`BlockText.render`

function () => undefined