About UI Kit 2
UI Kit 2 components
UI kit components
Product bridge APIs
Jira bridge APIs

Text

A piece of plain text with basic text formatting options.

It can also include inline components such as Badge, DateLozenge, and StatusLozenge.

Screenshot of what the rendered text should look like

Deprecation notice

Markdown syntax has been deprecated and removed on 23 March 2021 in the @forge/ui@0.9.0 release. Apps that use @forge/ui must use markup components.

Usage notes

The text formatting options are listed here.

Import statement

1
2
import ForgeUI, { Text } from '@forge/ui';

Props

NameTypeRequiredDescription
childrenstring | ForgeInlineComponentYesThe text and inline components to display.

Example

1
2
import ForgeUI, { Text, Strong } from '@forge/ui';

<Text>
  Some <Strong>bold text</Strong>
</Text>

Heading

A piece of text at the top of a page or section.

Screenshot of what the rendered heading should look like

Import statement

1
2
import ForgeUI, { Heading } from '@forge/ui';

Props

NameTypeRequiredDescription
childrenstringYesThe text of the heading.
size'small' | 'medium' | 'large'The size of the heading. Defaults to medium.

Example

1
2
<Heading size="large">Title</Heading>
<Text>
    Paragraph text goes here.
</Text>

This section describes a Forge preview feature. Preview features are deemed stable; however, they remain under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments.

We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more information, see Forge release phases: EAP, Preview, and GA.

Rate this page: