Documentation
¶
Overview ¶
Package iconbutton contains Material 3 Icon Button components.
Reference: [Icon Button](https://m3.material.io/components/icon-button/overview) Specs: [Icon Button Specs](https://m3.material.io/components/icon-button/specs)
Index ¶
- Constants
- func ElevatedIconButtonTokens(c api.Composer) tokens.IconButtonTokens
- func FilledIconButtonTokens(c api.Composer) tokens.IconButtonTokens
- func FilledTonalIconButtonTokens(c api.Composer) tokens.IconButtonTokens
- func OutlinedIconButtonTokens(c api.Composer) tokens.IconButtonTokens
- func StandardIconButtonTokens(c api.Composer) tokens.IconButtonTokens
- type Composable
- func Filled(onClick func(), icon []byte, description string, options ...IconButtonOption) Composable
- func FilledTonal(onClick func(), icon []byte, description string, options ...IconButtonOption) Composable
- func Outlined(onClick func(), icon []byte, description string, options ...IconButtonOption) Composable
- func Standard(onClick func(), icon []byte, description string, options ...IconButtonOption) Composable
- type Composer
- type IconButtonConstructorArgs
- type IconButtonOption
- type IconButtonOptions
Constants ¶
const Material3IconButtonNodeID = "Material3IconButton"
Variables ¶
This section is empty.
Functions ¶
func ElevatedIconButtonTokens ¶
func ElevatedIconButtonTokens(c api.Composer) tokens.IconButtonTokens
ElevatedIconButtonTokens - Ported from gio-mw BuildElevatedTheme Uses Primary.Color for enabled label/icon (merged into Color)
func FilledIconButtonTokens ¶
func FilledIconButtonTokens(c api.Composer) tokens.IconButtonTokens
FilledIconButtonTokens - Ported from gio-mw BuildFilledTheme Uses Primary.OnColor for enabled label/icon (merged into Color)
func FilledTonalIconButtonTokens ¶
func FilledTonalIconButtonTokens(c api.Composer) tokens.IconButtonTokens
FilledTonalIconButtonTokens - Ported from gio-mw BuildFilledTonalTheme Uses SecondaryContainer.OnColor for enabled label/icon (merged into Color)
func OutlinedIconButtonTokens ¶
func OutlinedIconButtonTokens(c api.Composer) tokens.IconButtonTokens
OutlinedIconButtonTokens - Ported from gio-mw BuildOutlinedTheme Uses Primary.Color for enabled label/icon (merged into Color)
func StandardIconButtonTokens ¶
func StandardIconButtonTokens(c api.Composer) tokens.IconButtonTokens
StandardIconButtonTokens - Ported from androidx/compose/material3/tokens
Types ¶
type Composable ¶
type Composable = api.Composable
func Filled ¶
func Filled(onClick func(), icon []byte, description string, options ...IconButtonOption) Composable
Filled represents a filled icon button (high emphasis).
func FilledTonal ¶
func FilledTonal(onClick func(), icon []byte, description string, options ...IconButtonOption) Composable
FilledTonal represents a filled tonal icon button (medium emphasis).
func Outlined ¶
func Outlined(onClick func(), icon []byte, description string, options ...IconButtonOption) Composable
Outlined represents an outlined icon button.
func Standard ¶
func Standard(onClick func(), icon []byte, description string, options ...IconButtonOption) Composable
Standard represents a standard text-based icon button (no background).
type IconButtonOption ¶
type IconButtonOption func(o *IconButtonOptions)
func WithModifier ¶
func WithModifier(m ui.Modifier) IconButtonOption
type IconButtonOptions ¶
func DefaultIconButtonOptions ¶
func DefaultIconButtonOptions() IconButtonOptions