Text
一个用于显示文本的 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 container: the text will be inline, if the space allows it
// |First part and second part|
// otherwise, the text will flow as if it was one
// |First part |
// |and second |
// |part |
<View>
<Text>First part and </Text>
<Text>second part</Text>
</View>
// View container: each text is its own block
// |First part and|
// |second part |
// otherwise, the text will flow in its own block
// |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>
Text styled with the default font for the entire application
</MyAppText>
<MyAppHeaderText>Text styled as a header</MyAppHeaderText>
</View>
假设 MyAppText 是一个仅将其子级渲染到带有样式的 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
无障碍提示可帮助用户了解当他们在无障碍元素上执行操作时会发生什么,如果该结果无法从无障碍标签中清楚得知。
| 类型 |
|---|
| 字符串 |
无障碍语言 iOS
指示屏幕阅读器在用户与元素交互时应使用的语言值。它应遵循 BCP 47 规范。
有关更多信息,请参阅 iOS accessibilityLanguage 文档。
| 类型 |
|---|
| 字符串 |
accessibilityLabel
当用户与元素交互时,覆盖屏幕阅读器读取的文本。默认情况下,标签是通过遍历所有子元素并累积所有由空格分隔的 Text 节点来构建的。
| 类型 |
|---|
| 字符串 |
accessibilityRole
告诉屏幕阅读器将当前聚焦的元素视为具有特定角色。
在 iOS 上,这些角色映射到相应的辅助功能特性。图像按钮的功能与将特性设置为“图像”和“按钮”相同。有关更多信息,请参阅辅助功能指南。
在 Android 上,这些角色在 TalkBack 上具有与在 iOS 中添加辅助功能特性对 Voiceover 类似的功能。
accessibilityState
告诉屏幕阅读器将当前聚焦的元素视为处于特定状态。
你可以提供一个状态、无状态或多个状态。状态必须通过对象传入,例如 {selected: true, disabled: true}。
accessibilityActions
辅助功能操作允许辅助技术以编程方式调用组件的操作。accessibilityActions 属性应包含操作对象的列表。每个操作对象应包含字段名和标签。
有关更多信息,请参阅辅助功能指南。
| 类型 | 必需 |
|---|---|
| 数组 | 否 |
onAccessibilityAction
当用户执行辅助功能操作时调用。此函数唯一的参数是一个事件,其中包含要执行的操作的名称。
有关更多信息,请参阅辅助功能指南。
| 类型 | 必需 |
|---|---|
| 函数 | 否 |
accessible
设置为 true 时,表示该视图是辅助功能元素。
有关更多信息,请参阅辅助功能指南。
| 类型 | 默认 |
|---|---|
| 布尔值 | true |
adjustsFontSizeToFit
指定字体是否应自动缩放以适应给定的样式约束。
| 类型 | 默认 |
|---|---|
| 布尔值 | false |
allowFontScaling
指定字体是否应根据文本大小辅助功能设置进行缩放。
| 类型 | 默认 |
|---|---|
| 布尔值 | true |
android_hyphenationFrequency Android
在 Android API 级别 23+ 上,设置确定单词断裂时使用的自动连字符的频率。
| 类型 | 默认 |
|---|---|
枚举值('none', 'normal','full') | 'none' |
aria-busy
表示元素正在被修改,辅助技术可能需要等待更改完成才能将更新通知用户。
| 类型 | 默认 |
|---|---|
| 布尔值 | false |
aria-checked
指示可检查元素的状态。此字段可以接受布尔值或“mixed”字符串来表示混合复选框。
| 类型 | 默认 |
|---|---|
| 布尔值,'mixed' | false |
aria-disabled
表示元素可感知但已禁用,因此不可编辑或以其他方式操作。
| 类型 | 默认 |
|---|---|
| 布尔值 | false |
aria-expanded
指示可展开元素当前是展开还是折叠。
| 类型 | 默认 |
|---|---|
| 布尔值 | false |
aria-label
定义一个标记交互元素的字符串值。
| 类型 |
|---|
| 字符串 |
aria-selected
指示可选元素当前是否已选中。
| 类型 |
|---|
| 布尔值 |
dataDetectorType Android
确定文本元素中转换为可点击 URL 的数据类型。默认情况下,不检测任何数据类型。
你只能提供一种类型。
| 类型 | 默认 |
|---|---|
枚举值('phoneNumber', 'link', 'email', 'none', 'all') | 'none' |
disabled Android
指定文本视图的禁用状态,用于测试目的。
| 类型 | 默认 |
|---|---|
| 布尔值 | false |
dynamicTypeRamp iOS
应用于此 iOS 元素的动态类型坡度。
| 类型 | 默认 |
|---|---|
枚举值('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 值才能正常工作。
| 类型 | 默认 |
|---|---|
枚举值('head', 'middle', 'tail', 'clip') | tail |
id
用于从原生代码定位此视图。优先于 nativeID 属性。
| 类型 |
|---|
| 字符串 |
maxFontSizeMultiplier
当 allowFontScaling 启用时,指定字体可以达到的最大比例。可能的值:
null/undefined:从父节点或全局默认值 (0) 继承0:无最大值,忽略父级/全局默认值>= 1:将此节点的maxFontSizeMultiplier设置为此值
| 类型 | 默认 |
|---|---|
| 数字 | undefined |
minimumFontScale
当 adjustsFontSizeToFit 启用时,指定字体可以达到的最小比例(值 0.01-1.0)。
| 类型 |
|---|
| 数字 |
nativeID
用于从原生代码定位此视图。
| 类型 |
|---|
| 字符串 |
numberOfLines
用于在计算文本布局(包括换行)后,用省略号截断文本,使总行数不超过此数字。将此属性设置为 0 将导致取消设置此值,这意味着将不应用任何行限制。
此属性通常与 ellipsizeMode 一起使用。
| 类型 | 默认 |
|---|---|
| 数字 | 0 |
onLayout
在挂载和布局更改时调用。
| 类型 |
|---|
({nativeEvent: LayoutEvent}) => void |
onLongPress
此函数在长按时调用。
| 类型 |
|---|
({nativeEvent: PressEvent}) => void |
onMoveShouldSetResponder
此视图是否希望“声明”触摸响应?当视图不是响应器时,会在每次触摸移动时为此 View 调用此函数。
| 类型 |
|---|
({nativeEvent: PressEvent}) => boolean |
onPress
用户按下时调用的函数,在 onPressOut 之后触发。
| 类型 |
|---|
({nativeEvent: PressEvent}) => void |
onPressIn
触摸开始时立即调用,在 onPressOut 和 onPress 之前。
| 类型 |
|---|
({nativeEvent: PressEvent}) => void |
onPressOut
触摸释放时调用。
| 类型 |
|---|
({nativeEvent: PressEvent}) => void |
onResponderGrant
视图现在正在响应触摸事件。这是突出显示并向用户显示正在发生的事情的时候。
在 Android 上,从此回调返回 true 可以防止任何其他原生组件成为响应器,直到此响应器终止。
| 类型 |
|---|
({nativeEvent: PressEvent}) => void | boolean |
onResponderMove
用户正在移动他们的手指。
| 类型 |
|---|
({nativeEvent: PressEvent}) => void |
onResponderRelease
在触摸结束时触发。
| 类型 |
|---|
({nativeEvent: PressEvent}) => void |
onResponderTerminate
响应器已从 View 中移除。可能在调用 onResponderTerminationRequest 后被其他视图移除,或者可能在未经请求的情况下被操作系统移除(例如,iOS 上的控制中心/通知中心发生的情况)。
| 类型 |
|---|
({nativeEvent: PressEvent}) => void |
onResponderTerminationRequest
其他 View 想要成为响应器,并请求此 View 释放其响应器。返回 true 允许其释放。
| 类型 |
|---|
({nativeEvent: PressEvent}) => boolean |
onStartShouldSetResponderCapture
如果父 View 希望阻止子 View 在触摸开始时成为响应器,它应该有一个返回 true 的处理程序。
| 类型 |
|---|
({nativeEvent: PressEvent}) => boolean |
onTextLayout
在文本布局更改时调用。
| 类型 |
|---|
(TextLayoutEvent) => mixed |
pressRetentionOffset
当滚动视图禁用时,这定义了你的触摸可以离开按钮多远,然后才停用按钮。一旦停用,尝试将其移回,你会发现按钮再次被激活!在滚动视图禁用时,来回移动它几次。确保传入一个常量以减少内存分配。
| 类型 |
|---|
| Rect, number |
ref
一个 ref 设置器,在挂载时将被分配一个元素节点。
请注意,Text 组件不提供文本节点,就像 Web 上的段落元素(<p>)是元素节点而不是文本节点一样。文本节点可以作为它们的子节点找到。
role
role 向辅助技术用户传达组件的用途。优先于 accessibilityRole 属性。
| 类型 |
|---|
| Role |
selectable
允许用户选择文本,以使用原生复制粘贴功能。
| 类型 | 默认 |
|---|---|
| 布尔值 | false |
selectionColor Android
文本的高亮颜色。
| 类型 |
|---|
| 颜色 |
style
suppressHighlighting iOS
当 true 时,按下文本时不会有视觉变化。默认情况下,按下文本时会有一个灰色椭圆形高亮显示文本。
| 类型 | 默认 |
|---|---|
| 布尔值 | false |
testID
用于在端到端测试中定位此视图。
| 类型 |
|---|
| 字符串 |
textBreakStrategy Android
在 Android API 级别 23+ 上设置文本断行策略,可能的值为 simple、highQuality、balanced。
| 类型 | 默认 |
|---|---|
枚举值('simple', 'highQuality', 'balanced') | highQuality |
lineBreakStrategyIOS iOS
在 iOS 14+ 上设置换行策略。可能的值为 none、standard、hangul-word 和 push-out。
| 类型 | 默认 |
|---|---|
枚举值('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 | 数字 | 否 | 文本布局更改后的行上升高度。 |
| capHeight | 数字 | 否 | 基线上大写字母的高度。 |
| descender | 数字 | 否 | 文本布局更改后的行下降高度。 |
| height | 数字 | 否 | 文本布局更改后的行高。 |
| width | 数字 | 否 | 文本布局更改后的行宽。 |
| x | 数字 | 否 | 文本组件内的行 X 坐标。 |
| xHeight | 数字 | 否 | 基线和行中线之间的距离(字高)。 |
| y | 数字 | 否 | 文本组件内的行 Y 坐标。 |
TextLayoutEvent
TextLayoutEvent 对象作为组件布局更改的结果在回调中返回。它包含一个名为 lines 的键,其值是一个数组,包含与每个渲染文本行对应的 TextLayout 对象。
示例
{
lines: [
TextLayout,
TextLayout,
// ...
];
target: 1127;
}
属性
| 姓名 | 类型 | 可选 | 描述 |
|---|---|---|---|
| lines | TextLayout 数组 | 否 | 提供每个渲染行的 TextLayout 数据。 |
| 目标 | 数字 | 否 | 元素的节点 ID。 |