1.0.1 • Published 3 years ago

@ophiuchus/sticky v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

Sticky 粘性布局

介绍

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

引入

import Vue from 'vue';
import Sticky from '@ophiuchus/sticky';

Vue.use(Sticky);

代码演示

基础用法

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

<sf-sticky>
  <sf-button type="primary">基础用法</sf-button>
</sf-sticky>

吸顶距离

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

<sf-sticky :offset-top="50">
  <sf-button type="info">吸顶距离</sf-button>
</sf-sticky>

指定容器

通过 container 属性可以指定组件的容器,页面滚动时,组件会始终保持在容器范围内,当组件即将超出容器底部时,会固定在容器的底部。

<div ref="container" style="height: 150px;">
  <sf-sticky :container="container">
    <sf-button type="warning">指定容器</sf-button>
  </sf-sticky>
</div>
export default {
  data() {
    return {
      container: null,
    };
  },
  mounted() {
    this.container = this.$refs.container;
  },
};

API

Props

参数说明类型默认值
offset-top吸顶时与顶部的距离,支持 px vw vh rem 单位,默认 pxnumber | string0
z-index吸顶时的 z-indexnumber | string99
container容器对应的 HTML 节点Element-

Events

事件名说明回调参数
change当吸顶状态改变时触发isFixed: boolean
scroll滚动时触发{ scrollTop: number, isFixed: boolean }

样式变量

组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考主题定制

名称默认值描述
@sticky-z-index99-