0.0.3 • Published 4 years ago

v-scroll-affix v0.0.3

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

v-scroll-affix

npm file size Build Status

A lightweight lib for making navigation elements affix as you scroll, a wrapper of scroll-affix .

在滚动时激活固钉的轻量级 vue 组件,封装自 scroll-affix

Live Demo

live demo

Installation

npm install v-scroll-affix --save

Usage

<div id="app" class="container">
    <div class="main">
        this is main content.
    </div>
    <div class="right-menu">
        <VScrollAffix :offsetTop="20" sectionSelector="#app .main">
            <ul>
                <li>this is a list</li>
                <li>this is a list</li>
                <li>this is a list</li>
                <li>this is a list</li>
                <li>this is a list</li>
                <li>this is a list</li>
            </ul>
        </VScrollAffix>
    </div>
</div>
// window
// const VScrollAffix = window['VScrollAffix'];
// commonjs like
// const VScrollAffix = require('v-scroll-affix');
// es module, typescript
import VScrollAffix from './VScrollAffix.vue';

// Vue.use(VScrollAffix); // global

export default {
    components: {
        VScrollAffix // local
    }
};

Props

nametypedefaultdescription
offsetTopnumber0offsetTop to affix element 浮动的 y 轴偏移量
maxScrollHeightnumber()=>numbermax height to affix element 自定义可浮动区域的最大高度
sectionSelectorstringget max height to affix element by section element 根据关联区域动态获取可浮动区域最大高度

Enjoy it! :D