VerticalText

Functions summary

Unit
@Composable
VerticalText(
    text: CharSequence,
    modifier: Modifier,
    style: VerticalTextStyle,
    overflow: TextOverflow,
    maxColumns: Int,
    minColumns: Int,
    orientation: TextOrientation
)

Displays text laid out vertically using VerticalTextLayout.

Functions

VerticalText

@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 VerticalTextLayout.

This overload accepts an Android CharSequence and TextPaint directly, allowing use of vertical-specific spans such as androidx.text.vertical.RubySpan, androidx.text.vertical.EmphasisSpan, androidx.text.vertical.FontShearSpan, and androidx.text.vertical.TextOrientationSpan.

NOTE: Vertical text layout requires API 36 (Android 16). On older API levels, nothing is rendered.

Parameters
text: CharSequence

The CharSequence text to display.
modifier: Modifier = Modifier

The Modifier to apply to the layout.
style: VerticalTextStyle = VerticalTextStyle.Default

The VerticalTextStyle to use for text measurement and rendering.
overflow: TextOverflow = TextOverflow.Clip

How to handle text that overflows the available space.
maxColumns: Int = Int.MAX_VALUE

The maximum number of columns. Defaults to unlimited.
minColumns: Int = 1

The minimum number of columns for layout sizing.
orientation: TextOrientation = TextOrientation.Mixed

The text orientation mode for vertical layout.