Package-level declarations

Types

Link copied to clipboard

Defines the variants of the icon button.

Link copied to clipboard

Defines the standard sizes for icon buttons.

Functions

Link copied to clipboard
fun PrimaryIconButton(icon: Painter, onClick: () -> Unit, modifier: Modifier = Modifier, isEnabled: Boolean = true, contentDescription: String? = null, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

The Primary Icon Button serves as a visually prominent interactive element for high-priority, icon-only actions. It is typically used in scenarios where a traditional primary button would be placed, but the action is better represented by a single, recognizable icon (e.g., quick add to cart):

Link copied to clipboard
fun StandardIconButton(icon: Painter, onClick: () -> Unit, modifier: Modifier = Modifier, isEnabled: Boolean = true, buttonVariant: IconButtonVariant = IconButtonVariant.Positive, buttonSize: StandardIconButtonSize = StandardIconButtonSize.Medium, contentDescription: String? = null, notificationIndicatorAppearance: NotificationIndicatorAppearance? = null, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Icon buttons fulfill functional needs of UI designs in places where traditional CTA buttons would have too strong visual emphasis. It comes in two IconButtonVariants, and two StandardIconButtonSizes

Link copied to clipboard
fun StatusIconButton(isChecked: Boolean, icon: Painter, activeIcon: Painter, onCheckedChange: (Boolean) -> Unit, modifier: Modifier = Modifier, isEnabled: Boolean = true, buttonVariant: IconButtonVariant = IconButtonVariant.Positive, contentDescription: String? = null, interactionSource: MutableInteractionSource = remember { MutableInteractionSource() })

Informs users of a changed state within an icon through visual cues for improved awareness and scannability. The state of this button often reflects the system state or the user's interaction with them, helping to communicate feedback or guide behavior. It comes in two IconButtonVariants.