BasicText

Functions summary

`Unit`	`@Composable BasicText( text: String, modifier: Modifier, style: TextStyle, onTextLayout: ((TextLayoutResult) -> Unit)?, overflow: TextOverflow, softWrap: Boolean, maxLines: Int, minLines: Int, color: ColorProducer?, autoSize: TextAutoSize? )` Basic element that displays text and provides semantics / accessibility information.	Cmn
`Unit`	`@Composable BasicText( text: AnnotatedString, modifier: Modifier, style: TextStyle, onTextLayout: ((TextLayoutResult) -> Unit)?, overflow: TextOverflow, softWrap: Boolean, maxLines: Int, minLines: Int, inlineContent: Map<String, InlineTextContent>, color: ColorProducer?, autoSize: TextAutoSize? )` Basic element that displays text and provides semantics / accessibility information.	Cmn

Functions

BasicText

Cmn

Artifact: androidx.compose.foundation:foundation

View Source

@Composable
fun BasicText(
    text: String,
    modifier: Modifier = Modifier,
    style: TextStyle = TextStyle.Default,
    onTextLayout: ((TextLayoutResult) -> Unit)? = null,
    overflow: TextOverflow = TextOverflow.Clip,
    softWrap: Boolean = true,
    maxLines: Int = Int.MAX_VALUE,
    minLines: Int = 1,
    color: ColorProducer? = null,
    autoSize: TextAutoSize? = null
): Unit

Basic element that displays text and provides semantics / accessibility information. Typically you will instead want to use androidx.compose.material.Text, which is a higher level Text element that contains semantics and consumes style information from a theme.

import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.text.BasicText
import androidx.compose.foundation.text.TextAutoSize
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp

Box(modifier = Modifier.size(200.dp)) {
    // The text will find the biggest available font size that fits in the box.
    BasicText(text = "Hello World", autoSize = TextAutoSize.StepBased())
}

Parameters
`text: String`	The text to be displayed.
`modifier: Modifier = Modifier`	`Modifier` to apply to this layout node.
`style: TextStyle = TextStyle.Default`	Style configuration for the text such as color, font, line height etc.
`onTextLayout: ((TextLayoutResult) -> Unit)? = null`	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.
`overflow: TextOverflow = TextOverflow.Clip`	How visual overflow should be handled.
`softWrap: Boolean = true`	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: Int = Int.MAX_VALUE`	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`. It is required that 1 <= `minLines`<= `maxLines`.
`minLines: Int = 1`	The minimum height in terms of minimum number of visible lines. It is required that 1 <= `minLines`<= `maxLines`.
`color: ColorProducer? = null`	Overrides the text color provided in `style`
`autoSize: TextAutoSize? = null`	Enable auto sizing for this text composable. Finds the biggest font size that fits in the available space and lays the text out with this size. This performs multiple layout passes and can be slower than using a fixed font size. This takes precedence over sizes defined through `style`. See `TextAutoSize` and the sample code.

BasicText

Cmn

Artifact: androidx.compose.foundation:foundation

View Source

@Composable
fun BasicText(
    text: AnnotatedString,
    modifier: Modifier = Modifier,
    style: TextStyle = TextStyle.Default,
    onTextLayout: ((TextLayoutResult) -> Unit)? = null,
    overflow: TextOverflow = TextOverflow.Clip,
    softWrap: Boolean = true,
    maxLines: Int = Int.MAX_VALUE,
    minLines: Int = 1,
    inlineContent: Map<String, InlineTextContent> = mapOf(),
    color: ColorProducer? = null,
    autoSize: TextAutoSize? = null
): Unit

import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.text.BasicText
import androidx.compose.foundation.text.TextAutoSize
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp

Box(modifier = Modifier.size(200.dp)) {
    // The text will find the biggest available font size that fits in the box.
    BasicText(text = "Hello World", autoSize = TextAutoSize.StepBased())
}

Parameters
`text: AnnotatedString`	The text to be displayed.
`modifier: Modifier = Modifier`	`Modifier` to apply to this layout node.
`style: TextStyle = TextStyle.Default`	Style configuration for the text such as color, font, line height etc.
`onTextLayout: ((TextLayoutResult) -> Unit)? = null`	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.
`overflow: TextOverflow = TextOverflow.Clip`	How visual overflow should be handled.
`softWrap: Boolean = true`	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: Int = Int.MAX_VALUE`	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`. It is required that 1 <= `minLines`<= `maxLines`.
`minLines: Int = 1`	The minimum height in terms of minimum number of visible lines. It is required that 1 <= `minLines`<= `maxLines`.
`inlineContent: Map<String, InlineTextContent> = mapOf()`	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.
`color: ColorProducer? = null`	Overrides the text color provided in `style`
`autoSize: TextAutoSize? = null`	Enable auto sizing for this text composable. Finds the biggest font size that fits in the available space and lays the text out with this size. This performs multiple layout passes and can be slower than using a fixed font size. This takes precedence over sizes defined through `style`. See `TextAutoSize` and the sample code.