# rax-scrollview
> ScrollView component for Rax.
Latest version **3.7.8** (published 2023-09-14) · BSD-3-Clause license · 0 weekly downloads
## Install
```sh
npm install rax-scrollview
pnpm add rax-scrollview
yarn add rax-scrollview
bun add rax-scrollview
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities.
Warnings: low downloads.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 3.7.8 |
| Published | 2023-09-14 |
| First published | 2017-03-01 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 179.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 90 |
| Maintainers | zeroling, wintercn, yacheng, solojiang, rax-publisher |
| Keywords | Rax, rax-component, react-component |
## Links
- npm: https://www.npmjs.com/package/rax-scrollview
- Repository: https://github.com/raxjs/rax-components
- Homepage: https://github.com/raxjs/rax-components#readme
- Issues: https://github.com/raxjs/rax-components/issues
- npm.io page: https://npm.io/package/rax-scrollview
## Dependencies (7)
- [rax-text](https://npm.io/package/rax-text.md) ^2.0.0
- [rax-view](https://npm.io/package/rax-view.md) ^2.0.0
- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [universal-env](https://npm.io/package/universal-env.md) ^3.0.0
- [@uni/system-info](https://npm.io/package/@uni/system-info.md) ^1.0.5
- [rax-refreshcontrol](https://npm.io/package/rax-refreshcontrol.md) ^1.0.0
- [rax-get-element-by-id](https://npm.io/package/rax-get-element-by-id.md) ^1.0.0
## Recent versions
- 3.7.8 (latest) — 2023-09-14
- 3.7.5-beta.1 (beta) — 2022-08-24
- 3.7.7 — 2022-10-13
- 3.7.6 — 2022-10-12
- 3.7.5 — 2022-09-29
- 3.7.4 — 2022-08-02
- 3.7.3 — 2022-07-25
- 3.7.2 — 2022-07-12
- 3.7.1-6 — 2021-12-24
- 3.7.1-5 — 2021-12-24
- 3.7.1-4 — 2021-12-24
- 3.7.1 — 2021-12-24
- 3.7.1-3 — 2021-12-23
- 3.7.1-2 — 2021-11-24
- 3.7.1-1 — 2021-09-18
- … 132 more at https://npm.io/package/rax-scrollview/versions
## README
# rax-scrollview
[](https://www.npmjs.com/package/rax-scrollview)
## 支持
Web / Weex / 阿里小程序 / 微信小程序 / 字节跳动小程序
## 描述
ScrollView 是一个包装了滚动操作的组件。一般情况下需要一个确定的高度来保证 ScrollView 的正常展现。
## 安装
```bash
$ npm install rax-scrollview --save
```
## 属性
| **属性** | **类型** | **默认值** | **必填** | **描述** | **支持** |
| ------------------------------ | ---------- | ---------- | -------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| scrollEventThrottle | `number` | 50 | false | 这个属性控制在滚动过程中，scroll 事件被调用的频率，用于滚动的节流 | 
|
| horizontal | `boolean` | - | false | 设置为横向滚动 | 
|
| scrollTop | `number` | 0 | false | 竖向滚动距离，优先级高于`scrollTo`方法（注：运行时小程序无法生效，请使用 `scrollTo` 方案） | |
| scrollLeft | `number` | 0 | false | 横向滚动距离，优先级高于`scrollTo`方法（注：运行时小程序无法生效，请使用 `scrollTo` 方案） | |
| showsHorizontalScrollIndicator | `boolean` | true | false | 是否允许出现水平滚动条 | |
| showsVerticalScrollIndicator | `boolean` | true | false | 是否允许出现垂直滚动条 | |
| onEndReachedThreshold | `number` | 500 | false | 设置加载更多的偏移 | |
| onEndReached | `function` | - | false | 滚动区域还剩`onEndReachedThreshold`的长度时触发 | |
| onScroll | `function` | - | false | 滚动时触发的事件，返回当前滚动的水平垂直距离 | |
| onTouchStart | `function` | - | false | touchStart 触发的事件，返回触摸点数据（touches、changedTouches） | |
| onTouchMove | `function` | - | false | touchMove 触发的事件，返回触摸点数据（touches、changedTouches） | |
| onTouchEnd | `function` | - | false | touchEnd 触发的事件，返回触摸点数据（touches、changedTouches） | |
| onTouchCancel | `function` | - | false | touchCancel 触发的事件，返回触摸点数据（touches、changedTouches） | |
| disableScroll | `boolean` | - | false | 是否禁止滚动, rax-scrollview@3.3.3 及以上版本支持 | |
## 方法
### scrollTo({x: number,y: number, animated?: boolean, duration?: number})
#### 参数
**参数为 object，包含以下属性**
| **属性** | **类型** | **默认值** | **必填** | **描述** | **支持** |
| -------- | --------- | ---------- | -------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x | `number` | - | 否 | 横向的偏移量 | |
| y | `number` | - | 否 | 纵向的偏移量 | |
| animated | `boolean` | `true` | 否 | 在设置滚动条位置时使用动画过渡 | |
| duration | `number` | 400 | 否 | 当 `animated` 设置为 `true` 时，可以设置 duration 来控制动画的执行时间，单位 `ms` | |
### scrollIntoView({id: string, animated?: boolean, duration?: number, offsetX?: number, offsetY?: number})
#### 参数
**参数为 `object`，包含以下属性**
| **属性** | **类型** | **默认值** | **必填** | **描述** | **支持** |
| -------- | --------- | ---------- | -------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | `string` | - | 是 | 需要滚动到的元素 `id` | |
| animated | `boolean` | `true` | 否 | 在设置滚动条位置时使用动画过渡 | |
| duration | `number` | 400 | 否 | 当 `animated` 设置为 `true` 时，可以设置 duration 来控制动画的执行时间，单位 `ms` | |
| offsetX | `number` | - | 否 | 滚动的额外 X 偏移 | |
| offsetY | `number` | - | 否 | 滚动的额外 Y 偏移 | |
## 示例
```jsx
import { createElement, Component, render, createRef } from 'rax';
import DriverUniversal from 'driver-universal';
import View from 'rax-view';
import Text from 'rax-text';
import ScrollView from 'rax-scrollview';
function Thumb() {
return (
);
}
const THUMBS = new Array(20).fill(1);
const createThumbRow = (val, index) => ;
class App extends Component {
state = {
horizontalScrollViewEventLog: false,
scrollViewEventLog: false,
};
constructor(props) {
super(props);
this.horizontalScrollView = createRef();
}
render() {
return (
this.setState({ horizontalScrollViewEventLog: true })
}
>
{THUMBS.map(createThumbRow)}
{
this.horizontalScrollView.current.scrollTo({ x: 0 });
}}
>
Scroll to start
{this.state.horizontalScrollViewEventLog ? 'onEndReached' : ''}
{
this.scrollView = scrollView;
}}
onEndReached={() => this.setState({ scrollViewEventLog: true })}
>
Cannot sticky
Sticky view must in ScrollView root
{THUMBS.map(createThumbRow)}
{
this.scrollView.scrollTo({ y: 0 });
}}
>
Scroll to top
{this.state.scrollViewEventLog ? 'onEndReached' : ''}
);
}
}
const styles = {
root: {
width: '750rpx',
paddingTop: '20rpx',
},
sticky: {
position: 'sticky',
width: '750',
backgroundColor: '#cccccc',
},
container: {
padding: '20rpx',
borderStyle: 'solid',
borderColor: '#dddddd',
borderWidth: '1rpx',
marginLeft: '20rpx',
marginRight: '20rpx',
marginBottom: '10rpx',
},
button: {
margin: '7rpx',
padding: '5rpx',
alignItems: 'center',
backgroundColor: '#eaeaea',
borderRadius: '3rpx',
},
box: {
width: '64rpx',
height: '64rpx',
},
eventLogBox: {
padding: '10rpx',
margin: '10rpx;,
height: '80rpx',
borderWidth: '1rpx',
borderColor: '#f0f0f0',
backgroundColor: '#f9f9f9',
},
};
render(, document.body, { driver: DriverUniversal });
```
---
_Source: https://npm.io/package/rax-scrollview · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._