跳到主要内容
版本:0.82

文本

一个用于显示文本的 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>First part and </Text>
<Text>second part</Text>
</Text>
// 文本容器:如果空间允许,文本会以内联方式显示
// |First part and second part|

// 否则,文本会像一个整体一样流动
// |First part |
// |and second |
// |part |

<View>
<Text>First part and </Text>
<Text>second part</Text>
</View>
// View 容器:每段文本都是自己的块
// |First part and|
// |second part |

// 否则,文本会在自己的块中流动
// |First part |
// |and |
// |second part|

有限的样式继承​

在 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>
Some text
</View>

// GOOD
<View>
<Text>
Some 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'}}>
I am bold
<Text style={{color: 'red'}}>and 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 添加 Accessibility Traits


accessibilityState​

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

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


accessibilityActions​

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

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

类型必需
array否

onAccessibilityAction​

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

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

类型必需
function否

accessible​

设置为 true 时,表示该视图是一个无障碍元素。

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

类型默认值
booleantrue

adjustsFontSizeToFit​

指定当样式约束不足时,字体是否应自动缩小以适配。

类型默认值
booleanfalse

allowFontScaling​

指定字体是否应缩放以适配文本大小无障碍设置。

类型默认值
booleantrue

android_hyphenationFrequency
Android
​

设置在 Android API Level 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

ref​

挂载时会分配给一个 element node 的 ref 设置器。

请注意,Text 组件不会提供 text node,这与 Web 上的段落元素(<p>)类似:它们是 element node,而不是 text node。text node 可以在其子节点中找到。


role​

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

类型
Role

selectable​

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

类型默认值
booleanfalse

selectionColor
Android
​

文本的高亮颜色。

类型
color

style​


suppressHighlighting
iOS
​

当设置为 true 时,按下文本时不会发生任何视觉变化。默认情况下,按下时会用灰色椭圆高亮文本。

类型默认值
booleanfalse

testID​

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

类型
string

textBreakStrategy
Android
​

在 Android API Level 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。