文本
用于显示文本的 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> 内部的元素不再是矩形,而是在遇到行尾时换行。
<Text>
<Text>First part and </Text>
<Text>second part</Text>
</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 属性,例如:
html {
font-family:
'lucida grande', tahoma, verdana, arial, sans-serif;
font-size: 11px;
color: #141823;
}
文档中的所有元素都会继承这个字体,除非它们自己或其父元素指定了新的规则。
在 React Native 中,我们对此更严格:你必须将所有文本节点包裹在 <Text> 组件内部。不能直接在 <View> 下放置文本节点。
// BAD: will raise exception, can't have a text node as child of a <View>
<View>
Some text
</View>
// GOOD
<View>
<Text>
Some text
</Text>
</View>
你还会失去为整个子树设置默认字体的能力。与此同时,fontFamily 只接受单个字体名称,这与 CSS 中的 font-family 不同。在整个应用中使用一致字体和字号的推荐方式,是创建一个包含这些设置的组件 MyAppText,并在应用中复用它。你也可以用这个组件来创建更具体的组件,比如用于其他类型文本的 MyAppHeaderText。
<View>
<MyAppText>
使用整个应用默认字体样式的文本
</MyAppText>
<MyAppHeaderText>标题样式的文本</MyAppHeaderText>
</View>
假设 MyAppText 是一个组件,它只会将其 children 渲染到带样式的 Text 组件中,那么 MyAppHeaderText 可以定义如下:
const MyAppHeaderText = ({children}) => {
return (
<MyAppText>
<Text style={{fontSize: 20}}>{children}</Text>
</MyAppText>
);
};
以这种方式组合 MyAppText 可以确保我们从顶层组件获得样式,同时仍然保留在特定使用场景中添加或覆盖样式的能力。
React Native 仍然具有样式继承的概念,但仅限于文本子树。在这种情况下,第二部分将同时是粗体和红色。
<Text style={{fontWeight: 'bold'}}>
I am bold
<Text style={{color: 'red'}}>and red</Text>
</Text>
我们认为这种更受约束的文本样式方式会带来更好的应用:
-
(开发者)React 组件的设计强调强隔离:你应该能够将某个组件放到应用中的任何位置,并相信只要 props 相同,它的外观和行为就会相同。若文本属性可以从 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 时,表示该视图是一个无障碍元素。
更多信息请参阅 无障碍指南。
| 类型 | 默认值 |
|---|---|
| boolean | true |
adjustsFontSizeToFit
指定字体是否应自动缩小以适应给定的样式约束。
| 类型 | 默认值 |
|---|---|
| boolean | false |
allowFontScaling
指定字体是否应缩放以遵守文本大小无障碍设置。
| 类型 | 默认值 |
|---|---|
| boolean | true |
android_hyphenationFrequency Android
设置在 Android API Level 23+ 上确定单词断行时使用的自动连字符频率。
| 类型 | 默认值 |
|---|---|
enum('none', 'normal','full') | 'none' |
aria-busy
表示某个元素正在被修改,辅助技术可能会等待更改完成后再将更新告知用户。
| 类型 | 默认值 |
|---|---|
| boolean | false |
aria-checked
表示可勾选元素的状态。此字段可以接受布尔值,或接受 "mixed" 字符串来表示混合复选框。
| 类型 | 默认值 |
|---|---|
| boolean, 'mixed' | false |
aria-disabled
表示该元素可感知但已禁用,因此不可编辑或无法执行其他操作。
| 类型 | 默认值 |
|---|---|
| boolean | false |
aria-expanded
表示可展开元素当前是展开还是折叠状态。
| 类型 | 默认值 |
|---|---|
| boolean | false |
aria-label
定义用于标记交互式元素的字符串值。
| 类型 |
|---|
| string |
aria-selected
表示可选元素当前是否被选中。
| 类型 |
|---|
| boolean |
dataDetectorType Android
确定在文本元素中会被转换为可点击 URL 的数据类型。默认情况下,不检测任何数据类型。
你只能提供一种类型。
| 类型 | 默认值 |
|---|---|
enum('phoneNumber', 'link', 'email', 'none', 'all') | 'none' |
disabled Android
用于测试目的,指定文本视图的禁用状态。
| 类型 | 默认值 |
|---|---|
| bool | false |
dynamicTypeRamp iOS
应用于 iOS 上该元素的 动态类型 级别。
| 类型 | 默认值 |
|---|---|
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设置为该值
| 类型 | 默认值 |
|---|---|
| number | undefined |
minimumFontScale
指定在启用 adjustsFontSizeToFit 时字体可达到的最小缩放比例。(值范围 0.01-1.0)。
| 类型 |
|---|
| number |
nativeID
用于从原生代码中定位此视图。
| 类型 |
|---|
| string |
numberOfLines
用于在计算文本布局(包括换行)后,用省略号截断文本,使总行数不超过此数值。将此属性设置为 0 会取消该值,也就是说不会应用行数限制。
此属性通常与 ellipsizeMode 一起使用。
| 类型 | 默认值 |
|---|---|
| number | 0 |
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
允许用户选择文本,以使用原生复制和粘贴功能。
| 类型 | 默认值 |
|---|---|
| boolean | false |
selectionColor Android
文本的高亮颜色。
| 类型 |
|---|
| color |
style
suppressHighlighting iOS
当为 true 时,按下文本时不会产生任何视觉变化。默认情况下,按下时会以灰色椭圆高亮文本。
| 类型 | 默认值 |
|---|---|
| boolean | false |
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 行的测量数据。
示例
{
capHeight: 10.496,
ascender: 14.624,
descender: 4,
width: 28.224,
height: 18.624,
xHeight: 6.048,
x: 0,
y: 0
}
属性
| 名称 | 类型 | 可选 | 描述 |
|---|---|---|---|
| ascender | number | 否 | 文本布局变化后,该行的上升部分高度。 |
| capHeight | number | 否 | 基线以上的大写字母高度。 |
| descender | number | 否 | 文本布局变化后,该行的下降部分高度。 |
| height | number | 否 | 文本布局变化后该行的高度。 |
| width | number | 否 | 文本布局变化后该行的宽度。 |
| x | number | 否 | Text 组件内部该行的 X 坐标。 |
| xHeight | number | 否 | 基线与该行中线(主体尺寸)之间的距离。 |
| y | number | 否 | Text 组件内部该行的 Y 坐标。 |
TextLayoutEvent
TextLayoutEvent 对象会在回调中作为组件布局变化的结果返回。它包含一个名为 lines 的键,其值是一个数组,数组中包含与每一条渲染文本行对应的 TextLayout 对象。
示例
{
lines: [
TextLayout,
TextLayout,
// ...
];
target: 1127;
}
属性
| 名称 | 类型 | 可选 | 描述 |
|---|---|---|---|
| lines | TextLayout 数组 | 否 | 提供每一条渲染行的 TextLayout 数据。 |
| target | number | 否 | 元素的节点 id。 |