Skip to content

Commit

Permalink
improve text line height calculation (#46362)
Browse files Browse the repository at this point in the history
Summary:
Pull Request resolved: #46362

## Context
There is a recurring issue in React Native where text containing accented characters, non-latin scripts, and special glyphs experiences truncation when line height is set too small, even when the line height equals or exceeds the font size. This problem has a significant impact, particularly when rendering complex text in multiple languages or special character sets.

See: https://docs.google.com/document/d/1W-A80gKAyhVbz_WKktSwwJP5qm6h6ZBjFNcsVbknXhI/edit?usp=sharing for more context

## Investigation
Previously, when font metrics (ascent, descent, top, bottom) exceeded the line height, the logic arbitrarily prioritized descent over ascent and bottom top. This led to vertical misalignment and text clipping at the top of the text.

## Proposed Implementation:

1. Descent Exceeds Line Height:
Descent is capped to fit within the line height, setting ascent and top to 0, similar to the current behavior.
2. Shrink ascent and descent equally:
When the combined ascent and descent exceed the line height, the vertical deficit is split proportionally between them, ensuring even distribution of the space.
3. Proportionally shrink top and bottom:
If the top and bottom together exceed the line height, reductions are now applied proportionally based on the delta between top and ascent and bottom and descent.

Differential Revision: D62295350
  • Loading branch information
mellyeliu authored and facebook-github-bot committed Sep 10, 2024
1 parent b4d3fbb commit cdd4633
Showing 1 changed file with 69 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ package com.facebook.react.views.text.internal.span

import android.graphics.Paint.FontMetricsInt
import android.text.style.LineHeightSpan
import kotlin.math.abs
import kotlin.math.ceil
import kotlin.math.floor
import kotlin.math.min
import com.facebook.react.internal.featureflags.ReactNativeFeatureFlags;

/**
* We use a custom [LineHeightSpan], because `lineSpacingExtra` is broken. Details here:
Expand All @@ -20,13 +22,62 @@ import kotlin.math.min
public class CustomLineHeightSpan(height: Float) : LineHeightSpan, ReactSpan {
public val lineHeight: Int = ceil(height.toDouble()).toInt()

public override fun chooseHeight(
text: CharSequence?,
start: Int,
end: Int,
spanstartv: Int,
v: Int,
fm: FontMetricsInt
private fun chooseCenteredHeight(
fm: FontMetricsInt,
) {
if (fm.descent > lineHeight) {
// Show as much descent as possible
fm.descent = lineHeight
fm.bottom = 0
fm.top = 0
fm.ascent = 0
} else if (-fm.ascent + fm.descent > lineHeight) {
// Calculate the amount we are over, and split the adjustment between descent and ascent
val difference = -(lineHeight + fm.ascent - fm.descent) / 2
val remainder = difference % 2
fm.ascent = fm.ascent + difference
fm.descent = fm.descent - difference - remainder
fm.top = fm.ascent
fm.bottom = fm.descent
} else if (-fm.top + fm.bottom > lineHeight) {
val excess = (-fm.top + fm.bottom) - lineHeight

// Calculate the differences from top to ascent and bottom to descent
val topToAscent = abs(fm.top - fm.ascent)
val bottomToDescent = abs(fm.bottom - fm.descent)

// Calculate the total delta
val totalDelta = topToAscent + bottomToDescent

// Calculate proportional reductions
val topReduction = (excess * topToAscent / totalDelta).toInt()
val bottomReduction = (excess * bottomToDescent / totalDelta).toInt()

// Adjust fm.top and fm.bottom
fm.top += topReduction
fm.bottom += bottomReduction

// If there's a remainder, put it on the top
val remainder = excess - (topReduction + bottomReduction)
fm.top += remainder
} else {
// Show proportionally additional ascent / top & descent / bottom
val additional = lineHeight - (-fm.top + fm.bottom)

// Round up for the negative values and down for the positive values (arbitrary choice)
// So that bottom - top equals additional even if it's an odd number.
val top = (fm.top - ceil(additional / 2.0f)).toInt()
val bottom = (fm.bottom + floor(additional / 2.0f)).toInt()

fm.top = top
fm.ascent = top
fm.descent = bottom
fm.bottom = bottom
}
}

private fun chooseOriginalHeight(
fm: FontMetricsInt,
) {
// This is more complicated that I wanted it to be. You can find a good explanation of what the
// FontMetrics mean here: http://stackoverflow.com/questions/27631736.
Expand Down Expand Up @@ -66,4 +117,15 @@ public class CustomLineHeightSpan(height: Float) : LineHeightSpan, ReactSpan {
fm.bottom = bottom
}
}

public override fun chooseHeight(
text: CharSequence?,
start: Int,
end: Int,
spanstartv: Int,
v: Int,
fm: FontMetricsInt,
) {
if (ReactNativeFeatureFlags.enableLineHeightCentering()) chooseCenteredHeight(fm) else chooseOriginalHeight(fm)
}
}

0 comments on commit cdd4633

Please sign in to comment.