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

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.

StatusLozenge

To add the StatusLozenge component to your app:

1
2
import { StatusLozenge } from '@forge/react';

Description

A lozenge to show a status.

You can only use this component as a child element with Text as the parent component.

Props

NameTypeRequiredDescription
childrenstringYesThe text content of the status lozenge.
appearancestringThe appearance of the status lozenge. Valid values are default, inprogress, moved, new, removed, and success. Defaults to default.

Example

A text component with text content and a nested StatusLozenge component.

1
2
<Text>
  You have 4 tickets: <StatusLozenge appearance="inprogress">In progress</StatusLozenge>
</Text>

Output

Example image of rendered status lozenge

Rate this page: