Text

Composable Component

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

Android
@Composable
public fun Text(
    text: String,
    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,
    minLines: Int = 1,
    onTextLayout: (TextLayoutResult) -> Unit = {},
    style: TextStyle = LocalTextStyle.current,
)

Parameters
text The text to be displayed.
modifier Modifier to apply 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.
minLines The minimum height in terms of minimum number of visible lines. It is required that 1 <= minLines <= maxLines.
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. For example, to draw selection around the text.
style Style configuration for the text such as color, font, line height etc.
Android
Deprecated Maintained for binary compatibility with Compose for Wear OS 1.1
@Composable
public fun Text(
    text: String,
    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 The text to be displayed.
modifier Modifier to apply 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. For example, to draw selection around the text.
style Style configuration for the text such as color, font, line height etc.
Android
@Composable
public fun Text(
    text: AnnotatedString,
    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,
    minLines: Int = 1,
    inlineContent: Map<String, InlineTextContent> = mapOf(),
    onTextLayout: (TextLayoutResult) -> Unit = {},
    style: TextStyle = LocalTextStyle.current,
)

Parameters
text The text to be displayed, where AnnotatedString allows multiple styles to be used.
modifier Modifier to apply 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.
minLines The minimum height in terms of minimum number of visible lines. It is required that 1 <= minLines <= maxLines.
inlineContent A map store composables that replaces certain ranges of the text. It's used to insert composables into text layout. Check InlineTextContent for more information.
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. For example, to draw selection around the text.
style Style configuration for the text such as color, font, line height etc.
Android
Deprecated Maintained for binary compatibility with Compose for Wear OS 1.1
@Composable
public fun Text(
    text: AnnotatedString,
    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,
    inlineContent: Map<String, InlineTextContent> = mapOf(),
    onTextLayout: (TextLayoutResult) -> Unit = {},
    style: TextStyle = LocalTextStyle.current,
)

Parameters
text The text to be displayed, where AnnotatedString allows multiple styles to be used.
modifier Modifier to apply 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.
inlineContent A map store composables that replaces certain ranges of the text. It's used to insert composables into text layout. Check InlineTextContent for more information.
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. For example, to draw selection around the text.
style Style configuration for the text such as color, font, line height etc.