Text

fun Text(@StringRes text: Int, modifier: Modifier = Modifier, color: Color = Color.Unspecified, fontSize: TextUnit = TextUnit.Unspecified, fontStyle: FontStyle? = null, fontWeight: FontWeight? = null, fontFamily: FontFamily? = null, letterSpacing: TextUnit = TextUnit.Unspecified, textDecoration: TextDecoration? = null, textAlign: TextAlign? = null, lineHeight: TextUnit = TextUnit.Unspecified, overflow: TextOverflow = TextOverflow.Clip, softWrap: Boolean = true, maxLines: Int = Int.MAX_VALUE, onTextLayout: (TextLayoutResult) -> Unit = {}, style: TextStyle = LocalTextStyle.current)

Parameters

text

ID of the StringRes to be displayed

modifier

the Modifier to be applied to this layout node

color

Color to apply to the text

If Color.Unspecified, and style has no color set, this will be LocalContentColor

fontSize

the size of glyphs to use when painting the text. See TextStyle.fontSize

fontStyle

the typeface variant to use when drawing the letters (e.g., italic) See TextStyle.fontStyle

fontWeight

the typeface thickness to use when painting the text (e.g., FontWeight.Bold)

fontFamily

the font family to be used when rendering the text. See TextStyle.fontFamily

letterSpacing

the amount of space to add between each letter. See TextStyle.letterSpacing

textDecoration

the decorations to paint on the text (e.g., an underline). See TextStyle.textDecoration

textAlign

the alignment of the text within the lines of the paragraph. See TextStyle.textAlign

lineHeight

line height for the Paragraph in TextUnit unit, e.g. SP or EM. See TextStyle.lineHeight

overflow

how visual overflow should be handled.

softWrap

whether the text should break at soft line breaks

If false, the glyphs in the text will be positioned as if there was unlimited horizontal space. If softWrap is false, overflow and TextAlign may have unexpected effects

maxLines

an optional maximum number of lines for the text to span, wrapping if necessary

If the text exceeds the given number of lines, it will be truncated according to overflow and softWrap

If it is not null, then it must be greater than zero

onTextLayout

callback that is executed when a new text layout is calculated A TextLayoutResult object that callback provides contains paragraph information, size of the text, baselines and other details

The callback can be used to add additional decoration or functionality to the text.

style

style configuration for the text such as color, font, line height etc.