Android
object WideButtonDefaults
Functions
Background
@Composable
fun Background(enabled: Boolean, interactionSource: MutableInteractionSource)
Default background for a WideButton
shape
fun shape(
shape: Shape = ContainerShape,
focusedShape: Shape = shape,
pressedShape: Shape = shape,
disabledShape: Shape = shape,
focusedDisabledShape: Shape = disabledShape,
) =
ButtonShape(
shape = shape,
focusedShape = focusedShape,
pressedShape = pressedShape,
disabledShape = disabledShape,
focusedDisabledShape = focusedDisabledShape,
)
Creates a ButtonShape that represents the default container shapes used in a WideButton
Parameters
| shape | the shape used when the Button is enabled, and has no other Interactions |
| focusedShape | the shape used when the Button is enabled and focused |
| pressedShape | the shape used when the Button is enabled pressed |
| disabledShape | the shape used when the Button is not enabled |
| focusedDisabledShape | the shape used when the Button is not enabled and focused |
contentColor
@ReadOnlyComposable
@Composable
fun contentColor(
color: Color = MaterialTheme.colorScheme.onSurface,
focusedColor: Color = MaterialTheme.colorScheme.inverseOnSurface,
pressedColor: Color = focusedColor,
disabledColor: Color = color,
) =
WideButtonContentColor(
contentColor = color,
focusedContentColor = focusedColor,
pressedContentColor = pressedColor,
disabledContentColor = disabledColor,
)
Creates a WideButtonContentColor that represents the default content colors used in a WideButton
Parameters
| color | the content color of this Button when enabled |
| focusedColor | the content color of this Button when enabled and focused |
| pressedColor | the content color of this Button when enabled and pressed |
| disabledColor | the content color of this Button when not enabled |
scale
fun scale(
@FloatRange(from = 0.0) scale: Float = 1f,
@FloatRange(from = 0.0) focusedScale: Float = 1.1f,
@FloatRange(from = 0.0) pressedScale: Float = scale,
@FloatRange(from = 0.0) disabledScale: Float = scale,
@FloatRange(from = 0.0) focusedDisabledScale: Float = disabledScale,
) =
ButtonScale(
scale = scale,
focusedScale = focusedScale,
pressedScale = pressedScale,
disabledScale = disabledScale,
focusedDisabledScale = focusedDisabledScale,
)
Creates a ButtonScale that represents the default scales used in a WideButton. Scale is used to modify the size of a composable in different Interaction states e.g. 1f (original) in default state, 1.2f (scaled up) in focused state, 0.8f (scaled down) in pressed state, etc.
Parameters
| scale | the scale to be used for this Button when enabled |
| focusedScale | the scale to be used for this Button when focused |
| pressedScale | the scale to be used for this Button when pressed |
| disabledScale | the scale to be used for this Button when disabled |
| focusedDisabledScale | the scale to be used for this Button when disabled and focused |
border
@ReadOnlyComposable
@Composable
fun border(
border: Border = Border.None,
focusedBorder: Border = border,
pressedBorder: Border = focusedBorder,
disabledBorder: Border = border,
focusedDisabledBorder: Border =
Border(
border = BorderStroke(width = 2.dp, color = MaterialTheme.colorScheme.border),
inset = 0.dp,
shape = ContainerShape,
),
) =
ButtonBorder(
border = border,
focusedBorder = focusedBorder,
pressedBorder = pressedBorder,
disabledBorder = disabledBorder,
focusedDisabledBorder = focusedDisabledBorder,
)
Creates a ButtonBorder that represents the default Borders applied on a WideButton in different Interaction states
Parameters
| border | the Border to be used for this Button when enabled |
| focusedBorder | the Border to be used for this Button when focused |
| pressedBorder | the Border to be used for this Button when pressed |
| disabledBorder | the Border to be used for this Button when disabled |
| focusedDisabledBorder | the Border to be used for this Button when disabled and focused |
glow
fun glow(glow: Glow = Glow.None, focusedGlow: Glow = glow, pressedGlow: Glow = glow) =
ButtonGlow(glow = glow, focusedGlow = focusedGlow, pressedGlow = pressedGlow)
Creates a ButtonGlow that represents the default Glows used in a WideButton
Parameters
| glow | the Glow behind this Button when enabled |
| focusedGlow | the Glow behind this Button when focused |
| pressedGlow | the Glow behind this Button when pressed |