# VerticalText

## 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/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)( text: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html, modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier, style: https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle, overflow: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/TextOverflow, maxColumns: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, minColumns: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, orientation: https://developer.android.com/reference/kotlin/androidx/text/vertical/TextOrientation )` Displays text laid out vertically using `https://developer.android.com/reference/kotlin/androidx/text/vertical/VerticalTextLayout`. |

## Functions

### VerticalText

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/VerticalText.kt+function:VerticalText) Added in [1.0.0-beta03](https://developer.android.com/jetpack/androidx/releases/text#1.0.0-beta03)

```
@Composable
fun VerticalText(
    text: CharSequence,
    modifier: Modifier = Modifier,
    style: VerticalTextStyle = VerticalTextStyle.Default,
    overflow: TextOverflow = TextOverflow.Clip,
    maxColumns: Int = Int.MAX_VALUE,
    minColumns: Int = 1,
    orientation: TextOrientation = TextOrientation.Mixed
): Unit
```

Displays text laid out vertically using `https://developer.android.com/reference/kotlin/androidx/text/vertical/VerticalTextLayout`.

This overload accepts an Android `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` and `https://developer.android.com/reference/android/text/TextPaint.html` directly, allowing use of vertical-specific spans such as `https://developer.android.com/reference/kotlin/androidx/text/vertical/RubySpan`, `https://developer.android.com/reference/kotlin/androidx/text/vertical/EmphasisSpan`, `https://developer.android.com/reference/kotlin/androidx/text/vertical/FontShearSpan`, and `https://developer.android.com/reference/kotlin/androidx/text/vertical/TextOrientationSpan`.

| Parameters |
|---|---|
| `text: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` | The `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` text to display. |
| `modifier: https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier = Modifier` | The `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier` to apply to the layout. |
| `style: https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle = VerticalTextStyle.Default` | The `https://developer.android.com/reference/kotlin/androidx/text/vertical/compose/VerticalTextStyle` to use for text measurement and rendering. |
| `overflow: https://developer.android.com/reference/kotlin/androidx/compose/ui/text/style/TextOverflow = TextOverflow.Clip` | How to handle text that overflows the available space. |
| `maxColumns: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = Int.MAX_VALUE` | The maximum number of columns. Defaults to unlimited. |
| `minColumns: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = 1` | The minimum number of columns for layout sizing. |
| `orientation: https://developer.android.com/reference/kotlin/androidx/text/vertical/TextOrientation = TextOrientation.Mixed` | The text orientation mode for vertical layout. |