# RemoteIcon

## Functions summary

|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/layout/RemoteComposable @https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteIcon.composable#RemoteIcon(androidx.compose.remote.creation.compose.capture.RemoteImageVector,androidx.compose.remote.creation.compose.state.RemoteString,androidx.compose.remote.creation.compose.modifier.RemoteModifier,androidx.compose.remote.creation.compose.state.RemoteColor)( imageVector: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/capture/RemoteImageVector, contentDescription: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteString?, modifier: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/modifier/RemoteModifier, tint: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteColor )` Composable function that displays an icon using a `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/capture/RemoteImageVector`. |

## Functions

### RemoteIcon

Artifact: [androidx.wear.compose.remote:remote-material3](https://developer.android.com/jetpack/androidx/releases/wear-compose-remote) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/remote/material3/RemoteIcon.kt+function:RemoteIcon) Added in [1.0.0-alpha15](https://developer.android.com/jetpack/androidx/releases/wear-compose-remote#1.0.0-alpha15)

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

Composable function that displays an icon using a `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/capture/RemoteImageVector`.

```kotlin
import androidx.compose.remote.creation.compose.capture.RemoteImageVector
import androidx.compose.remote.creation.compose.capture.vectorResource
import androidx.wear.compose.remote.material3.RemoteIcon

RemoteIcon(
    modifier = modifier,
    imageVector =
        RemoteImageVector.vectorResource(R.drawable.gs_map_wght500rond100_vd_theme_24),
    contentDescription = null,
)
```

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

| Parameters |
|---|---|
| `imageVector: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/capture/RemoteImageVector` | The `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/capture/RemoteImageVector` representing the icon to display. |
| `contentDescription: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/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 `https://developer.android.com/reference/kotlin/androidx/compose/ui/res/stringResource.composable#stringResource(kotlin.Int)` or similar. |
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/modifier/RemoteModifier = RemoteModifier` | The `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/modifier/RemoteModifier` to apply to the icon. |
| `tint: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteColor = LocalRemoteContentColor.current` | The color to apply to the icon. Defaults to the current content color. |