LineBreak

When soft wrap is enabled and the width of the text exceeds the width of its container, line breaks are inserted in the text to split it over multiple lines.

There are a number of parameters that affect how the line breaks are inserted. For example, the breaking algorithm can be changed to one with improved readability at the cost of speed. Another example is the strictness, which in some languages determines which symbols can appear at the start of a line.

LineBreak represents a configuration for line breaking, offering several presets for different use cases: Simple, Heading, Paragraph.

import androidx.compose.material.Text
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.text.style.LineBreak
import androidx.compose.ui.unit.sp

Text(
    text = "Title of an article",
    style = TextStyle(
        fontSize = 20.sp,
        lineBreak = LineBreak.Heading
    )
)

Text(
    text = "A long paragraph in an article",
    style = TextStyle(
        lineBreak = LineBreak.Paragraph
    )
)

For further customization, each platform has its own parameters. An example on Android:

import androidx.compose.material.Text
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.text.style.LineBreak
import androidx.compose.ui.unit.sp

val customTitleLineBreak = LineBreak(
    strategy = LineBreak.Strategy.Simple,
    strictness = LineBreak.Strictness.Loose,
    wordBreak = LineBreak.WordBreak.Default
)

Text(
    text = "Title of an article",
    style = TextStyle(
        fontSize = 20.sp,
        lineBreak = customTitleLineBreak
    )
)

val defaultStrictnessParagraphLineBreak =
    LineBreak.Paragraph.copy(strictness = LineBreak.Strictness.Default)

Text(
    text = "A long paragraph in an article",
    style = TextStyle(
        lineBreak = defaultStrictnessParagraphLineBreak
    )
)

Summary

val Heading: LineBreak

val Paragraph: LineBreak

val Simple: LineBreak

val Unspecified: LineBreak

LineBreak(
    strategy: LineBreak.Strategy,
    strictness: LineBreak.Strictness,
    wordBreak: LineBreak.WordBreak
)

fun copy(
    strategy: LineBreak.Strategy = this.strategy,
    strictness: LineBreak.Strictness = this.strictness,
    wordBreak: LineBreak.WordBreak = this.wordBreak
): LineBreak

open fun toString(): String

val strategy: LineBreak.Strategy

val strictness: LineBreak.Strictness

val wordBreak: LineBreak.WordBreak