{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

TextDecoration.Companion

public static class TextDecoration.Companion


Summary

Public methods

static final @NonNull TextDecoration

Creates a decoration that includes all the given decorations.

static final @NonNull TextDecoration

Draws a horizontal line over the text.

static final @NonNull TextDecoration
static final @NonNull TextDecoration

Draws a horizontal line below the text.

Public methods

combine

public static final @NonNull TextDecoration combine(@NonNull List<@NonNull TextDecoration> decorations)

Creates a decoration that includes all the given decorations.

import androidx.compose.material.Text
import androidx.compose.ui.text.style.TextDecoration

Text(
    text = "Demo Text",
    textDecoration = TextDecoration.Underline + TextDecoration.LineThrough
)
Parameters
@NonNull List<@NonNull TextDecoration> decorations

The decorations to be added

getLineThrough

public static final @NonNull TextDecoration getLineThrough()

Draws a horizontal line over the text.

import androidx.compose.material.Text
import androidx.compose.ui.text.style.TextDecoration

Text(
    text = "Demo Text",
    textDecoration = TextDecoration.LineThrough
)

getNone

public static final @NonNull TextDecoration getNone()

getUnderline

public static final @NonNull TextDecoration getUnderline()

Draws a horizontal line below the text.

import androidx.compose.material.Text
import androidx.compose.ui.text.style.TextDecoration

Text(
    text = "Demo Text",
    textDecoration = TextDecoration.Underline
)