Icon

Component in Wear Material Compose

Icon component that draws [imageVector] using [tint], defaulting to [LocalContentColor]. For a clickable icon, see [Chip].

Last updated: 2024-10-22 13:47

Installation

dependencies {
   implementation("androidx.wear.compose:compose-material:1.5.0-alpha04")
}

Overloads

@Composable
fun Icon(
    imageVector: ImageVector,
    contentDescription: String?,
    modifier: Modifier = Modifier,
    tint: Color = LocalContentColor.current.copy(alpha = LocalContentAlpha.current)
)

Parameters

name	description
imageVector	[ImageVector] to draw inside this Icon
contentDescription	Text used by accessibility services to describe what this icon represents. This should always be provided unless this icon is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using [androidx.compose.ui.res.stringResource] or similar
modifier	Optional [Modifier] for this Icon
tint	Tint to be applied to [imageVector]. If [Color.Unspecified] is provided, then no tint is applied

@Composable
fun Icon(
    bitmap: ImageBitmap,
    contentDescription: String?,
    modifier: Modifier = Modifier,
    tint: Color = LocalContentColor.current.copy(alpha = LocalContentAlpha.current)
)

Parameters

name	description
bitmap	[ImageBitmap] to draw inside this Icon
contentDescription	Text used by accessibility services to describe what this icon represents. This should always be provided unless this icon is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using [androidx.compose.ui.res.stringResource] or similar
modifier	Optional [Modifier] for this Icon
tint	Tint to be applied to [bitmap]. If [Color.Unspecified] is provided, then no tint is applied

@Composable
fun Icon(
    painter: Painter,
    contentDescription: String?,
    modifier: Modifier = Modifier,
    tint: Color = LocalContentColor.current.copy(alpha = LocalContentAlpha.current)
)

Parameters

name	description
painter	[Painter] to draw inside this Icon
contentDescription	Text used by accessibility services to describe what this icon represents. This should always be provided unless this icon is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using [androidx.compose.ui.res.stringResource] or similar
modifier	Optional [Modifier] for this Icon
tint	Tint to be applied to [painter]. If [Color.Unspecified] is provided, then no tint is applied