• /
  • Log in
  • Free account

Steps

Usage

import { Steps } from 'nr1'

Examples

Props

childrenrequirednode

Steps items to render inside the component.

classNamestring

Appends class names to the component.

Should be used only for positioning and spacing purposes.

defaultValueany

The initial step that should be active.

onChangefunction

Function called when the user clicks over a step.

function (
event: React.MouseEvent,

Event source of the callback.

stepValue: any

The value of the step.

)
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
Steps.SPACING_TYPE.EXTRA_LARGE,
Steps.SPACING_TYPE.LARGE,
Steps.SPACING_TYPE.MEDIUM,
Steps.SPACING_TYPE.NONE,
Steps.SPACING_TYPE.OMIT,
Steps.SPACING_TYPE.SMALL,
>
>
styleobject

Inline style for custom styling.

Should be used only for positioning and spacing purposes.

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.

valueany

The step with the matching value will be marked as active. Active steps are automatically expanded. If you don't want the step to be expanded you should mark it as disabled.

If defined, it turns the component into a controlled component.

Create issueEdit page
Copyright © 2021 New Relic Inc.