@ExperimentalMaterial3ExpressiveApi
object ButtonGroupDefaults
Default values used by ButtonGroup
Properties
val ExpandedRatio = 0.15f
The default percentage, represented as a float, of the width of the interacted child element that will be used to expand the interacted child element as well as compress the neighboring children. By Default, standard button group will expand the interacted child element by 15% of its width and this will be propagated to its neighbors.
val HorizontalArrangement: Arrangement.Horizontal
The default Arrangement used between children for standard button group.
val ConnectedSpaceBetween: Dp
The default spacing used between children for connected button group
val connectedLeadingButtonShape: Shape
Default shape for the leading button in a connected button group
val connectedLeadingButtonPressShape: Shape
Default shape for the pressed state for the leading button in a connected button group.
val connectedTrailingButtonShape: Shape
Default shape for the trailing button in a connected button group
val connectedTrailingButtonPressShape: Shape
Default shape for the pressed state for the trailing button in a connected button group.
val connectedButtonCheckedShape = ShapeTokens.CornerFull
Default shape for the checked state for the buttons in a connected button group
val connectedMiddleButtonPressShape: Shape
Default shape for the pressed state for the middle buttons in a connected button group.
Functions
connectedLeadingButtonShapes
@Composable
fun connectedLeadingButtonShapes(
shape: Shape = connectedLeadingButtonShape,
pressedShape: Shape = connectedLeadingButtonPressShape,
checkedShape: Shape = connectedButtonCheckedShape,
): ToggleButtonShapes
Defaults button shapes for the start button in a ConnectedButtonGroup
connectedMiddleButtonShapes
@Composable
fun connectedMiddleButtonShapes(
shape: Shape = ShapeDefaults.Small,
pressedShape: Shape = connectedMiddleButtonPressShape,
checkedShape: Shape = connectedButtonCheckedShape,
): ToggleButtonShapes
Defaults button shapes for a middle button in a ConnectedButtonGroup. A middle button is a button that's not the start / end button in the button group.
connectedTrailingButtonShapes
@Composable
fun connectedTrailingButtonShapes(
shape: Shape = connectedTrailingButtonShape,
pressedShape: Shape = connectedTrailingButtonPressShape,
checkedShape: Shape = connectedButtonCheckedShape,
): ToggleButtonShapes
Defaults button shapes for the end button in a ConnectedButtonGroup.
OverflowIndicator
@Composable
fun OverflowIndicator(
menuState: ButtonGroupMenuState,
modifier: Modifier = Modifier,
enabled: Boolean = true,
shape: Shape = IconButtonDefaults.filledShape,
colors: IconButtonColors = IconButtonDefaults.filledIconButtonColors(),
interactionSource: MutableInteractionSource? = null,
)
Default overflow indicator for ButtonGroup. It uses a FilledIconButton. When clicked it will open the menu associated with the provided ButtonGroupMenuState.
Parameters
| menuState | the ButtonGroupMenuState used to show or dismiss the overflow menu. |
| modifier | Modifier to be applied to the overflow indicator |
| enabled | controls the enabled state of this icon button. When false, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services. |
| shape | defines the shape of this icon button's container |
| colors | IconButtonColors that will be used to resolve the colors used for this icon button in different states. See IconButtonDefaults.filledIconButtonColors. |
| interactionSource | an optional hoisted MutableInteractionSource for observing and emitting androidx.compose.foundation.interaction.Interactions for this icon button. You can use this to change the icon button's appearance or preview the icon button in different states. Note that if null is provided, interactions will still happen internally. |