spark/com.adevinta.spark.components.snackbars/SnackbarHostState/showSnackbar

showSnackbar

suspend fun showSnackbar(message: String, actionLabel: String? = null, icon: SparkIcon? = null, intent: SnackbarIntent = SnackbarDefaults.intent, style: SnackbarStyle = SnackbarDefaults.style, withDismissAction: Boolean = false, actionOnNewLine: Boolean = false, duration: SnackbarDuration = if (actionLabel == null) { SnackbarDuration.Short } else { SnackbarDuration.Indefinite }): SnackbarResult

Shows or queues to be shown a Snackbar at the bottom of the Scaffold to which this state is attached and suspends until the snackbar has disappeared.

SnackbarHostState guarantees to show at most one snackbar at a time. If this function is called while another snackbar is already visible, it will be suspended until this snackbar is shown and subsequently addressed. If the caller is cancelled, the snackbar will be removed from display and/or the queue to be displayed.

To change the Snackbar appearance, change it in 'snackbarHost' on the Scaffold.

Return

SnackbarResult.ActionPerformed if option action has been clicked or SnackbarResult.Dismissed if snackbar has been dismissed via timeout or by the user

Parameters

message

The message to display in the Snackbar.

icon

The icon to display in the Snackbar.

intent

The intent of the Snackbar.

style

The style of the Snackbar.

actionLabel

optional action label to show as button in the Snackbar

withDismissAction

a boolean to show a dismiss action in the Snackbar. This is recommended to be set to true for better accessibility when a Snackbar is set with a SnackbarDuration.Indefinite

duration

duration to control how long snackbar will be shown in SnackbarHost, either SnackbarDuration.Short, SnackbarDuration.Long or SnackbarDuration.Indefinite.

suspend fun showSnackbar(visuals: SnackbarSparkVisuals): SnackbarResult

Shows or queues to be shown a Snackbar at the bottom of the Scaffold to which this state is attached and suspends until the snackbar has disappeared.

SnackbarHostState guarantees to show at most one snackbar at a time. If this function is called while another snackbar is already visible, it will be suspended until this snackbar is shown and subsequently addressed. If the caller is cancelled, the snackbar will be removed from display and/or the queue to be displayed.

Return

SnackbarResult.ActionPerformed if option action has been clicked or SnackbarResult.Dismissed if snackbar has been dismissed via timeout or by the user

Parameters

visuals

SnackbarSparkVisuals that are used to create a Snackbar