Inline message
An inline message lets users know when important information is available or when an action is required.Installation
| Install | yarn add @atlaskit/inline-message |
|---|---|
| Source | Bitbucket.org, (opens new window) |
| npm | @atlaskit/inline-message, (opens new window) |
| Bundle | unpkg.com, (opens new window) |
Props
| Description | Set the icon to be used before the title. Options are: connectivity, confirmation, info, warning, and error. |
|---|---|
| Default | "connectivity" |
| Type | "connectivity" | "confirmation" | "info" | "warning" | "error" |
| Description | The elements to be displayed by the popup. |
|---|---|
| Type | string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal |
| Description | This is a list of backup placements for the popup to try. When the preferred placement doesn't have enough space, the modifier will test the ones provided in the list, and use the first suitable one. If no fallback placements are suitable, it reverts back to the original placement. @private
No-op when |
|---|---|
| Type | PopupPlacement[] |
| Description | Text to be used as the label for the button icon. You must use this to provide information for people who use assistive technology when there is no title and/or secondaryText. |
|---|---|
| Type | string |
| Description | The placement to be passed to the popup. Determines where around the text the dialog is displayed. |
|---|---|
| Default | "bottom-start" |
| Type | AutoPlacement | BasePlacement | VariationPlacement |
| Description | Text to display second. |
|---|---|
| Default | "" |
| Type | string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal |
| Description | The spacing of the underlying icon button. Options are: spacious and compact. |
|---|---|
| Default | "spacious" |
| Type | "spacious" | "compact" |
| Description | A unique string that appears as a data attribute, The value of
|
|---|---|
| Type | string |
| Description | Text to display first, bolded for emphasis. |
|---|---|
| Default | "" |
| Type | string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal |