粘性布局 Sticky
Sticky 组件与 CSS 中 position: sticky 属性实现的效果一致。可切换 css 模式和 js 模式,纯 css 模式不适用的情况可以采用 js 模式, js 模式采用 IntersectionObserver Api。
使用
API安装使用
{
// 原生小程序
"usingComponents": {
"ti-sticky": "@titian-design/weapp/sticky/index"
},
// titan-cli搭建的项目
"usingComponents": {
"ti-sticky": "platform://titian-mp/ti-sticky"
}
}
用法示例
基础用法
<ti-sticky>
<div>吸顶元素</div>
</ti-sticky>
使用css模式
使用条件:
- 父元素不能overflow:hidden或者overflow:auto属性;
- 父元素的高度需大于sticky元素的高度;
- sticky元素仅在其父元素内生效。
<ti-sticky use-pure-css>
<div>吸顶元素</div>
</ti-sticky>
吸顶距离
<ti-sticky offset-top="{{ 100 }}">
<div>吸顶元素</div>
</ti-sticky>
指定容器
use-pure-css模式下无需指定container,默认在父元素内生效。
- index.wxml
- index.js
<view id="custom-container" style="height: 250rpx;">
<ti-sticky container="{{ container }}">
<ti-button>指定容器</ti-button>
</ti-sticky>
</view>
Page({
data: {
container: null,
},
onReady() {
this.setData({
container: () => wx.createSelectorQuery().select("#container"),
});
},
});
ti-sticky API
属性 Properties
名称 | 类型 | 必填 | 默认值 | 说明 | 备注 |
---|---|---|---|---|---|
offset-top | number | 否 | 0 | 吸顶时与顶部的距离,单位 px | - |
container | function | 否 | - | 一个函数,返回容器对应的 NodesRef 节点 | - |
disabled | boolean | 否 | false | 是否禁止吸顶 | - |
z-index | number | 否 | 99 | z-index | - |
use-pure-css | boolean | 否 | false | 使用css的position: sticky实现 | - |
事件 Events
名称 | 参数列表 | 描述 | 备注 |
---|---|---|---|
bind:fixed | (e: WechatMiniprogram.CustomEvent<{isFixed: boolean}>) => void | 在吸顶状态改变是触发 | - |
插槽 Slots
名称 | 说明 | 备注 |
---|---|---|
default | 默认插槽 | - |