Source for Android/com.gu.source.components.buttons/SourceIconButton

SourceIconButton

@Composable
fun SourceIconButton(icon: ImageVector, priority: SourceButton.Priority, contentDescription: String?, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, size: SourceButton.Size = SourceButton.Size.Medium, theme: Source.Theme? = null)

Source icon-only button.

Parameters

icon

The icon to display in the button. Use an icon from Source.Icons or Material Icons.

priority

The priority of the button. Informs users of how important an action is.

contentDescription

The content description for the button.

onClick

The action to perform when the button is clicked.

modifier

The modifier to apply to the button.

enabled

Whether the button is enabled and can be interacted with.

size

Optional size for the button. Reflects the prominence of the action. Defaults to SourceButton.Size.Medium.

theme

Optional Source.Theme to apply to the button. If not provided, the current theme from LocalSourceTheme will be used.

Unless using the button as a standalone component, it is recommended to wrap the whole screen/sheet with SourceCoreTheme or ReaderRevenueTheme to provide consistent theme to all child components once.

@Composable
fun SourceIconButton(painter: Painter, priority: SourceButton.Priority, contentDescription: String?, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, size: SourceButton.Size = SourceButton.Size.Medium, theme: Source.Theme? = null)

Source icon-only button.

Parameters

painter

The icon to display in the button.

priority

The priority of the button. Informs users of how important an action is.

contentDescription

The content description for the button.

onClick

The action to perform when the button is clicked.

modifier

The modifier to apply to the button.

enabled

Whether the button is enabled and can be interacted with.

size

Optional size for the button. Reflects the prominence of the action. Defaults to SourceButton.Size.Medium.

theme

Optional Source.Theme to apply to the button. If not provided, the current theme from LocalSourceTheme will be used.

Unless using the button as a standalone component, it is recommended to wrap the whole screen/sheet with SourceCoreTheme or ReaderRevenueTheme to provide consistent theme to all child components once.

@Composable
fun SourceIconButton(icon: ImageBitmap, priority: SourceButton.Priority, contentDescription: String?, onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, size: SourceButton.Size = SourceButton.Size.Medium, theme: Source.Theme? = null)

Source icon-only button.

Parameters

icon

The icon to display in the button.

priority

The priority of the button. Informs users of how important an action is.

contentDescription

The content description for the button.

onClick

The action to perform when the button is clicked.

modifier

The modifier to apply to the button.

enabled

Whether the button is enabled and can be interacted with.

size

Optional size for the button. Reflects the prominence of the action. Defaults to SourceButton.Size.Medium.

theme

Optional Source.Theme to apply to the button. If not provided, the current theme from LocalSourceTheme will be used.

Unless using the button as a standalone component, it is recommended to wrap the whole screen/sheet with SourceCoreTheme or ReaderRevenueTheme to provide consistent theme to all child components once.