• Log inStart now

HeadingText

Usage

import { HeadingText } from 'nr1'

Examples

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 of
HeadingText.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 of
HeadingText.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 attribute. Use it to target the component in unit and E2E tests.

For a test id to be valid, prefix it with your nerdpack id, followed up by a dot.

For example, my-nerdpack.some-element.

Note: You might not see data-test-id attributes as they are removed from the DOM, to debug them pass a e2e-test query parameter to the URL.

typeenum
DEFAULT
HeadingText.TYPE.HEADING_4

Type of text that you want to display.

This applies styles according to the type.

<One of
HeadingText.TYPE.HEADING_1,
HeadingText.TYPE.HEADING_2,
HeadingText.TYPE.HEADING_3,
HeadingText.TYPE.HEADING_4,
HeadingText.TYPE.HEADING_5,
HeadingText.TYPE.HEADING_6,
>
Copyright © 2022 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.