object OutlinedButtonDefaults
Properties
val ContentPadding =
PaddingValues(
start = ButtonHorizontalPadding,
top = ButtonVerticalPadding,
end = ButtonHorizontalPadding,
bottom = ButtonVerticalPadding,
)
val IconSize = 20.dp
The default size of the icon when used inside any button.
val IconSpacing = 8.dp
The default size of the spacing between an icon and a text when they used inside any button.
val ButtonWithIconContentPadding =
PaddingValues(
start = ButtonWithIconHorizontalStartPadding,
top = ButtonVerticalPadding,
end = ButtonHorizontalPadding,
bottom = ButtonVerticalPadding,
)
The default content padding used by OutlinedButton that contains an Icon.
Functions
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 an OutlinedButton.
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. |
colors
@ReadOnlyComposable
@Composable
fun colors(
containerColor: Color = Color.Transparent,
contentColor: Color = MaterialTheme.colorScheme.onSurface.copy(alpha = 0.8f),
focusedContainerColor: Color = MaterialTheme.colorScheme.onSurface,
focusedContentColor: Color = MaterialTheme.colorScheme.inverseOnSurface,
pressedContainerColor: Color = focusedContainerColor,
pressedContentColor: Color = focusedContentColor,
disabledContainerColor: Color = containerColor,
disabledContentColor: Color = MaterialTheme.colorScheme.onSurface.copy(alpha = 0.4f),
) =
ButtonColors(
containerColor = containerColor,
contentColor = contentColor,
focusedContainerColor = focusedContainerColor,
focusedContentColor = focusedContentColor,
pressedContainerColor = pressedContainerColor,
pressedContentColor = pressedContentColor,
disabledContainerColor = disabledContainerColor,
disabledContentColor = disabledContentColor,
)
Creates a ButtonColors that represents the default colors used in a OutlinedButton.
Parameters
| containerColor | the container color of this Button when enabled |
| contentColor | the content color of this Button when enabled |
| focusedContainerColor | the container color of this Button when enabled and focused |
| focusedContentColor | the content color of this Button when enabled and focused |
| pressedContainerColor | the container color of this Button when enabled and pressed |
| pressedContentColor | the content color of this Button when enabled and pressed |
| disabledContainerColor | the container color of this Button when not enabled |
| disabledContentColor | 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 an OutlinedButton. scales are 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(
border =
BorderStroke(
width = 1.5.dp,
color = MaterialTheme.colorScheme.onSurfaceVariant.copy(alpha = 0.4f),
),
shape = ContainerShape,
),
focusedBorder: Border =
Border(
border =
BorderStroke(
width = 1.65.dp,
color = MaterialTheme.colorScheme.onSurfaceVariant,
),
shape = ContainerShape,
),
pressedBorder: Border =
Border(
border =
BorderStroke(
width = 1.5.dp,
color = MaterialTheme.colorScheme.onSurfaceVariant,
),
shape = ContainerShape,
),
disabledBorder: Border =
Border(
border =
BorderStroke(
width = 1.5.dp,
color = MaterialTheme.colorScheme.onSurfaceVariant.copy(alpha = 0.2f),
),
shape = ContainerShape,
),
focusedDisabledBorder: Border = disabledBorder,
) =
ButtonBorder(
border = border,
focusedBorder = focusedBorder,
pressedBorder = pressedBorder,
disabledBorder = disabledBorder,
focusedDisabledBorder = focusedDisabledBorder,
)
Creates a ButtonBorder that represents the default Borders applied on an OutlinedButton 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 an OutlinedButton.
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 |