[new feature] add sticky component (#3888)

2019-07-18 17:48:18 +08:00
parent e1021e70ba
commit b273c89b3a
23 changed files with 651 additions and 124 deletions
@@ -0,0 +1,76 @@
+# Sticky 粘性布局
+
+### 介绍
+
+Sticky 组件与 CSS 中`position: sticky`属性实现的效果一致，当组件在屏幕范围内时，会按照正常的布局排列，当组件滚出屏幕范围时，始终会固定在屏幕顶部。
+
+### 引入
+
+``` javascript
+import { Sticky } from 'vant';
+
+Vue.use(Sticky);
+```
+
+## 代码演示
+
+### 基础用法
+
+将内容包裹在`Sticky`组件内即可
+
+```html
+<van-sticky>
+  <van-button type="primary">基础用法</van-button>
+</van-sticky>
+```
+
+### 吸顶距离
+
+通过`offset-top`属性可以设置组件在吸顶时与顶部的距离
+
+```html
+<van-sticky :offset-top="50">
+  <van-button type="info">吸顶距离</van-button>
+</van-sticky>
+```
+
+### 指定容器
+
+通过`container`属性可以指定组件的容器，页面滚动时，组件会始终保持在容器范围内，当组件即将超出容器底部时，会固定在容器的底部
+
+```html
+<div ref="container" style="height: 150px;">
+  <van-sticky :container="container">
+    <van-button type="warning">指定容器</van-button>
+  </van-sticky>
+</div>
+```
+
+```js
+export default {
+  data() {
+    return {
+      container: null
+    };
+  },
+  mounted() {
+    this.container = this.$refs.container;
+  }
+};
+```
+
+## API
+
+### Props
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 |
+|------|------|------|------|------|
+| offset-top | 吸顶时与顶部的距离，单位`px` | `number` | `0` | - |
+| z-index | 吸顶时的 z-index | `number` | `99` | - |
+| container | 容器对应的 HTML 节点 | `HTMLElement` | - | - |
+
+### Events
+
+| 事件名 | 说明 | 回调参数 |
+|------|------|------|
+| scroll | 滚动时触发 | { scrollTop: 距离顶部位置, isFixed: 是否吸顶 } |