# androidx.text.vertical.compose

## Classes

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextScope` | Receiver for the `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/package-summary#buildVerticalText(androidx.compose.ui.unit.Density,kotlin.Function1)` DSL. |
| `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle` | A style object for vertical text, containing only members supported by `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalText.composable#VerticalText(kotlin.CharSequence,androidx.compose.ui.Modifier,androidx.text.vertical.compose.VerticalTextStyle,androidx.compose.ui.text.style.TextOverflow,kotlin.Int,kotlin.Int,androidx.text.vertical.TextOrientation)`. |

## Annotations

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextDsl` | Marks the `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextScope` DSL. |

## Composables

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalText.composable` | Displays text laid out vertically using `https://developer.android.com/reference/kotlin/androidx/text/vertical/VerticalTextLayout`. |
| `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/buildVerticalText.composable` | Composable-context convenience for `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/buildVerticalText.composable#buildVerticalText(kotlin.Function1)`. |

## Top-level functions summary

|---|---|
| `https://developer.android.com/reference/android/text/Spanned.html` | `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/package-summary#buildVerticalText(androidx.compose.ui.unit.Density,kotlin.Function1)(density: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Density, builder: https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextScope.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Builds a `https://developer.android.com/reference/android/text/Spanned.html` representing vertical text by running `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/package-summary#buildVerticalText(androidx.compose.ui.unit.Density,kotlin.Function1)` against a `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextScope`. |

## Top-level functions

### buildVerticalText

Artifact: [androidx.text:text-vertical-compose](https://developer.android.com/jetpack/androidx/releases/text) [View Source](https://cs.android.com/search?q=file:androidx/text/vertical/compose/VerticalTextUtils.kt+function:buildVerticalText) Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
fun buildVerticalText(density: Density, builder: VerticalTextScope.() -> Unit): Spanned
```

Builds a `https://developer.android.com/reference/android/text/Spanned.html` representing vertical text by running `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/package-summary#buildVerticalText(androidx.compose.ui.unit.Density,kotlin.Function1)` against a `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextScope`. The resulting `https://developer.android.com/reference/android/text/Spanned.html` is an immutable snapshot that can be passed to `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalText.composable#VerticalText(kotlin.CharSequence,androidx.compose.ui.Modifier,androidx.text.vertical.compose.VerticalTextStyle,androidx.compose.ui.text.style.TextOverflow,kotlin.Int,kotlin.Int,androidx.text.vertical.TextOrientation)`.

| Parameters |
|---|---|
| `density: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Density` | used to resolve sp-based `https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/TextUnit` values in `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextScope#withStyle(androidx.compose.ui.unit.TextUnit,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,kotlin.Float,kotlin.Function1)`. |
| `builder: https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextScope.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | the DSL block describing the content. |