ConfirmationDefaults
object ConfirmationDefaults
Contains default values used by Confirmation composable.
Summary
Constants |
|
|---|---|
const Long |
ConfirmationDurationMillis = 4000Default timeout for the |
Public functions |
|
|---|---|
ConfirmationColors |
Creates a |
ConfirmationColors |
@ComposableCreates a |
CurvedScope.() -> Unit |
@ComposableA default composable that displays text along a curved path, used in |
ConfirmationColors |
Creates a |
ConfirmationColors |
@ComposableCreates a |
CurvedScope.() -> Unit |
Returns a lambda to display a curved failure message. |
ConfirmationColors |
Creates a |
ConfirmationColors |
@ComposableCreates a |
CurvedScope.() -> Unit |
Returns a lambda to display a curved success message. |
Public properties |
|
|---|---|
@Composable BoxScope.() -> Unit |
A default composable used in |
Dp |
Default icon size for the |
Dp |
Default icon size for the |
@Composable BoxScope.() -> Unit |
A default composable used in |
Constants
ConfirmationDurationMillis
const val ConfirmationDurationMillis = 4000: Long
Default timeout for the Confirmation dialog, in milliseconds.
Public functions
confirmationColors
@Composable
fun confirmationColors(): ConfirmationColors
Creates a ConfirmationColors that represents the default colors used in a Confirmation.
confirmationColors
@Composable
fun confirmationColors(
iconColor: Color = Color.Unspecified,
iconContainerColor: Color = Color.Unspecified,
textColor: Color = Color.Unspecified
): ConfirmationColors
Creates a ConfirmationColors with modified colors used in Confirmation.
curvedText
@Composable
fun curvedText(
text: String,
style: CurvedTextStyle = CurvedTextStyle(MaterialTheme.typography.titleLarge)
): CurvedScope.() -> Unit
A default composable that displays text along a curved path, used in Confirmation.
| Parameters | |
|---|---|
text: String |
The text to display. |
style: CurvedTextStyle = CurvedTextStyle(MaterialTheme.typography.titleLarge) |
The style to apply to the text. Defaults to CurvedTextStyle(MaterialTheme.typography.titleLarge). |
failureColors
@Composable
fun failureColors(): ConfirmationColors
Creates a ConfirmationColors that represents the default colors used in a FailureConfirmation.
failureColors
@Composable
fun failureColors(
iconColor: Color = Color.Unspecified,
iconContainerColor: Color = Color.Unspecified,
textColor: Color = Color.Unspecified
): ConfirmationColors
Creates a ConfirmationColors with modified colors used in FailureConfirmation.
failureText
@Composable
fun failureText(): CurvedScope.() -> Unit
Returns a lambda to display a curved failure message. The failure message is retrieved from the application's string resources.
successColors
@Composable
fun successColors(): ConfirmationColors
Creates a ConfirmationColors that represents the default colors used in a SuccessConfirmation.
successColors
@Composable
fun successColors(
iconColor: Color = Color.Unspecified,
iconContainerColor: Color = Color.Unspecified,
textColor: Color = Color.Unspecified
): ConfirmationColors
Creates a ConfirmationColors with modified colors used in SuccessConfirmation.
successText
@Composable
fun successText(): CurvedScope.() -> Unit
Returns a lambda to display a curved success message. The success message is retrieved from the application's string resources.
Public properties
FailureIcon
val FailureIcon: @Composable BoxScope.() -> Unit
A default composable used in FailureConfirmation that displays a failure icon with an animation.
IconSize
val IconSize: Dp
Default icon size for the Confirmation with curved content
SmallIconSize
val SmallIconSize: Dp
Default icon size for the Confirmation with linear content
SuccessIcon
val SuccessIcon: @Composable BoxScope.() -> Unit
A default composable used in SuccessConfirmation that displays a success icon with an animation.