Skip to content

Commit

Permalink
docs(homepage): change scroll related event supported version
Browse files Browse the repository at this point in the history
  • Loading branch information
@zoomchan-cxj
zoomchan-cxj committed Aug 26, 2022
1 parent 96c670a commit 2a75faf
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
20 changes: 10 additions & 10 deletions docs/en-us/hippy-vue/components.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,11 @@ This component is mapped to the View component, and the container can be used to
| focus | Called when `focusable` is set to true, and the active component can be moved by remote arrow keys. The event callback takes the `isFocused` parameter to mark the active and inactive states | `Function` | `Android` |
| longClick | Called when the button is long pressed. For example, `@longClick="longClickHandler"}` | `Function` | `Android、iOS、Web-Renderer` |
| layout | Called when an element is mounted or the layout changes. The argument is: `nativeEvent: { layout: { x, y, width, height } }`, where `x` and `y` are coordinates relative to the parent element | `Function` | `Android、iOS、Web-Renderer` |
| momentumScrollBegin | Called when the ScrollView slider starts. `(only applicable to overflow-y/x: scroll)`, after `2.15.0` version `offset` parameters supported | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollEnd | Called when the ScrollView slider ends. `(only applicable to overflow-y/x: scroll)`, after `2.15.0` version `offset` parameters supported | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scroll | Called at most once per frame during scrolling. `(only applicable to overflow-y/x: scroll)`| `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollBeginDrag | Called when the user starts dragging the ScrollView. `(only applicable to overflow-y/x: scroll)`| `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollEndDrag | Called when the user stops dragging and dropping ScrollView. `(only applicable to overflow-y/x: scroll)` | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollBegin | Called when the ScrollView slider starts. `(only applicable to overflow-y/x: scroll)`, after `2.14.6` version `offset` parameters supported | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollEnd | Called when the ScrollView slider ends. `(only applicable to overflow-y/x: scroll)`, after `2.14.6` version `offset` parameters supported | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scroll | Called at most once per frame during scrolling. `(only applicable to overflow-y/x: scroll)`| `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollBeginDrag | Called when the user starts dragging the ScrollView. `(only applicable to overflow-y/x: scroll)`| `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollEndDrag | Called when the user stops dragging and dropping ScrollView. `(only applicable to overflow-y/x: scroll)` | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| touchstart | Called when screen touch starts, minimum supported version 2.6.2, the parameters are `evt: { touches: [{ clientX: number, clientY: number }] }`,`clientX` and `clientY` respectively represent the absolute position of the click within the screen. | `Function` | `Android、iOS、Web-Renderer` |
| touchmove | Called when screen touch moves, minimum supported version 2.6.2, the parameters are `evt: { touches: [{ clientX: number, clientY: number }] }`,`clientX` and `clientY` respectively represent the absolute position of the click within the screen. | `Function` | `Android、iOS、Web-Renderer` |
| touchend | Called when screen touch ends, minimum supported version 2.6.2, the parameters are `evt: { touches: [{ clientX: number, clientY: number }] }`,`clientX` and `clientY` respectively represent the absolute position of the click within the screen. | `Function` | `Android、iOS、Web-Renderer` |
Expand Down Expand Up @@ -361,11 +361,11 @@ Hippy's key features, high performance reusable list components, on the native s
| Event Name | Description | Type | Supported Platforms |
| ------------- | ------------------------------------------------------------ | ----------------------------------------- | -------- |
| endReached | When all the data has been rendered and the list is scrolled to the last one, the `endReached` callback is called. | `Function` | `Android、iOS、Web-Renderer` |
| momentumScrollBegin | Called when the `ListView` began to slide, after `2.15.0` version `offset` parameters supported | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollEnd | Called when the `ListView` end to slide, after `2.15.0` version `offset` parameters supported | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scroll | Called when the sliding event of `ListView` is triggered. Because this function is called when `ListView` is sliding, the call will be very frequent, please use `scrollEventThrottle` frequency control. Note: ListView will recycle components when scrolling. Do not perform any ref node-level operations (such as all callUIFunctions and measureInAppWindow methods) on the ListItemView generated by renderRow() when scrolling. The recycled nodes will no longer be able to perform operations and report an error. Android supports horizontal ListView after version `2.8.0` | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollBeginDrag | Called when the user starts dragging `ListView`, after `2.15.0` version `offset` parameters supported | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollEndDrag | Called when the user stops dragging and dropping `ListView` or let `ListView` started sliding, after `2.15.0` version `offset` parameters supported | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollBegin | Called when the `ListView` began to slide, after `2.14.6` version `offset` parameters supported | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollEnd | Called when the `ListView` end to slide, after `2.14.6` version `offset` parameters supported | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scroll | Called when the sliding event of `ListView` is triggered. Because this function is called when `ListView` is sliding, the call will be very frequent, please use `scrollEventThrottle` frequency control. Note: ListView will recycle components when scrolling. Do not perform any ref node-level operations (such as all callUIFunctions and measureInAppWindow methods) on the ListItemView generated by renderRow() when scrolling. The recycled nodes will no longer be able to perform operations and report an error. Android supports horizontal ListView after version `2.8.0` | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollBeginDrag | Called when the user starts dragging `ListView`, after `2.14.6` version `offset` parameters supported | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollEndDrag | Called when the user stops dragging and dropping `ListView` or let `ListView` started sliding, after `2.14.6` version `offset` parameters supported | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| layout | Called when an element is mounted or the layout is changed. The parameters are: `nativeEvent: {layout: {x, y, width, height}}` where `x` and `y` are the coordinate positions relative to the parent element. | `Function` | `Android、iOS、Web-Renderer` |
| delete | Called when a list item is sideslip and deleted. `minimum support version 2.9.0` | `(nativeEvent: { index: number}) => void` | `iOS` |

Expand Down
20 changes: 10 additions & 10 deletions docs/hippy-vue/components.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,11 @@
| focus | 该事件在 `focusable` 置为 true 时触发，通过遥控方向键可以移动活动组件位置，事件回调带有 `isFocused` 参数用于标记激活和非激活状态 | `Function` | `Android` |
| longClick | 当按钮被长按以后调用此回调函数。 例如， `@longClick="longClickHandler"}` | `Function` | `Android、iOS、Web-Renderer` |
| layout | 当元素挂载或者布局改变的时候调用，参数为： `nativeEvent: { layout: { x, y, width, height } }`，其中 `x` 和 `y` 为相对父元素的坐标位置 | `Function` | `Android、iOS、Web-Renderer` |
| momentumScrollBegin | 在 ScrollView 滑动开始的时候调起。`（仅在 overflow-y/x: scroll 时适用）`, `2.15.0` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollEnd | 在 ScrollView 滑动结束的时候调起。`（仅在 overflow-y/x: scroll 时适用）`，`2.15.0` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scroll | 在滚动的过程中，每帧最多调用一次此回调函数。`（仅在 overflow-y/x: scroll 时适用）` | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollBeginDrag | 当用户开始拖拽 ScrollView 时调用。`（仅在 overflow-y/x: scroll 时适用）` | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollEndDrag | 当用户停止拖拽 ScrollView 时调用。`（仅在 overflow-y/x: scroll 时适用）` | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollBegin | 在 ScrollView 滑动开始的时候调起。`（仅在 overflow-y/x: scroll 时适用）`, `2.14.6` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollEnd | 在 ScrollView 滑动结束的时候调起。`（仅在 overflow-y/x: scroll 时适用）`，`2.14.6` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scroll | 在滚动的过程中，每帧最多调用一次此回调函数。`（仅在 overflow-y/x: scroll 时适用）` | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollBeginDrag | 当用户开始拖拽 ScrollView 时调用。`（仅在 overflow-y/x: scroll 时适用）` | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollEndDrag | 当用户停止拖拽 ScrollView 时调用。`（仅在 overflow-y/x: scroll 时适用）` | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| touchstart | 触屏开始事件，参数为 `evt: { touches: [{ clientX: number, clientY: number }] }`，`clientX` 和 `clientY` 分别表示点击在屏幕内的绝对位置 | `Function` | `Android、iOS、Web-Renderer` |
| touchmove | 触屏移动事件，参数为 `evt: { touches: [{ clientX: number, clientY: number }] }`，`clientX` 和 `clientY` 分别表示点击在屏幕内的绝对位置 | `Function` | `Android、iOS、Web-Renderer` |
| touchend | 触屏结束事件，参数为 `evt: { touches: [{ clientX: number, clientY: number }] }`，`clientX` 和 `clientY` 分别表示点击在屏幕内的绝对位置 | `Function` | `Android、iOS、Web-Renderer` |
Expand Down Expand Up @@ -361,11 +361,11 @@ Hippy 的重点功能，高性能的可复用列表组件，在终端侧会被
| 事件名称 | 描述 | 类型 | 支持平台 |
| ------------- | ------------------------------------------------------------ | ----------------------------------------- | -------- |
| endReached | 当所有的数据都已经渲染过，并且列表被滚动到最后一条时，将触发 `onEndReached` 回调。 | `Function` | `Android、iOS、Web-Renderer` |
| momentumScrollBegin | 在 `ListView` 开始滑动的时候调起，`2.15.0` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollEnd | 在 `ListView` 结束滑动的时候调起，`2.15.0` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scroll | 当触发 `ListView` 的滑动事件时回调。由于在 `ListView` 滑动时回调，调用会非常频繁，请使用 `scrollEventThrottle` 进行频率控制。 注意：ListView 在滚动时会进行组件回收，不要在滚动时对 renderRow() 生成的 ListItemView 做任何 ref 节点级的操作（例如：所有 callUIFunction 和 measureInAppWindow 方法），回收后的节点将无法再进行操作而报错。横向ListView时，Android在 `2.8.0` 版本后支持 | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollBeginDrag | 当用户开始拖拽 `ListView` 时调用，`2.15.0` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollEndDrag | 当用户停止拖拽 `ListView` 或者放手让 `ListView` 开始滑动的时候调用，`2.15.0` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetX: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollBegin | 在 `ListView` 开始滑动的时候调起，`2.14.6` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| momentumScrollEnd | 在 `ListView` 结束滑动的时候调起，`2.14.6` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scroll | 当触发 `ListView` 的滑动事件时回调。由于在 `ListView` 滑动时回调，调用会非常频繁，请使用 `scrollEventThrottle` 进行频率控制。 注意：ListView 在滚动时会进行组件回收，不要在滚动时对 renderRow() 生成的 ListItemView 做任何 ref 节点级的操作（例如：所有 callUIFunction 和 measureInAppWindow 方法），回收后的节点将无法再进行操作而报错。横向ListView时，Android在 `2.8.0` 版本后支持 | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollBeginDrag | 当用户开始拖拽 `ListView` 时调用，`2.14.6` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| scrollEndDrag | 当用户停止拖拽 `ListView` 或者放手让 `ListView` 开始滑动的时候调用，`2.14.6` 版本后支持 `offset` 相关参数 | `(event: { offsetX: number, offsetY: number }) => any` | `Android、iOS、Web-Renderer` |
| layout | 当元素挂载或者布局改变的时候调用，参数为： `nativeEvent: { layout: { x, y, width, height } }`，其中 `x` 和 `y` 为相对父元素的坐标位置。 | `Function` | `Android、iOS、Web-Renderer` |
| delete | 在列表项侧滑删除时调起。`最低支持版本2.9.0` | `(nativeEvent: { index: number}) => void` | `iOS` |

Expand Down

0 comments on commit 2a75faf

Please sign in to comment.