RemoteIcon

Functions summary

Unit
@RemoteComposable
@Composable
RemoteIcon(
    imageVector: RemoteImageVector,
    contentDescription: RemoteString?,
    modifier: RemoteModifier,
    tint: RemoteColor
)

Composable function that displays an icon using an RemoteImageVector.

Functions

@RemoteComposable
@Composable
fun RemoteIcon(
    imageVector: RemoteImageVector,
    contentDescription: RemoteString?,
    modifier: RemoteModifier = RemoteModifier,
    tint: RemoteColor = LocalRemoteContentColor.current
): Unit

Composable function that displays an icon using an RemoteImageVector.

This function provides a way to display icons consistently across both local and remote Compose environments.

Parameters
imageVector: RemoteImageVector

The RemoteImageVector representing the icon to display.

contentDescription: RemoteString?

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: RemoteModifier = RemoteModifier

The RemoteModifier to apply to the icon.

tint: RemoteColor = LocalRemoteContentColor.current

The color to apply to the icon. Defaults to the current content color.