# Sticky 粘性布局

### 介绍

Sticky 组件与 CSS 中`position: sticky`属性实现的效果一致，当组件在屏幕范围内时，会按照正常的布局排列，当组件滚出屏幕范围时，始终会固定在屏幕顶部。

### 引入

在`index.config.js中引入组件

```json
"usingComponents": {
  "van-sticky": "@vant/weapp/sticky/index"
}
```


## 代码演示

### 基础用法

将内容包裹在`Sticky`组件内即可

```html
<van-sticky>
   <van-button type="primary" customStyle="margin-left: 15px">
              基础用法
   </van-button>
</van-sticky>
```

### 吸顶距离

通过`offset-top`属性可以设置组件在吸顶时与顶部的距离

```html
<van-sticky offsetTop={ 50 }>
    <van-button type="info" customStyle="margin-left: 115px">
        吸顶距离
    </van-button>
</van-sticky>
```

### 指定容器

通过`container`属性可以指定组件的容器，页面滚动时，组件会始终保持在容器范围内，当组件即将超出容器底部时，会返回原位置

```html
<view id="container" style="height: 150px;">
  <van-sticky container={this.state.container}>
              <van-button type="warning" customStyle="margin-left: 215px;">
                指定容器
              </van-button>
  </van-sticky>
</view>
```

```js

   state = {
     container: null,
     scrollTop: 0,
     offsetTop: 0,
   };

   componentDidShow() {
      this.setState({
        container: () => wx.createSelectorQuery().select('#container2'),
      });
    }

    onScroll(event) {
      wx.createSelectorQuery()
        .select('#scroller')
        .boundingClientRect((res) => {
          this.setState({
            scrollTop: event.detail.scrollTop,
            offsetTop: res.top,
          });
        })
        .exec();
    }


```

### 嵌套在 scroll-view 内使用

通过 `scroll-top` 与 `offset-top` 属性可以实现在 scroll-view 内嵌套使用

```html
 <scroll-view
            onScroll={(e) => this.onScroll(e)}
            scroll-y
            id="scroller"
            style="height: 200px; background-color: #fff;"
          >
            <view style="height: 400px; padding-top: 50px;">
              <van-sticky scroll-top={this.state.scrollTop} offset-top={this.state.offsetTop}>
                <van-button type="warning">
                  嵌套在 scroll-view 内
                </van-button>
              </van-sticky>
            </view>
  </scroll-view>
```

```js
Page({
  data: {
    scrollTop: 0,
    offsetTop: 0,
  },

  onScroll(event) {
    wx.createSelectorQuery()
      .select('#scroller')
      .boundingClientRect((res) => {
        this.setData({
          scrollTop: event.detail.scrollTop,
          offsetTop: res.top,
        });
      })
      .exec();
  },
});
```

## API
### 注:属性应用在组件上需要统一使用驼峰式命名，如custom-class应变为
```html
<van-button type="primary" customClass='myClass' size="large">大号按钮</van-button>
```
### 注:事件应用在组件上需要统一使用驼峰式命名，如bind:click/bind:search/bind:before-enter应变为
```html
<van-button type="primary" onClick={()=>this.onClick()}>大号按钮</van-button>
<van-search type="primary" onSearch={()=>this.onSearch()}>大号按钮</van-search>
<van-transition type="primary" onBeforeEnter={()=>this.onBeforeEnter()}>大号按钮</van-transition>
```
### Props

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| offset-top | 吸顶时与顶部的距离，单位`px` | _number_ | `0` |
| z-index | 吸顶时的 z-index | _number_ | `99` |
| container | 一个函数，返回容器对应的 NodesRef 节点 | _function_ | - |
| scroll-top | 当前滚动区域的滚动位置，非 `null` 时会禁用页面滚动事件的监听 | _number_ | - |

### Events

| 事件名 | 说明       | 回调参数                                       |
| ------ | ---------- | ---------------------------------------------- |
| scroll | 滚动时触发 | { scrollTop: 距离顶部位置, isFixed: 是否吸顶 } |