# RemoteText

## Functions summary

|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/layout/RemoteComposable https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/RemoteText.composable#RemoteText(androidx.compose.remote.creation.compose.state.RemoteString,androidx.compose.remote.creation.compose.modifier.RemoteModifier,androidx.compose.remote.creation.compose.state.RemoteColor,androidx.compose.remote.creation.compose.state.RemoteTextUnit,androidx.compose.ui.text.font.FontStyle,androidx.compose.ui.text.font.FontWeight,androidx.compose.remote.creation.compose.text.RemoteFontFamily,androidx.compose.ui.text.style.TextAlign,androidx.compose.ui.text.style.TextOverflow,kotlin.Int,androidx.compose.ui.text.font.FontVariation.Settings,androidx.compose.remote.creation.compose.text.RemoteTextStyle)( text: 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, color: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteColor?, fontSize: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteTextUnit?, fontStyle: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontStyle?, fontWeight: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontWeight?, fontFamily: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/text/RemoteFontFamily?, textAlign: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/TextAlign?, overflow: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/TextOverflow, maxLines: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, fontVariationSettings: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontVariation.Settings?, style: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/text/RemoteTextStyle )` High level element that displays text and provides semantics / accessibility information. |

## Functions

### RemoteText

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/RemoteText.kt+function:RemoteText) Added in [1.0.0-alpha15](https://developer.android.com/jetpack/androidx/releases/wear-compose-remote#1.0.0-alpha15)

```
@Composable
@RemoteComposable
fun RemoteText(
    text: RemoteString,
    modifier: RemoteModifier = RemoteModifier,
    color: RemoteColor? = null,
    fontSize: RemoteTextUnit? = null,
    fontStyle: FontStyle? = null,
    fontWeight: FontWeight? = null,
    fontFamily: RemoteFontFamily? = null,
    textAlign: TextAlign? = LocalTextConfiguration.current.textAlign,
    overflow: TextOverflow = LocalTextConfiguration.current.overflow,
    maxLines: Int = LocalTextConfiguration.current.maxLines,
    fontVariationSettings: FontVariation.Settings? = null,
    style: RemoteTextStyle = LocalRemoteTextStyle.current
): Unit
```

High level element that displays text and provides semantics / accessibility information.

For ease of use, commonly used parameters from `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/TextStyle` are also present here. The order of precedence is as follows:

- If a parameter is explicitly set here (i.e., it is *not* `null` or `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit#Unspecified()`), then this parameter will always be used.

- If a parameter is *not* set, (`null` or `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit#Unspecified()`), then the corresponding value from `https://developer.android.com/reference/kotlin/androidx/wear/compose/remote/material3/package-summary#RemoteText(androidx.compose.remote.creation.compose.state.RemoteString,androidx.compose.remote.creation.compose.modifier.RemoteModifier,androidx.compose.remote.creation.compose.state.RemoteColor,androidx.compose.remote.creation.compose.state.RemoteTextUnit,androidx.compose.ui.text.font.FontStyle,androidx.compose.ui.text.font.FontWeight,androidx.compose.remote.creation.compose.text.RemoteFontFamily,androidx.compose.ui.text.style.TextAlign,androidx.compose.ui.text.style.TextOverflow,kotlin.Int,androidx.compose.ui.text.font.FontVariation.Settings,androidx.compose.remote.creation.compose.text.RemoteTextStyle)` will be used instead.

| Parameters |
|---|---|
| `text: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteString` | The text to be displayed. |
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/modifier/RemoteModifier = RemoteModifier` | `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/modifier/RemoteModifier` to apply to this layout node. |
| `color: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteColor? = null` | `https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteColor` to apply to the text. |
| `fontSize: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/state/RemoteTextUnit? = null` | The size of glyphs to use when painting the text. See `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/TextStyle#fontSize()`. |
| `fontStyle: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontStyle? = null` | The typeface variant to use when drawing the letters (e.g., italic). See `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/TextStyle#fontStyle()`. |
| `fontWeight: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontWeight? = null` | The typeface thickness to use when painting the text (e.g., `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontWeight#Bold()`). |
| `fontFamily: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/text/RemoteFontFamily? = null` | The font family to be used when rendering the text. See `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/TextStyle#fontFamily()`. |
| `textAlign: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/TextAlign? = LocalTextConfiguration.current.textAlign` | The alignment of the text within the lines of the paragraph. See `https://developer.android.com/reference/kotlin/androidx/compose/ui/text/TextStyle#textAlign()`. |
| `overflow: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/TextOverflow = LocalTextConfiguration.current.overflow` | How visual overflow should be handled. |
| `maxLines: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = LocalTextConfiguration.current.maxLines` | An optional maximum number of lines for the text to span. |
| `fontVariationSettings: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/font/FontVariation.Settings? = null` | The font variation settings to be applied to the text. |
| `style: https://developer.android.com/reference/kotlin/androidx/compose/remote/creation/compose/text/RemoteTextStyle = LocalRemoteTextStyle.current` | Style configuration for the text such as color, font, line height etc. |