carbon/com.gabrieldrn.carbon.button/IconButton

IconButton

@Composable
fun IconButton(iconPainter: Painter, onClick: () -> Unit, modifier: Modifier = Modifier, buttonType: ButtonType = ButtonType.Primary, buttonSize: ButtonSize = ButtonSize.LargeProductive, isEnabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Icon button

Buttons are used to initialize an action. Button labels express what action will occur when the user interacts with it.

Icon buttons allow users to take actions, and make choices, with a single tap. Icon buttons can take the form of a primary, secondary, tertiary, or ghost variant but most commonly will be styled as primary or ghost buttons.

(From Button documentation)

Parameters

iconPainter

Icon painter to be displayed in the button.

onClick

Callback invoked when the button is clicked.

modifier

The modifier to be applied to the button.

buttonType

A ButtonType that defines the button's type.

buttonSize

A ButtonSize that defines the button's size.

isEnabled

Whether the button is enabled or disabled.

interactionSource

The MutableInteractionSource that keeps track of the button's state.

See also

@Composable
fun IconButton(iconPainter: Painter, tooltipParameters: TooltipParameters, onClick: () -> Unit, modifier: Modifier = Modifier, tooltipModifier: Modifier = Modifier, buttonType: ButtonType = ButtonType.Primary, buttonSize: ButtonSize = ButtonSize.LargeProductive, isEnabled: Boolean = true, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Icon button

Buttons are used to initialize an action. Button labels express what action will occur when the user interacts with it.

Icon buttons allow users to take actions, and make choices, with a single tap. Icon buttons can take the form of a primary, secondary, tertiary, or ghost variant but most commonly will be styled as primary or ghost buttons.

This variant of the icon button uses Carbon's TooltipBox to display a tooltip when the user hovers over or focuses it.

(From Button documentation)

Parameters

iconPainter

Icon painter to be displayed in the button.

tooltipParameters

Parameters to configure the tooltip.

onClick

Callback invoked when the button is clicked.

modifier

The modifier to be applied to the button.

tooltipModifier

The modifier to be applied to the tooltip.

buttonType

A ButtonType that defines the button's type.

buttonSize

A ButtonSize that defines the button's size.

isEnabled

Whether the button is enabled or disabled.

interactionSource

The MutableInteractionSource that keeps track of the button's state.

See also