BaselineShift

Added in 1.0.0

Cmn
```
value class BaselineShift
```

Shifts the text baseline vertically (up or down).

import androidx.compose.material3.Text
import androidx.compose.ui.text.SpanStyle
import androidx.compose.ui.text.buildAnnotatedString
import androidx.compose.ui.text.style.BaselineShift
import androidx.compose.ui.text.withStyle
import androidx.compose.ui.unit.sp

Text(
    fontSize = 20.sp,
    text =
        buildAnnotatedString {
            append(text = "Hello")
            withStyle(SpanStyle(baselineShift = BaselineShift.Superscript, fontSize = 16.sp)) {
                append("superscript")
                withStyle(SpanStyle(baselineShift = BaselineShift.Subscript)) {
                    append("subscript")
                }
            }
        },
)

import androidx.compose.material3.Text
import androidx.compose.ui.text.SpanStyle
import androidx.compose.ui.text.buildAnnotatedString
import androidx.compose.ui.text.style.BaselineShift
import androidx.compose.ui.text.withStyle

val annotatedString = buildAnnotatedString {
    append("Text ")
    withStyle(SpanStyle(baselineShift = BaselineShift.Superscript)) { append("Demo") }
}
Text(text = annotatedString)

Summary

Public companion properties
`BaselineShift`	`None` Constant for no baseline shift.	Cmn
`BaselineShift`	`Subscript` Default baseline shift for subscript	Cmn
`BaselineShift`	`Superscript` Default baseline shift for superscript.	Cmn
`BaselineShift`	`Unspecified` Represents an unset `BaselineShift` value.	Cmn

Public constructors
`BaselineShift(multiplier: Float)`	Cmn

Public properties
`Float`	`multiplier` multiplier to shift the baseline (distance = multiplier * (baseline - ascent)).	Cmn

Extension functions
`inline BaselineShift`	`BaselineShift.takeOrElse(block: () -> BaselineShift)` If `isSpecified` is true then this is returned, otherwise `block` is executed and its result is returned.	Cmn

Extension properties
`Boolean`	`BaselineShift.isSpecified` Returns `true` if this baseline shift is not `BaselineShift.Unspecified`.	Cmn

Public companion properties

None

Cmn

Added in 1.0.0

val None: BaselineShift

Constant for no baseline shift.

Subscript

Cmn

Added in 1.0.0

val Subscript: BaselineShift

Default baseline shift for subscript

Superscript

Cmn

Added in 1.0.0

val Superscript: BaselineShift

Default baseline shift for superscript.

Unspecified

Cmn

val Unspecified: BaselineShift

Represents an unset BaselineShift value.

Public constructors

BaselineShift

Cmn

Added in 1.2.0

BaselineShift(multiplier: Float)

Parameters
`multiplier: Float`	multiplier to shift the baseline (distance = multiplier * (baseline - ascent)).

Public properties

multiplier

Cmn

Added in 1.0.0

val multiplier: Float

multiplier to shift the baseline (distance = multiplier * (baseline - ascent)).

Extension functions

BaselineShift.takeOrElse

Cmn

Artifact: androidx.compose.ui:ui-text

View Source

inline fun BaselineShift.takeOrElse(block: () -> BaselineShift): BaselineShift

If isSpecified is true then this is returned, otherwise block is executed and its result is returned.

Extension properties

BaselineShift.isSpecified

Cmn

Artifact: androidx.compose.ui:ui-text

View Source

val BaselineShift.isSpecified: Boolean

Returns true if this baseline shift is not BaselineShift.Unspecified.

See also
`Unspecified`