diff --git a/en/NativeBase.md b/en/NativeBase.md index 663a9e35dd6b92b524a96a9ba115b93f9803b14e..d5629e7e8e7eb2a3e62a775f961ed7fa8b0794f3 100644 --- a/en/NativeBase.md +++ b/en/NativeBase.md @@ -203,7 +203,7 @@ const styles = StyleSheet.create({ | startIcon | 开始图标元素 | React.element | No | All | Yes | | endIcon | 结束图标元素 | React.element | No | All | Yes | | isLoadingText | 正在加载文本 | String | No | All | Yes | -| spinner | 是否加载中 | Boolean | No | All | Yes | +| spinner | 加载中传入的元素 | JSX.Element | No | All | Yes | | isDisabled | 是否禁用 | Boolean | No | All | Yes | | _text_ | 用于为框内的文本提供参数 | Object | No | All | Yes | | _stack | 要传递给按钮内部使用的 HStack 的参数 | Object | No | All | Yes | @@ -229,7 +229,7 @@ const styles = StyleSheet.create({ | onFocus | 聚焦时调用 | () => void | No | All | Yes | | onBlur | 失焦时调用 | () => void | No | All | Yes | | _hover | 悬停参数 | Object | No | Web | No | -| _pressed | 按下禁用时参数 | Object | No | All | Yes | +| _pressed | 按下时参数 | Object | No | All | Yes | | _focus | 获得焦点时参数 | Object | No | All | Yes | | _disabled | 禁用时参数 | Object | No | All | Yes | | isDisabled | 是否禁用 | Boolean | No | All | Yes | @@ -274,7 +274,7 @@ const styles = StyleSheet.create({ | :------------------: | :----------------------------------------------------------: | :-------------------: | :------: | :------: | :---------------: | | colorScheme | 主题，可选primary，green，red | String | No | All | Yes | | variant | 风格，可选link，unstyled，solid，ghost，subtle | String | No | All | Yes | -| size | 按钮大小，可选sm（小尺寸）、md（中等尺寸）、lg（大尺寸） | String | No | All | Yes | +| size | 按钮大小，可选xs（微小尺寸）、sm（小尺寸）、md（中等尺寸）、lg（大尺寸） | String | No | All | Yes | | isDisabled | 是否禁用 | Boolean | No | All | Yes | | icon | 要使用的图标 | React.element | No | All | Yes | | _icon | 要传递给IconButton内部使用的图标的参数 | Object | No | All | Yes | @@ -299,7 +299,7 @@ const styles = StyleSheet.create({ | rightElement | 输入框外部右侧元素 | React.element | No | All | Yes | | type | 类型，可选text，password | String | No | All | Yes | | isFullWidth | 沾满元素 | Boolean | No | All | Yes | -| wrapperRef | 获取节点(鸿蒙中获取不到，用ref可以获取) | Any | No | No | No | +| wrapperRef | 获取节点 | Any | No | All | Yes | | _hover | 要传递给Input内部使用的悬停的参数 | Object | No | Web | NO | | _focus | 要传递给Input内部使用的聚焦的参数 | Object | No | All | Yes | | _disabled | 要传递给Input内部使用的禁用的参数 | Object | No | All | Yes | @@ -307,8 +307,8 @@ const styles = StyleSheet.create({ | _invalid | 无效状态下传递参数 | Object | No | All | Yes | | _input | 传递给InputBase组件参数 | Object | No | All | Yes | | _stack | 要传递给按钮内部使用的 HStack 的参数 | Object | No | All | Yes | -| focusOutlineColor | 当输入框获得焦点时，该属性指定输入框的轮廓颜色 | Boolean | No | All | Yes | -| invalidOutlineColor | 当输入框中的内容被认为是无效时，该属性指定输入框的轮廓颜色 | Boolean | No | All | Yes | +| focusOutlineColor | 当输入框获得焦点时，该属性指定输入框的轮廓颜色 | String | No | All | Yes | +| invalidOutlineColor | 当输入框中的内容被认为是无效时，该属性指定输入框的轮廓颜色 | String | No | All | Yes | | ref | 节点 | Any | No | All | Yes | **TextArea**: 文本域 @@ -328,7 +328,7 @@ const styles = StyleSheet.create({ | rightElement | 输入框外部右侧元素 | React.element | No | All | Yes | | type | 类型，可选text，password | String | No | All | Yes | | isFullWidth | 沾满元素 | Boolean | No | All | Yes | -| wrapperRef | 获取节点(鸿蒙中获取不到，用ref可以获取) | Any | No | No | No | +| wrapperRef | 获取节点 | Any | No | All | Yes | | _hover | 要传递给Input内部使用的悬停的参数 | Object | No | Web | NO | | _focus | 要传递给Input内部使用的聚焦的参数 | Object | No | All | Yes | | _disabled | 要传递给Input内部使用的禁用的参数 | Object | No | All | Yes | @@ -338,7 +338,7 @@ const styles = StyleSheet.create({ | _stack | 要传递给按钮内部使用的 HStack 的参数 | Object | No | All | Yes | | focusOutlineColor | 当输入框获得焦点时，该属性指定输入框的轮廓颜色 | Boolean | No | All | Yes | | invalidOutlineColor | 当输入框中的内容被认为是无效时，该属性指定输入框的轮廓颜色 | Boolean | No | All | Yes | -| ref | 节点 | Any | No | All | Yes | +| placeholder | 提示文本 | String | No | All | Yes | **Link**: 超链接 | Name | Description | Type | Required | Platform | HarmonyOS Support | @@ -350,7 +350,7 @@ const styles = StyleSheet.create({ | onPress | 按压事件 | () => void | No | All | Yes | | isExternal | 是否直接打开web端 | String | No | All | Yes | | _hover | 悬停参数 | Object | No | Web | No | -| wrapperRef | 获取节点(鸿蒙中获取不到，用ref可以获取) | Any | No | No | No | +| wrapperRef | 获取节点 | Any | No | All | Yes | **Radio**: 单选框 | Name | Description | Type | Required | Platform | HarmonyOS Support | @@ -364,7 +364,7 @@ const styles = StyleSheet.create({ | isFocusVisible | 焦点是否可见 | Boolean | No | All | Yes | | size | 单选框尺寸lg，md，sm | String | No | All | Yes | | icon | 接收图标 | React.element | No | All | Yes | -| wrapperRef | 获取节点(鸿蒙中获取不到，用ref可以获取) | Any | No | No | No | +| wrapperRef | 获取节点 | Any | No | All | Yes | | _stack | 要传递给单选框内部使用的 HStack 的参数 | Object | No | All | Yes | | _disabled | 当禁用时传递给单选框的参数 | Object | No | All | Yes | | _checked | 当选中时传递给单选框的参数 | Object | No | All | Yes | @@ -383,8 +383,8 @@ const styles = StyleSheet.create({ | placeholder | 提示文本 | String | No | All | Yes | | color | 选中颜色 | String | No | All | Yes | | placeholderTextColor | 提示文本颜色 | String | No | All | Yes | -| _item | 是否悬停 | Boolean | No | No | No | -| _selectedItem | 是否按压 | Boolean | No | All | Yes | +| _item | 每个选项的参数 | Object | No | All | Yes | +| _selectedItem | 选中选项的参数 | Object | No | All | Yes | | selectedValue | 选中值 | Boolean | No | All | Yes | | defaultValue | 初始值 | Boolean | No | All | Yes | | onValueChange | 单选事件 | () => void | No | All | Yes | @@ -536,7 +536,7 @@ const styles = StyleSheet.create({ | _description | 描述样式参数 | () => void | No | All | Yes | | accessibilityAnnouncement | Toast 打开时屏幕阅读器播报的文本 | String | No | Android | No | | accessibilityLiveRegion | Toast 打开时屏幕阅读器播报的文本位置 | String | No | Android | No | -| avoidKeyboard | 键盘打开，则 Toast 将向上移动相当于键盘高度 | Boolean | No | All | Yes | +| avoidKeyboard | 键盘打开，则 Toast 将向上移动相当于键盘高度 | Boolean | No | All | No | **Text**: 文本 | Name | Description | Type | Required | Platform | HarmonyOS Support | @@ -618,6 +618,7 @@ const styles = StyleSheet.create({ | _overlay | 背景覆盖层参数 | Object | No | All | Yes | | useRNModal | 是否使用 React Native 的原生Modal组件来实现模态框 | Boolean | No | All | Yes | | _backdropFade | 背景遮罩参数 | Boolean | No | All | Yes | +| closeOnOverlayClick | 点击关闭 | () => void | No | All | Yes | **Popover**: 局部弹框 | Name | Description | Type | Required | Platform | HarmonyOS Support | @@ -625,21 +626,19 @@ const styles = StyleSheet.create({ | isOpen | 是否打开 | Boolean | No | All | Yes | | onClose | 关闭事件 | () => void | No | All | Yes | | onOpen | 打开事件 | () => void | No | All | Yes | +| placement | 位置 | String | No | All | Yes | | defaultIsOpen | 默认打开 | Boolean | No | All | Yes | -| size | 尺寸 | String | No | All | Yes | | initialFocusRef | 模态框打开时最初获得焦点的元素节点 | Any | No | All | Yes | | finalFocusRef | 模态框关闭时最终获得焦点的元素节点 | Any | No | All | Yes | -| avoidKeyboard | 键盘打开，则 Modal 将向上移动相当于键盘高度 | Boolean | No | All | Yes | | isKeyboardDismissable | 控制是否可以通过触摸屏幕外部或按下系统返回键来关闭键盘和模态框 | Boolean | No | All | Yes | -| overlayVisible | 控制模态框的背景覆盖层（overlay）是否可见 | Boolean | No | All | Yes | -| backdropVisible | 控制模态框的背景遮罩是否可见 | Boolean | No | All | Yes | -| animationPreset | 动画效果 | String | No | All | Yes | -| _fade | 动画参数 | Object | No | All | Yes | -| _slide | 幻灯片动画参数 | Object | No | All | Yes | -| _overlay | 背景覆盖层参数 | Object | No | All | Yes | | useRNModal | 是否使用 React Native 的原生Modal组件来实现局部弹框 | Boolean | No | All | Yes | | trigger | 手动触发显示的元素 | () => void | No | All | Yes | +| trapFocus | 是否应该捕获焦点 | Boolean | No | All | Yes | +| crossOffset | x轴偏移量 | Number | No | All | Yes | +| offset | y轴偏移量 | Number | No | All | Yes | | shouldOverlapWithTrigger | 控制菜单是否与触发元素重叠显示。 | boolean | No | All | Yes | +| children | 子元素 | JSX.Element | No | All | Yes | +| shouldFlip | 元素渲染位置不够是否反转 | Boolean | No | All | Yes | **Avatar**: 显示用户头像或图像 | Name | Description | Type | Required | Platform | HarmonyOS Support | @@ -757,6 +756,7 @@ const styles = StyleSheet.create({ | useMediaQuery | 检测单个媒体查询或多个媒体查询之间的匹配。React Native本身不支持媒体查询，因此useMediaQuery仍然有限 | NO | All | YES | | useToken | 解析主题中的设计标记. | NO | All | YES | | useColorMode |设置或检索颜色模式 | NO | All | YES | +| useTheme |从上下文调用主题对象 | NO | All | YES | | useColorModeValue | 基于活动颜色模式值传递的参数中检索值 | NO | All | YES | | useContrastText | 提供与作为参数传递的背景颜色的颜色对比文本颜色（lightText或darkText） | NO | All | YES | | useAccessibleColors | 更新您的颜色配置，以在应用程序中获得更好的颜色和对比度可访问性。默认情况下，可访问的颜色是关闭的如果您想继续使用可访问的文本颜色，可以使用此挂钩。您还可以使用extendTheme在NativeBaseProvider的配置中传递它 | NO | All | YES | diff --git a/zh-cn/NativeBase.md b/zh-cn/NativeBase.md index 663a9e35dd6b92b524a96a9ba115b93f9803b14e..d5629e7e8e7eb2a3e62a775f961ed7fa8b0794f3 100644 --- a/zh-cn/NativeBase.md +++ b/zh-cn/NativeBase.md @@ -203,7 +203,7 @@ const styles = StyleSheet.create({ | startIcon | 开始图标元素 | React.element | No | All | Yes | | endIcon | 结束图标元素 | React.element | No | All | Yes | | isLoadingText | 正在加载文本 | String | No | All | Yes | -| spinner | 是否加载中 | Boolean | No | All | Yes | +| spinner | 加载中传入的元素 | JSX.Element | No | All | Yes | | isDisabled | 是否禁用 | Boolean | No | All | Yes | | _text_ | 用于为框内的文本提供参数 | Object | No | All | Yes | | _stack | 要传递给按钮内部使用的 HStack 的参数 | Object | No | All | Yes | @@ -229,7 +229,7 @@ const styles = StyleSheet.create({ | onFocus | 聚焦时调用 | () => void | No | All | Yes | | onBlur | 失焦时调用 | () => void | No | All | Yes | | _hover | 悬停参数 | Object | No | Web | No | -| _pressed | 按下禁用时参数 | Object | No | All | Yes | +| _pressed | 按下时参数 | Object | No | All | Yes | | _focus | 获得焦点时参数 | Object | No | All | Yes | | _disabled | 禁用时参数 | Object | No | All | Yes | | isDisabled | 是否禁用 | Boolean | No | All | Yes | @@ -274,7 +274,7 @@ const styles = StyleSheet.create({ | :------------------: | :----------------------------------------------------------: | :-------------------: | :------: | :------: | :---------------: | | colorScheme | 主题，可选primary，green，red | String | No | All | Yes | | variant | 风格，可选link，unstyled，solid，ghost，subtle | String | No | All | Yes | -| size | 按钮大小，可选sm（小尺寸）、md（中等尺寸）、lg（大尺寸） | String | No | All | Yes | +| size | 按钮大小，可选xs（微小尺寸）、sm（小尺寸）、md（中等尺寸）、lg（大尺寸） | String | No | All | Yes | | isDisabled | 是否禁用 | Boolean | No | All | Yes | | icon | 要使用的图标 | React.element | No | All | Yes | | _icon | 要传递给IconButton内部使用的图标的参数 | Object | No | All | Yes | @@ -299,7 +299,7 @@ const styles = StyleSheet.create({ | rightElement | 输入框外部右侧元素 | React.element | No | All | Yes | | type | 类型，可选text，password | String | No | All | Yes | | isFullWidth | 沾满元素 | Boolean | No | All | Yes | -| wrapperRef | 获取节点(鸿蒙中获取不到，用ref可以获取) | Any | No | No | No | +| wrapperRef | 获取节点 | Any | No | All | Yes | | _hover | 要传递给Input内部使用的悬停的参数 | Object | No | Web | NO | | _focus | 要传递给Input内部使用的聚焦的参数 | Object | No | All | Yes | | _disabled | 要传递给Input内部使用的禁用的参数 | Object | No | All | Yes | @@ -307,8 +307,8 @@ const styles = StyleSheet.create({ | _invalid | 无效状态下传递参数 | Object | No | All | Yes | | _input | 传递给InputBase组件参数 | Object | No | All | Yes | | _stack | 要传递给按钮内部使用的 HStack 的参数 | Object | No | All | Yes | -| focusOutlineColor | 当输入框获得焦点时，该属性指定输入框的轮廓颜色 | Boolean | No | All | Yes | -| invalidOutlineColor | 当输入框中的内容被认为是无效时，该属性指定输入框的轮廓颜色 | Boolean | No | All | Yes | +| focusOutlineColor | 当输入框获得焦点时，该属性指定输入框的轮廓颜色 | String | No | All | Yes | +| invalidOutlineColor | 当输入框中的内容被认为是无效时，该属性指定输入框的轮廓颜色 | String | No | All | Yes | | ref | 节点 | Any | No | All | Yes | **TextArea**: 文本域 @@ -328,7 +328,7 @@ const styles = StyleSheet.create({ | rightElement | 输入框外部右侧元素 | React.element | No | All | Yes | | type | 类型，可选text，password | String | No | All | Yes | | isFullWidth | 沾满元素 | Boolean | No | All | Yes | -| wrapperRef | 获取节点(鸿蒙中获取不到，用ref可以获取) | Any | No | No | No | +| wrapperRef | 获取节点 | Any | No | All | Yes | | _hover | 要传递给Input内部使用的悬停的参数 | Object | No | Web | NO | | _focus | 要传递给Input内部使用的聚焦的参数 | Object | No | All | Yes | | _disabled | 要传递给Input内部使用的禁用的参数 | Object | No | All | Yes | @@ -338,7 +338,7 @@ const styles = StyleSheet.create({ | _stack | 要传递给按钮内部使用的 HStack 的参数 | Object | No | All | Yes | | focusOutlineColor | 当输入框获得焦点时，该属性指定输入框的轮廓颜色 | Boolean | No | All | Yes | | invalidOutlineColor | 当输入框中的内容被认为是无效时，该属性指定输入框的轮廓颜色 | Boolean | No | All | Yes | -| ref | 节点 | Any | No | All | Yes | +| placeholder | 提示文本 | String | No | All | Yes | **Link**: 超链接 | Name | Description | Type | Required | Platform | HarmonyOS Support | @@ -350,7 +350,7 @@ const styles = StyleSheet.create({ | onPress | 按压事件 | () => void | No | All | Yes | | isExternal | 是否直接打开web端 | String | No | All | Yes | | _hover | 悬停参数 | Object | No | Web | No | -| wrapperRef | 获取节点(鸿蒙中获取不到，用ref可以获取) | Any | No | No | No | +| wrapperRef | 获取节点 | Any | No | All | Yes | **Radio**: 单选框 | Name | Description | Type | Required | Platform | HarmonyOS Support | @@ -364,7 +364,7 @@ const styles = StyleSheet.create({ | isFocusVisible | 焦点是否可见 | Boolean | No | All | Yes | | size | 单选框尺寸lg，md，sm | String | No | All | Yes | | icon | 接收图标 | React.element | No | All | Yes | -| wrapperRef | 获取节点(鸿蒙中获取不到，用ref可以获取) | Any | No | No | No | +| wrapperRef | 获取节点 | Any | No | All | Yes | | _stack | 要传递给单选框内部使用的 HStack 的参数 | Object | No | All | Yes | | _disabled | 当禁用时传递给单选框的参数 | Object | No | All | Yes | | _checked | 当选中时传递给单选框的参数 | Object | No | All | Yes | @@ -383,8 +383,8 @@ const styles = StyleSheet.create({ | placeholder | 提示文本 | String | No | All | Yes | | color | 选中颜色 | String | No | All | Yes | | placeholderTextColor | 提示文本颜色 | String | No | All | Yes | -| _item | 是否悬停 | Boolean | No | No | No | -| _selectedItem | 是否按压 | Boolean | No | All | Yes | +| _item | 每个选项的参数 | Object | No | All | Yes | +| _selectedItem | 选中选项的参数 | Object | No | All | Yes | | selectedValue | 选中值 | Boolean | No | All | Yes | | defaultValue | 初始值 | Boolean | No | All | Yes | | onValueChange | 单选事件 | () => void | No | All | Yes | @@ -536,7 +536,7 @@ const styles = StyleSheet.create({ | _description | 描述样式参数 | () => void | No | All | Yes | | accessibilityAnnouncement | Toast 打开时屏幕阅读器播报的文本 | String | No | Android | No | | accessibilityLiveRegion | Toast 打开时屏幕阅读器播报的文本位置 | String | No | Android | No | -| avoidKeyboard | 键盘打开，则 Toast 将向上移动相当于键盘高度 | Boolean | No | All | Yes | +| avoidKeyboard | 键盘打开，则 Toast 将向上移动相当于键盘高度 | Boolean | No | All | No | **Text**: 文本 | Name | Description | Type | Required | Platform | HarmonyOS Support | @@ -618,6 +618,7 @@ const styles = StyleSheet.create({ | _overlay | 背景覆盖层参数 | Object | No | All | Yes | | useRNModal | 是否使用 React Native 的原生Modal组件来实现模态框 | Boolean | No | All | Yes | | _backdropFade | 背景遮罩参数 | Boolean | No | All | Yes | +| closeOnOverlayClick | 点击关闭 | () => void | No | All | Yes | **Popover**: 局部弹框 | Name | Description | Type | Required | Platform | HarmonyOS Support | @@ -625,21 +626,19 @@ const styles = StyleSheet.create({ | isOpen | 是否打开 | Boolean | No | All | Yes | | onClose | 关闭事件 | () => void | No | All | Yes | | onOpen | 打开事件 | () => void | No | All | Yes | +| placement | 位置 | String | No | All | Yes | | defaultIsOpen | 默认打开 | Boolean | No | All | Yes | -| size | 尺寸 | String | No | All | Yes | | initialFocusRef | 模态框打开时最初获得焦点的元素节点 | Any | No | All | Yes | | finalFocusRef | 模态框关闭时最终获得焦点的元素节点 | Any | No | All | Yes | -| avoidKeyboard | 键盘打开，则 Modal 将向上移动相当于键盘高度 | Boolean | No | All | Yes | | isKeyboardDismissable | 控制是否可以通过触摸屏幕外部或按下系统返回键来关闭键盘和模态框 | Boolean | No | All | Yes | -| overlayVisible | 控制模态框的背景覆盖层（overlay）是否可见 | Boolean | No | All | Yes | -| backdropVisible | 控制模态框的背景遮罩是否可见 | Boolean | No | All | Yes | -| animationPreset | 动画效果 | String | No | All | Yes | -| _fade | 动画参数 | Object | No | All | Yes | -| _slide | 幻灯片动画参数 | Object | No | All | Yes | -| _overlay | 背景覆盖层参数 | Object | No | All | Yes | | useRNModal | 是否使用 React Native 的原生Modal组件来实现局部弹框 | Boolean | No | All | Yes | | trigger | 手动触发显示的元素 | () => void | No | All | Yes | +| trapFocus | 是否应该捕获焦点 | Boolean | No | All | Yes | +| crossOffset | x轴偏移量 | Number | No | All | Yes | +| offset | y轴偏移量 | Number | No | All | Yes | | shouldOverlapWithTrigger | 控制菜单是否与触发元素重叠显示。 | boolean | No | All | Yes | +| children | 子元素 | JSX.Element | No | All | Yes | +| shouldFlip | 元素渲染位置不够是否反转 | Boolean | No | All | Yes | **Avatar**: 显示用户头像或图像 | Name | Description | Type | Required | Platform | HarmonyOS Support | @@ -757,6 +756,7 @@ const styles = StyleSheet.create({ | useMediaQuery | 检测单个媒体查询或多个媒体查询之间的匹配。React Native本身不支持媒体查询，因此useMediaQuery仍然有限 | NO | All | YES | | useToken | 解析主题中的设计标记. | NO | All | YES | | useColorMode |设置或检索颜色模式 | NO | All | YES | +| useTheme |从上下文调用主题对象 | NO | All | YES | | useColorModeValue | 基于活动颜色模式值传递的参数中检索值 | NO | All | YES | | useContrastText | 提供与作为参数传递的背景颜色的颜色对比文本颜色（lightText或darkText） | NO | All | YES | | useAccessibleColors | 更新您的颜色配置，以在应用程序中获得更好的颜色和对比度可访问性。默认情况下，可访问的颜色是关闭的如果您想继续使用可访问的文本颜色，可以使用此挂钩。您还可以使用extendTheme在NativeBaseProvider的配置中传递它 | NO | All | YES |