BaselineShift

Class

Common

value class BaselineShift(val multiplier: Float)

The amount by which the text is shifted up or down from current the baseline.

Parameters


multiplier	shift the baseline by multiplier * (baseline - ascent)

Properties

Common

val isSpecified: Boolean

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

Functions

inline fun takeOrElse(default: () -> BaselineShift): BaselineShift

Returns this BaselineShift if it is specified or default if it is BaselineShift.Unspecified.

Companion Object

Properties

Common

val Superscript = BaselineShift(0.5f)

Default baseline shift for superscript.

Common

val Subscript = BaselineShift(-0.5f)

Default baseline shift for subscript

Common

val None = BaselineShift(0.0f)

Constant for no baseline shift.

Common

val Unspecified = BaselineShift(Float.NaN)

Constant for an unset baseline shift.

Code Examples

BaselineShiftAnnotatedStringSample

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

BaselineShiftSample

@Composable
fun BaselineShiftSample() {
    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")
                    }
                }
            },
    )
}