mirror of
https://github.com/facebook/react-native.git
synced 2026-11-18 20:19:07 +00:00
Fix Android text descender clipping with tight lineHeight (#57115)
Summary: Fixes https://github.com/react/react-native/issues/49886. Close torin-asakura/workspace#115. Android TextView clips text drawing to the view bounds in its default onDraw path. For explicit lineHeight, CustomLineHeightSpan should keep paragraph layout bounds tied to the requested lineHeight; using font top/bottom to avoid clipping fixes the single-line repro but expands multiline text. This keeps the line-height layout contract intact and draws ordinary non-selectable ReactTextView text directly when overflow is visible, avoiding TextView's internal clipRect. Selectable/linkify text and non-visible overflow continue to use the regular TextView drawing path. ## Changelog: [ANDROID] [FIXED] - Prevent descenders from being clipped when Android text lineHeight matches fontSize Pull Request resolved: https://github.com/react/react-native/pull/57115 Test Plan: Command: ```sh ./gradlew -Preact.internal.useHermesStable=true :packages:react-native:ReactAndroid:testDebugUnitTest --tests com.facebook.react.views.text.internal.span.CustomLineHeightSpanTest --tests com.facebook.react.views.text.ReactTextViewTest ``` Result: ```text BUILD SUCCESSFUL ``` Command: ```sh ./gradlew -Preact.internal.useHermesStable=true :packages:react-native:ReactAndroid:ktfmtCheck ``` Result: ```text BUILD SUCCESSFUL ``` Command: ```sh git diff --check ``` Result: no output. Command: ```sh ./node_modules/.bin/prettier --check packages/rn-tester/js/examples/Text/TextExample.android.js ``` Result: ```text All matched files use Prettier code style! ``` Command: ```sh ./node_modules/.bin/eslint --max-warnings 0 packages/rn-tester/js/examples/Text/TextExample.android.js ``` Result: no output. RNTester visual repro with fontSize: 24, lineHeight: 24, and gjpqy. Visual evidence: <details> <summary>Before this PR</summary>  </details> <details> <summary>After this PR</summary>  </details> Reviewed By: cortinico Differential Revision: D108406457 Pulled By: javache fbshipit-source-id: be5e33ebca61dc24a3aa18376c49cf6690891d07
This commit is contained in:
1 parent
91b2537f8a
commit
bb3c121073
3 files changed
+330
-21
No files matched your search
+77
-21
@@ -218,28 +218,16 @@ public class ReactTextView extends AppCompatTextView implements ReactCompoundVie
|
||||
if (layout != null) {
|
||||
CanvasEffectSpan[] drawSpans =
|
||||
spanned.getSpans(0, spanned.length(), CanvasEffectSpan.class);
|
||||
if (drawSpans.length > 0) {
|
||||
canvas.save();
|
||||
canvas.translate(getCompoundPaddingLeft(), getExtendedPaddingTop());
|
||||
for (CanvasEffectSpan span : drawSpans) {
|
||||
int start = spanned.getSpanStart(span);
|
||||
int end = spanned.getSpanEnd(span);
|
||||
span.onPreDraw(start, end, canvas, layout);
|
||||
}
|
||||
canvas.restore();
|
||||
|
||||
super.onDraw(canvas);
|
||||
|
||||
canvas.save();
|
||||
canvas.translate(getCompoundPaddingLeft(), getExtendedPaddingTop());
|
||||
for (CanvasEffectSpan span : drawSpans) {
|
||||
int start = spanned.getSpanStart(span);
|
||||
int end = spanned.getSpanEnd(span);
|
||||
span.onDraw(start, end, canvas, layout);
|
||||
}
|
||||
canvas.restore();
|
||||
if (shouldDrawLayoutWithoutTextViewClip()) {
|
||||
drawLayoutWithoutTextViewClip(canvas, spanned, layout, drawSpans);
|
||||
} else {
|
||||
super.onDraw(canvas);
|
||||
if (drawSpans.length > 0) {
|
||||
drawTextEffects(canvas, spanned, layout, drawSpans, true, false);
|
||||
super.onDraw(canvas);
|
||||
drawTextEffects(canvas, spanned, layout, drawSpans, false, false);
|
||||
} else {
|
||||
super.onDraw(canvas);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
super.onDraw(canvas);
|
||||
@@ -250,6 +238,74 @@ public class ReactTextView extends AppCompatTextView implements ReactCompoundVie
|
||||
}
|
||||
}
|
||||
|
||||
private boolean shouldDrawLayoutWithoutTextViewClip() {
|
||||
return mOverflow == Overflow.VISIBLE && !mTextIsSelectable && getMovementMethod() == null;
|
||||
}
|
||||
|
||||
private void drawLayoutWithoutTextViewClip(
|
||||
Canvas canvas, Spannable spanned, Layout layout, CanvasEffectSpan[] drawSpans) {
|
||||
getPaint().setColor(getCurrentTextColor());
|
||||
getPaint().drawableState = getDrawableState();
|
||||
|
||||
drawTextEffects(canvas, spanned, layout, drawSpans, true, true);
|
||||
|
||||
canvas.save();
|
||||
canvas.translate(
|
||||
getCompoundPaddingLeft(), getExtendedPaddingTop() + getVerticalGravityOffset(layout));
|
||||
layout.draw(canvas);
|
||||
canvas.restore();
|
||||
|
||||
drawTextEffects(canvas, spanned, layout, drawSpans, false, true);
|
||||
}
|
||||
|
||||
private void drawTextEffects(
|
||||
Canvas canvas,
|
||||
Spannable spanned,
|
||||
Layout layout,
|
||||
CanvasEffectSpan[] drawSpans,
|
||||
boolean beforeText,
|
||||
boolean includeVerticalGravityOffset) {
|
||||
if (drawSpans.length == 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
canvas.save();
|
||||
canvas.translate(
|
||||
getCompoundPaddingLeft(),
|
||||
getExtendedPaddingTop()
|
||||
+ (includeVerticalGravityOffset ? getVerticalGravityOffset(layout) : 0));
|
||||
for (CanvasEffectSpan span : drawSpans) {
|
||||
int start = spanned.getSpanStart(span);
|
||||
int end = spanned.getSpanEnd(span);
|
||||
if (beforeText) {
|
||||
span.onPreDraw(start, end, canvas, layout);
|
||||
} else {
|
||||
span.onDraw(start, end, canvas, layout);
|
||||
}
|
||||
}
|
||||
canvas.restore();
|
||||
}
|
||||
|
||||
private int getVerticalGravityOffset(Layout layout) {
|
||||
int availableVerticalSpace = getAvailableVerticalSpace();
|
||||
if (layout.getHeight() >= availableVerticalSpace) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
int verticalGravity = getGravity() & Gravity.VERTICAL_GRAVITY_MASK;
|
||||
if (verticalGravity == Gravity.BOTTOM) {
|
||||
return availableVerticalSpace - layout.getHeight();
|
||||
} else if (verticalGravity == Gravity.CENTER_VERTICAL) {
|
||||
return (availableVerticalSpace - layout.getHeight()) / 2;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
private int getAvailableVerticalSpace() {
|
||||
return getHeight() - getExtendedPaddingTop() - getExtendedPaddingBottom();
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
|
||||
try (SystraceSection s = new SystraceSection("ReactTextView.onMeasure")) {
|
||||
|
||||
+154
@@ -0,0 +1,154 @@
|
||||
/*
|
||||
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
package com.facebook.react.views.text
|
||||
|
||||
import android.content.Context
|
||||
import android.graphics.Bitmap
|
||||
import android.graphics.Canvas
|
||||
import android.graphics.Color
|
||||
import android.graphics.Paint
|
||||
import android.text.SpannableString
|
||||
import android.text.Spanned
|
||||
import android.text.style.ReplacementSpan
|
||||
import android.util.TypedValue
|
||||
import android.view.Gravity
|
||||
import android.view.View
|
||||
import androidx.core.graphics.createBitmap
|
||||
import androidx.core.graphics.get
|
||||
import org.assertj.core.api.Assertions.assertThat
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
import org.robolectric.RobolectricTestRunner
|
||||
import org.robolectric.RuntimeEnvironment
|
||||
|
||||
@RunWith(RobolectricTestRunner::class)
|
||||
class ReactTextViewTest {
|
||||
|
||||
@Test
|
||||
fun drawsGlyphInkOutsideLineHeightWhenOverflowIsVisible() {
|
||||
val bitmap = drawReactTextViewWithOverflow(null)
|
||||
|
||||
assertThat(hasVisiblePixelBelowViewBounds(bitmap)).isTrue()
|
||||
}
|
||||
|
||||
@Test
|
||||
fun bottomGravityDoesNotShiftLayoutUpWhenTextIsTallerThanView() {
|
||||
val lineHeight = 48
|
||||
val viewHeight = 24
|
||||
val bitmap = drawReactTextViewWithOverflow(null, lineHeight, viewHeight, Gravity.BOTTOM)
|
||||
|
||||
assertThat(firstVisiblePixelY(bitmap)).isGreaterThanOrEqualTo(lineHeight)
|
||||
}
|
||||
|
||||
private fun drawReactTextViewWithOverflow(overflow: String?): Bitmap {
|
||||
return drawReactTextViewWithOverflow(overflow, lineHeight = 24, viewHeight = 24, gravity = null)
|
||||
}
|
||||
|
||||
private fun drawReactTextViewWithOverflow(
|
||||
overflow: String?,
|
||||
lineHeight: Int,
|
||||
viewHeight: Int,
|
||||
gravity: Int?,
|
||||
): Bitmap {
|
||||
val width = 200
|
||||
val bitmapHeight = 80
|
||||
val text = SpannableString("x")
|
||||
text.setSpan(
|
||||
OverflowingInkSpan(lineHeight),
|
||||
0,
|
||||
text.length,
|
||||
Spanned.SPAN_EXCLUSIVE_EXCLUSIVE,
|
||||
)
|
||||
|
||||
val view = TestReactTextView(RuntimeEnvironment.getApplication())
|
||||
view.setTextColor(Color.BLACK)
|
||||
view.setTextSize(TypedValue.COMPLEX_UNIT_PX, 24f)
|
||||
view.includeFontPadding = true
|
||||
view.setSpanned(text)
|
||||
view.text = text
|
||||
view.setOverflow(overflow)
|
||||
if (gravity != null) {
|
||||
view.setGravityVertical(gravity)
|
||||
}
|
||||
view.measure(
|
||||
View.MeasureSpec.makeMeasureSpec(width, View.MeasureSpec.EXACTLY),
|
||||
View.MeasureSpec.makeMeasureSpec(viewHeight, View.MeasureSpec.EXACTLY),
|
||||
)
|
||||
view.layout(0, 0, width, viewHeight)
|
||||
|
||||
return createBitmap(width, bitmapHeight).also {
|
||||
view.drawTextForTest(Canvas(it))
|
||||
}
|
||||
}
|
||||
|
||||
private fun hasVisiblePixelBelowViewBounds(bitmap: Bitmap): Boolean {
|
||||
for (y in 24 until bitmap.height) {
|
||||
for (x in 0 until bitmap.width) {
|
||||
if (Color.alpha(bitmap[x, y]) != 0) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
private fun firstVisiblePixelY(bitmap: Bitmap): Int {
|
||||
for (y in 0 until bitmap.height) {
|
||||
for (x in 0 until bitmap.width) {
|
||||
if (Color.alpha(bitmap[x, y]) != 0) {
|
||||
return y
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return bitmap.height
|
||||
}
|
||||
|
||||
private class TestReactTextView(context: Context) : ReactTextView(context) {
|
||||
fun drawTextForTest(canvas: Canvas) {
|
||||
super.draw(canvas)
|
||||
}
|
||||
}
|
||||
|
||||
private class OverflowingInkSpan(private val lineHeight: Int) : ReplacementSpan() {
|
||||
override fun getSize(
|
||||
paint: Paint,
|
||||
text: CharSequence,
|
||||
start: Int,
|
||||
end: Int,
|
||||
fm: Paint.FontMetricsInt?,
|
||||
): Int {
|
||||
fm?.ascent = -lineHeight
|
||||
fm?.descent = 0
|
||||
fm?.top = -lineHeight
|
||||
fm?.bottom = 0
|
||||
return lineHeight
|
||||
}
|
||||
|
||||
override fun draw(
|
||||
canvas: Canvas,
|
||||
text: CharSequence,
|
||||
start: Int,
|
||||
end: Int,
|
||||
x: Float,
|
||||
top: Int,
|
||||
y: Int,
|
||||
bottom: Int,
|
||||
paint: Paint,
|
||||
) {
|
||||
canvas.drawRect(
|
||||
x,
|
||||
y + (lineHeight / 4f),
|
||||
x + lineHeight,
|
||||
y + (lineHeight / 2f),
|
||||
paint,
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
+99
@@ -0,0 +1,99 @@
|
||||
/*
|
||||
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
package com.facebook.react.views.text.internal.span
|
||||
|
||||
import android.graphics.Paint
|
||||
import android.text.Layout
|
||||
import android.text.SpannableString
|
||||
import android.text.Spanned
|
||||
import android.text.StaticLayout
|
||||
import android.text.TextPaint
|
||||
import org.assertj.core.api.Assertions.assertThat
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
import org.robolectric.RobolectricTestRunner
|
||||
|
||||
@RunWith(RobolectricTestRunner::class)
|
||||
class CustomLineHeightSpanTest {
|
||||
|
||||
@Test
|
||||
fun tightLineHeightDoesNotClipFirstOrLastLineFontBounds() {
|
||||
val span = CustomLineHeightSpan(16f)
|
||||
val fm =
|
||||
Paint.FontMetricsInt().apply {
|
||||
top = -18
|
||||
ascent = -14
|
||||
descent = 6
|
||||
bottom = 8
|
||||
}
|
||||
|
||||
span.chooseHeight("gjpqy", 0, 5, 0, 0, fm)
|
||||
|
||||
assertThat(fm.ascent).isEqualTo(-12)
|
||||
assertThat(fm.descent).isEqualTo(4)
|
||||
assertThat(fm.top).isEqualTo(-12)
|
||||
assertThat(fm.bottom).isEqualTo(4)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun looseLineHeightStillExpandsFirstAndLastLineBounds() {
|
||||
val span = CustomLineHeightSpan(24f)
|
||||
val fm =
|
||||
Paint.FontMetricsInt().apply {
|
||||
top = -18
|
||||
ascent = -14
|
||||
descent = 6
|
||||
bottom = 8
|
||||
}
|
||||
|
||||
span.chooseHeight("gjpqy", 0, 5, 0, 0, fm)
|
||||
|
||||
assertThat(fm.ascent).isEqualTo(-16)
|
||||
assertThat(fm.descent).isEqualTo(8)
|
||||
assertThat(fm.top).isEqualTo(-16)
|
||||
assertThat(fm.bottom).isEqualTo(8)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun tightLineHeightDoesNotExpandStaticLayoutHeightWithFontPadding() {
|
||||
val layout = buildStaticLayout("gjpqy\ngjpqy\ngjpqy", lineHeight = 24)
|
||||
|
||||
assertThat(layout.lineCount).isEqualTo(3)
|
||||
assertThat(layout.height).isEqualTo(72)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun tightLineHeightDoesNotExpandSingleLineStaticLayoutHeightWithFontPadding() {
|
||||
val layout = buildStaticLayout("gjpqy", lineHeight = 24)
|
||||
|
||||
assertThat(layout.lineCount).isEqualTo(1)
|
||||
assertThat(layout.height).isEqualTo(24)
|
||||
}
|
||||
|
||||
private fun buildStaticLayout(text: String, lineHeight: Int): StaticLayout {
|
||||
val spannable = SpannableString(text)
|
||||
spannable.setSpan(
|
||||
CustomLineHeightSpan(lineHeight.toFloat()),
|
||||
0,
|
||||
text.length,
|
||||
Spanned.SPAN_EXCLUSIVE_EXCLUSIVE,
|
||||
)
|
||||
|
||||
return StaticLayout.Builder.obtain(
|
||||
spannable,
|
||||
0,
|
||||
spannable.length,
|
||||
TextPaint().apply { textSize = 24f },
|
||||
400,
|
||||
)
|
||||
.setAlignment(Layout.Alignment.ALIGN_NORMAL)
|
||||
.setIncludePad(true)
|
||||
.setLineSpacing(0f, 1f)
|
||||
.build()
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user