ui/org.jetbrains.jewel.ui.component/Icon

Icon

@Composable

fun Icon(key: IconKey, contentDescription: String?, modifier: Modifier = Modifier, iconClass: Class<*> = key.iconClass, tint: Color = Color.Unspecified, vararg hints: PainterHint)

@Composable

fun Icon(key: IconKey, contentDescription: String?, modifier: Modifier = Modifier, iconClass: Class<*> = key.iconClass, tint: Color = Color.Unspecified, hint: PainterHint)

@Composable

fun Icon(key: IconKey, contentDescription: String?, modifier: Modifier = Modifier, iconClass: Class<*> = key.iconClass, colorFilter: ColorFilter?, hint: PainterHint)

@Composable

fun Icon(key: IconKey, contentDescription: String?, modifier: Modifier = Modifier, iconClass: Class<*> = key.iconClass, colorFilter: ColorFilter?, vararg hints: PainterHint)

@Composable

fun Icon(imageVector: ImageVector, contentDescription: String?, modifier: Modifier = Modifier, tint: Color = Color.Unspecified)

Icon component that draws imageVector using tint, defaulting to Color.Unspecified.

Parameters

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.

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 = Color.Unspecified)

Icon component that draws bitmap using tint, defaulting to Color.Unspecified.

Parameters

bitmap

ImageBitmap to draw inside this Icon

contentDescription

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 = Color.Unspecified)

Icon component that draws a painter using tint, defaulting to Color.Unspecified

Parameters

painter

Painter to draw inside this Icon

contentDescription

modifier

optional Modifier for this Icon

tint

tint to be applied to painter. If Color.Unspecified is provided, then no tint is applied

@Composable

fun Icon(painter: Painter, contentDescription: String?, colorFilter: ColorFilter?, modifier: Modifier = Modifier)

Icon component that draws a painter using a colorFilter

Parameters

painter

Painter to draw inside this Icon

contentDescription

colorFilter

color filter to be applied to painter

modifier

optional Modifier for this Icon

@Composable

fun ~~Icon~~(resource: String, contentDescription: String?, iconClass: Class<*>, colorFilter: ColorFilter?, modifier: Modifier = Modifier, vararg hints: PainterHint)

Deprecated

Use the IconKey-based API instead

Replace with

import org.jetbrains.jewel.ui.icon.PathIconKey

key = Icon(PathIconKey(resource, iconClass), contentDescription = contentDescription, colorFilter = colorFilter, modifier = modifier, hints)

@Composable

fun ~~Icon~~(resource: String, contentDescription: String?, iconClass: Class<*>, colorFilter: ColorFilter?, modifier: Modifier = Modifier, hint: PainterHint)

Deprecated

Use the IconKey-based API instead

Replace with

import org.jetbrains.jewel.ui.icon.PathIconKey

key = Icon(PathIconKey(resource, iconClass), contentDescription = contentDescription, colorFilter = colorFilter, modifier = modifier, hint = hint)

@Composable

fun ~~Icon~~(resource: String, contentDescription: String?, iconClass: Class<*>, modifier: Modifier = Modifier, tint: Color = Color.Unspecified, vararg hints: PainterHint)

Deprecated

Use the IconKey-based API instead

Replace with

import org.jetbrains.jewel.ui.icon.PathIconKey

Icon(key = PathIconKey(resource, iconClass), contentDescription = contentDescription, tint = tint, modifier = modifier, hints = hints)

@Composable

fun ~~Icon~~(resource: String, contentDescription: String?, iconClass: Class<*>, modifier: Modifier = Modifier, tint: Color = Color.Unspecified, hint: PainterHint)

Deprecated

Use the IconKey-based API instead

Replace with

import org.jetbrains.jewel.ui.icon.PathIconKey

Icon(key = PathIconKey(resource, iconClass), contentDescription = contentDescription, tint = tint, modifier = modifier, hint = hint)