AutoSize text implementation in Jetpack Compose
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import androidx.compose.foundation.layout.BoxWithConstraints | |
import androidx.compose.foundation.layout.BoxWithConstraintsScope | |
import androidx.compose.foundation.text.InlineTextContent | |
import androidx.compose.foundation.text.InternalFoundationTextApi | |
import androidx.compose.foundation.text.TextDelegate | |
import androidx.compose.material.LocalTextStyle | |
import androidx.compose.material.Text | |
import androidx.compose.runtime.Composable | |
import androidx.compose.ui.Alignment | |
import androidx.compose.ui.Modifier | |
import androidx.compose.ui.graphics.Color | |
import androidx.compose.ui.platform.LocalDensity | |
import androidx.compose.ui.platform.LocalFontLoader | |
import androidx.compose.ui.platform.LocalLayoutDirection | |
import androidx.compose.ui.text.AnnotatedString | |
import androidx.compose.ui.text.TextLayoutResult | |
import androidx.compose.ui.text.TextStyle | |
import androidx.compose.ui.text.font.FontFamily | |
import androidx.compose.ui.text.font.FontStyle | |
import androidx.compose.ui.text.font.FontWeight | |
import androidx.compose.ui.text.style.TextAlign | |
import androidx.compose.ui.text.style.TextDecoration | |
import androidx.compose.ui.text.style.TextOverflow | |
import androidx.compose.ui.unit.TextUnit | |
import androidx.compose.ui.unit.min | |
import androidx.compose.ui.unit.sp | |
@Composable | |
fun AutoSizeText( | |
text: String, | |
modifier: Modifier = Modifier, | |
color: Color = Color.Unspecified, | |
suggestedFontSizes: List<TextUnit> = emptyList(), | |
fontStyle: FontStyle? = null, | |
fontWeight: FontWeight? = null, | |
fontFamily: FontFamily? = null, | |
letterSpacing: TextUnit = TextUnit.Unspecified, | |
textDecoration: TextDecoration? = null, | |
textAlign: TextAlign? = null, | |
lineHeight: TextUnit = TextUnit.Unspecified, | |
overflow: TextOverflow = TextOverflow.Clip, | |
softWrap: Boolean = true, | |
maxLines: Int = Int.MAX_VALUE, | |
onTextLayout: (TextLayoutResult) -> Unit = {}, | |
style: TextStyle = LocalTextStyle.current, | |
) { | |
AutoSizeText( | |
AnnotatedString(text), | |
modifier, | |
color, | |
suggestedFontSizes, | |
fontStyle, | |
fontWeight, | |
fontFamily, | |
letterSpacing, | |
textDecoration, | |
textAlign, | |
lineHeight, | |
overflow, | |
softWrap, | |
maxLines, | |
emptyMap(), | |
onTextLayout, | |
style, | |
) | |
} | |
@Composable | |
fun AutoSizeText( | |
text: AnnotatedString, | |
modifier: Modifier = Modifier, | |
color: Color = Color.Unspecified, | |
suggestedFontSizes: List<TextUnit> = emptyList(), | |
fontStyle: FontStyle? = null, | |
fontWeight: FontWeight? = null, | |
fontFamily: FontFamily? = null, | |
letterSpacing: TextUnit = TextUnit.Unspecified, | |
textDecoration: TextDecoration? = null, | |
textAlign: TextAlign? = null, | |
lineHeight: TextUnit = TextUnit.Unspecified, | |
overflow: TextOverflow = TextOverflow.Clip, | |
softWrap: Boolean = true, | |
maxLines: Int = Int.MAX_VALUE, | |
inlineContent: Map<String, InlineTextContent> = mapOf(), | |
onTextLayout: (TextLayoutResult) -> Unit = {}, | |
style: TextStyle = LocalTextStyle.current, | |
) { | |
BoxWithConstraints( | |
modifier = modifier, | |
contentAlignment = Alignment.Center, | |
) { | |
var combinedTextStyle = (LocalTextStyle.current + style).copy( | |
fontSize = min(maxWidth, maxHeight).value.sp | |
) | |
val fontSizes = suggestedFontSizes.ifEmpty { | |
MutableList(combinedTextStyle.fontSize.value.toInt()) { | |
(combinedTextStyle.fontSize.value - it).sp | |
} | |
} | |
var currentFontIndex = 0 | |
while (shouldShrink(text, combinedTextStyle, maxLines)) { | |
combinedTextStyle = | |
combinedTextStyle.copy(fontSize = fontSizes[++currentFontIndex]) | |
} | |
Text( | |
text, | |
Modifier, | |
color, | |
TextUnit.Unspecified, | |
fontStyle, | |
fontWeight, | |
fontFamily, | |
letterSpacing, | |
textDecoration, | |
textAlign, | |
lineHeight, | |
overflow, | |
softWrap, | |
maxLines, | |
inlineContent, | |
onTextLayout, | |
combinedTextStyle, | |
) | |
} | |
} | |
@OptIn(InternalFoundationTextApi::class) | |
@Composable | |
private fun BoxWithConstraintsScope.shouldShrink( | |
text: AnnotatedString, | |
textStyle: TextStyle, | |
maxLines: Int | |
): Boolean { | |
val textDelegate = TextDelegate( | |
text, | |
textStyle, | |
maxLines, | |
true, | |
TextOverflow.Clip, | |
LocalDensity.current, | |
LocalFontLoader.current, | |
) | |
val textLayoutResult = textDelegate.layout( | |
constraints, | |
LocalLayoutDirection.current, | |
) | |
return textLayoutResult.hasVisualOverflow | |
} |
AnnotatedString cannot support ?
This is an improved version:
Features:
- Best performance: Utilizes a dichotomous binary search algorithm to quickly find the optimal text size without unnecessary iterations.
- Text alignment support: Supports 6 possible alignment values through the Alignment interface.
- Material Design 3 support.
- Font scaling support: Changing the font scale by the user does not affect the visual rendering result.
Limitation:
- Does not work well when maxLine is greater than 1.
- Does not work well when changing lineHeight.
Tested on my own app with 800k+ downloads.
Thank you so much for this component. It works great!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Line 106 crashes. Replace block