carbon/com.gabrieldrn.carbon.notification

Package-level declarations

Types

enum NotificationStatus : Enum<NotificationStatus>

Notification statuses are designed to convey the emotional tone of the information being communicated. Each status is associated with a specific color and icon, ensuring a consistent and universal user experience.

Functions

ActionableInlineNotification

@Composable

fun ActionableInlineNotification(title: String, body: String, actionLabel: String, status: NotificationStatus, onAction: () -> Unit, onClose: () -> Unit, modifier: Modifier = Modifier, highContrast: Boolean = false)

Inline notifications show up in task flows, to notify users of the status of an action or system. They usually appear at the top of the primary content area or close to the item needing attention.

ActionableToastNotification

@Composable

fun ActionableToastNotification(title: String, body: String, actionLabel: String, status: NotificationStatus, onAction: () -> Unit, onClose: () -> Unit, modifier: Modifier = Modifier, highContrast: Boolean = false)

Toast notifications are non-modal, time-based window elements used to display short messages; they usually appear at the top of the screen and disappear after a few seconds.

CalloutNotification

@Composable

fun CalloutNotification(body: AnnotatedString, status: NotificationStatus, modifier: Modifier = Modifier, title: String = "", highContrast: Boolean = false)

@Composable

fun CalloutNotification(body: String, status: NotificationStatus, modifier: Modifier = Modifier, title: String = "", highContrast: Boolean = false)

Callouts are used to highlight important information contextually within the contents of the page, and cannot be dismissed. Unlike other notification components they are not triggered by the user or system, rather they load with the contents of the page. They do not act as a feedback mechanism, they are persistent, and always present on the screen to provide necessary information to the user.

InlineNotification

@Composable

fun InlineNotification(title: String, body: String, status: NotificationStatus, onClose: () -> Unit, modifier: Modifier = Modifier, highContrast: Boolean = false)

Inline notifications show up in task flows, to notify users of the status of an action or system. They usually appear at the top of the primary content area or close to the item needing attention.

ToastNotification

@Composable

fun ToastNotification(title: String, body: String, status: NotificationStatus, onClose: () -> Unit, modifier: Modifier = Modifier, highContrast: Boolean = false, timestamp: String = "")

Toast notifications are non-modal, time-based window elements used to display short messages; they usually appear at the top of the screen and disappear after a few seconds.