跳到主要内容
版本:0.81

文本

用于显示文本的 React 组件。

Text 支持嵌套、样式和触摸处理。

在下面的示例中,嵌套的标题和正文文本会从 styles.baseText 继承 fontFamily,但标题提供了自己额外的样式。由于存在字面上的换行,标题和正文会彼此上下排列:

嵌套文本​

Android 和 iOS 都允许你通过用特定格式(如粗体或彩色文本)标注字符串的范围来显示格式化文本(iOS 上使用 NSAttributedString,Android 上使用 SpannableString)。在实践中,这非常繁琐。对于 React Native,我们决定采用 Web 的范式,即你可以通过嵌套文本来实现相同效果。

在幕后,React Native 会将其转换为一个扁平的 NSAttributedString 或 SpannableString,其中包含以下信息:

"I am bold and red"
0-9: bold
9-17: bold, red

容器​

相对于布局而言,<Text> 元素是独特的:其内部的所有内容不再使用 Flexbox 布局,而是使用文本布局。这意味着 <Text> 内部的元素不再是矩形,而是在遇到行尾时自动换行。

React TSX
<Text>
<Text>第一部分和 </Text>
<Text>第二部分</Text>
</Text>
// Text 容器:如果空间允许,文本会以内联方式显示
// |第一部分和 第二部分|

// 否则,文本会像一个整体一样流动
// |第一部分 |
// |和第二 |
// |部分 |

<View>
<Text>第一部分和 </Text>
<Text>第二部分</Text>
</View>
// View 容器:每段文本都是自己的块
// |第一部分和|
// |第二部分 |

// 否则,文本会在自己的块中流动
// |第一部分 |
// |和 |
// |第二部分|

有限的样式继承​

在 Web 上,为整个文档设置字体族和字号的常见方式,是利用继承的 CSS 属性,例如:

CSS
html {
font-family:
'lucida grande', tahoma, verdana, arial, sans-serif;
font-size: 11px;
color: #141823;
}

文档中的所有元素都会继承这个字体,除非它们或它们的父元素指定了新的规则。

在 React Native 中,我们对此更严格:你必须将所有文本节点包裹在 <Text> 组件中。你不能把文本节点直接放在 <View> 下。

React TSX
// BAD: 会抛出异常,不能把文本节点作为 <View> 的子元素
<View>
某些文本
</View>

// GOOD
<View>
<Text>
某些文本
</Text>
</View>

你也会失去为整个子树设置默认字体的能力。同时,fontFamily 只接受单个字体名称,这与 CSS 中的 font-family 不同。推荐在整个应用中保持一致字体和字号的方式,是创建一个包含这些设置的组件 MyAppText,并在应用中复用它。你还可以用这个组件创建更具体的组件,例如 MyAppHeaderText,用于其他类型的文本。

React TSX
<View>
<MyAppText>使用整个应用默认字体样式的文本</MyAppText>
<MyAppHeaderText>样式为标题的文本</MyAppHeaderText>
</View>

假设 MyAppText 是一个只会把其子元素以带样式的 Text 组件渲染出来的组件,那么 MyAppHeaderText 可以定义如下:

React TSX
const MyAppHeaderText = ({children}) => {
return (
<MyAppText>
<Text style={{fontSize: 20}}>{children}</Text>
</MyAppText>
);
};

以这种方式组合 MyAppText 可以确保我们从顶层组件获得样式,同时仍然保留在特定用例中添加或覆盖这些样式的能力。

React Native 仍然保留样式继承的概念,但仅限于文本子树。在这种情况下,第二部分会同时是粗体和红色。

React TSX
<Text style={{fontWeight: 'bold'}}>
我是粗体
<Text style={{color: 'red'}}>而且是红色</Text>
</Text>

我们认为这种更受约束的文本样式设置方式会带来更好的应用:

  • (开发者)React 组件的设计非常强调隔离:你应该能够把某个组件放到应用中的任何位置,只要 props 相同,它就会以相同的方式显示和行为。那些可能从外部继承而来的文本属性会破坏这种隔离性。

  • (实现者)React Native 的实现也更简单了。我们不需要在每个元素上都设置 fontFamily 字段,也不需要在每次显示文本节点时都可能向上遍历整棵树直到根节点。样式继承只被编码在原生 Text 组件内部,不会泄漏到其他组件或系统本身。


参考

属性​

accessibilityHint​

辅助功能提示可帮助用户理解当他们对辅助功能元素执行操作时会发生什么,前提是这一结果不能从辅助功能标签中清楚得知。

类型
string

accessibilityLanguage
iOS
​

一个值,用于指示用户与该元素交互时,屏幕阅读器应使用哪种语言。它应遵循 BCP 47 规范。

更多信息请参见 iOS accessibilityLanguage 文档。

类型
string

accessibilityLabel​

覆盖用户与该元素交互时屏幕阅读器朗读的文本。默认情况下,标签是通过遍历所有子元素并将所有以空格分隔的 Text 节点累积起来构造的。

类型
string

accessibilityRole​

告诉屏幕阅读器将当前聚焦的元素视为具有特定角色。

在 iOS 上,这些角色会映射到对应的无障碍特征。Image button 的功能与同时设置 image 和 button 特征相同。更多信息请参阅无障碍指南。

在 Android 上,这些角色在 TalkBack 中的功能与在 iOS 中为 VoiceOver 添加辅助功能特性类似


accessibilityState​

告诉屏幕阅读器将当前聚焦的元素视为处于某个特定状态。

你可以提供一个状态、没有状态,或多个状态。状态必须通过对象传入,例如 {selected: true, disabled: true}。


accessibilityActions​

辅助功能操作允许辅助技术以编程方式调用组件的操作。accessibilityActions 属性应包含一个操作对象列表。每个操作对象应包含字段名和标签。

更多信息请参见 辅助功能指南。

类型必填
array否

onAccessibilityAction​

当用户执行辅助功能操作时调用。此函数的唯一参数是一个事件,其中包含要执行的操作名称。

更多信息请参见 辅助功能指南。

类型必填
function否

accessible​

设置为 true 时,表示该视图是一个辅助功能元素。

更多信息请参阅无障碍指南。

类型默认值
booleantrue

adjustsFontSizeToFit​

指定在给定样式约束下,字体是否应自动缩小以适配。

类型默认值
booleanfalse

allowFontScaling​

指定字体是否应按文字大小辅助功能设置进行缩放。

类型默认值
booleantrue

android_hyphenationFrequency
Android
​

设置在 Android API 23 及以上版本中确定单词断行时使用的自动连字符频率。

类型默认值
enum('none', 'normal','full')'none'

aria-busy​

表示某个元素正在被修改,并且辅助技术可能希望在变化完成后再通知用户更新。

类型默认值
booleanfalse

aria-checked​

表示可勾选元素的状态。该字段可以是布尔值,也可以是 "mixed" 字符串,用于表示混合状态的复选框。

类型默认值
boolean, 'mixed'false

aria-disabled​

表示该元素可感知但已禁用,因此不可编辑或无法操作。

类型默认值
booleanfalse

aria-expanded​

表示可展开元素当前是展开还是折叠状态。

类型默认值
booleanfalse

aria-label​

定义用于标记交互元素的字符串值。

类型
string

aria-selected​

表示可选择元素当前是否被选中。

类型
boolean

dataDetectorType
Android
​

确定在文本元素中会被转换为可点击 URL 的数据类型。默认情况下,不检测任何数据类型。

你只能提供一种类型。

类型默认值
enum('phoneNumber', 'link', 'email', 'none', 'all')'none'

disabled
Android
​

指定用于测试目的的文本视图禁用状态。

类型默认值
boolfalse

dynamicTypeRamp
iOS
​

应用于 iOS 上该元素的 Dynamic Type 字号等级。

类型默认值
enum('caption2', 'caption1', 'footnote', 'subheadline', 'callout', 'body', 'headline', 'title3', 'title2', 'title1', 'largeTitle')'body'

ellipsizeMode​

当设置了 numberOfLines 时,此属性定义文本如何被截断。numberOfLines 必须与此属性一起设置。

可取以下值之一:

  • head - 显示这一行,使其末尾适配容器,而行首缺失的文本用省略号表示。例如,"...wxyz"
  • middle - 显示这一行,使其开头和结尾适配容器,而中间缺失的文本用省略号表示。"ab...yz"
  • tail - 显示这一行,使其开头适配容器,而行尾缺失的文本用省略号表示。例如,"abcd..."
  • clip - 文本行不会绘制到文本容器边缘之外。

在 Android 上,当 numberOfLines 设置为大于 1 的值时,只有 tail 值能正常工作。

类型默认值
enum('head', 'middle', 'tail', 'clip')tail

id​

用于从原生代码中定位此视图。优先级高于 nativeID 属性。

类型
string

maxFontSizeMultiplier​

指定在启用 allowFontScaling 时字体可能达到的最大缩放倍数。可能的取值:

  • null/undefined:继承自父节点或全局默认值(0)
  • 0:没有最大值,忽略父级/全局默认值
  • >= 1:将此节点的 maxFontSizeMultiplier 设置为该值
类型默认值
numberundefined

minimumFontScale​

指定在启用 adjustsFontSizeToFit 时字体可能达到的最小缩放倍数。(取值范围 0.01-1.0)。

类型
number

nativeID​

用于从原生代码中定位此视图。

类型
string

numberOfLines​

在计算文本布局(包括自动换行)后,用于通过省略号截断文本,使总行数不超过该数值。将此属性设为 0 会取消该值,这意味着不会应用行数限制。

此属性通常与 ellipsizeMode 一起使用。

类型默认值
number0

onLayout​

在挂载时以及布局变化时调用。

类型
({nativeEvent: LayoutEvent}) => void

onLongPress​

长按时调用此函数。

类型
({nativeEvent: PressEvent}) => void

onMoveShouldSetResponder​

这个视图是否希望“抢占”触摸响应?当 View 不是 responder 时,每次触摸移动都会调用此方法。

类型
({nativeEvent: PressEvent}) => boolean

onPress​

用户按下时调用,在 onPressOut 之后触发。

类型
({nativeEvent: PressEvent}) => void

onPressIn​

在触摸刚接触时立即调用,早于 onPressOut 和 onPress。

类型
({nativeEvent: PressEvent}) => void

onPressOut​

在触摸释放时调用。

类型
({nativeEvent: PressEvent}) => void

onResponderGrant​

此时 View 正在响应触摸事件。这是高亮并向用户展示正在发生什么的时候。

在 Android 上,从此回调返回 true 可阻止任何其他原生组件在该 responder 结束之前成为 responder。

类型
({nativeEvent: PressEvent}) => void | boolean

onResponderMove​

用户正在移动他们的手指。

类型
({nativeEvent: PressEvent}) => void

onResponderRelease​

在触摸结束时触发。

类型
({nativeEvent: PressEvent}) => void

onResponderTerminate​

responder 已从 View 中被接管。可能是在调用 onResponderTerminationRequest 后被其他视图接管,也可能在未询问的情况下被操作系统接管(例如在 iOS 上发生于控制中心/通知中心)。

类型
({nativeEvent: PressEvent}) => void

onResponderTerminationRequest​

其他某个 View 想成为 responder,并请求此 View 释放其 responder。返回 true 允许其释放。

类型
({nativeEvent: PressEvent}) => boolean

onStartShouldSetResponderCapture​

如果父级 View 希望在触摸开始时阻止子级 View 成为 responder,它应该使用此处理函数,并返回 true。

类型
({nativeEvent: PressEvent}) => boolean

onTextLayout​

在 Text 布局变化时调用。

类型
(TextLayoutEvent) => mixed

pressRetentionOffset​

当滚动视图被禁用时,它定义了在按钮失效之前,触摸可以离开按钮多远。一旦失效,尝试把它移回去,你会看到按钮又重新激活了!在滚动视图被禁用时,来回移动几次。确保传入一个常量以减少内存分配。

类型
Rect, number

role​

role 会向辅助技术用户传达组件的用途。其优先级高于 accessibilityRole 属性。

类型
Role

selectable​

允许用户选择文本,以使用原生复制和粘贴功能。

类型默认值
booleanfalse

selectionColor
Android
​

文本的高亮颜色。

类型
color

style​


suppressHighlighting
iOS
​

设置为 true 时,文本按下时不会发生可视变化。默认情况下,按下文本时会以灰色椭圆高亮显示。

类型默认值
booleanfalse

testID​

用于在端到端测试中定位此视图。

类型
string

textBreakStrategy
Android
​

在 Android API 23 及以上版本中设置文本断行策略,可用值为 simple、highQuality、balanced。

类型默认值
enum('simple', 'highQuality', 'balanced')highQuality

lineBreakStrategyIOS
iOS
​

在 iOS 14+ 上设置断行策略。可用值为 none、standard、hangul-word 和 push-out。

类型默认值
enum('none', 'standard', 'hangul-word', 'push-out')'none'

类型定义​

TextLayout​

TextLayout 对象是 TextLayoutEvent 回调的一部分,并包含 Text 行的测量数据。

示例​

JavaScript
{
capHeight: 10.496,
ascender: 14.624,
descender: 4,
width: 28.224,
height: 18.624,
xHeight: 6.048,
x: 0,
y: 0
}

属性​

名称类型可选描述
ascendernumber否文本布局变化后,该行的上升部高度。
capHeightnumber否基线以上的大写字母高度。
descendernumber否文本布局变化后,该行的下降部高度。
heightnumber否文本布局变化后,该行的高度。
widthnumber否文本布局变化后,该行的宽度。
xnumber否Text 组件内该行的 X 坐标。
xHeightnumber否基线与该行中线(正文字号)之间的距离。
ynumber否Text 组件内该行的 Y 坐标。

TextLayoutEvent​

TextLayoutEvent 对象会在组件布局变化时作为回调结果返回。它包含一个名为 lines 的键,其值为一个数组,数组中包含与每一行已渲染文本相对应的 TextLayout 对象。

示例​

JavaScript
{
lines: [
TextLayout,
TextLayout,
// ...
];
target: 1127;
}

属性​

名称类型可选描述
linesTextLayout 数组否提供每一行已渲染文本的 TextLayout 数据。
targetnumber否元素的节点 id。