Skip to content

meyt/vue-sticky-directive

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vue-sticky-directive

vue-sticky-directive is a powerful vue directive make element sticky.

Install

npm install vue-sticky-directive --save

ES2015

// register globally
import Sticky from 'vue-sticky-directive'
Vue.use(Sticky)

// or for a single instance
import Sticky from 'vue-sticky-directive'
new Vue({
  directives: {Sticky}
})

Usage

Use v-sticky directive to enable element postion stikcy, and use sticky-* attributes to define its options. Sticky element will find its nearest element with sticky-container attribute or its parent node if faild as the releative element.

basic example

<div sticky-container>
  <div v-stikcy sticky-offset="offset" sticky-side="top">
    ...
  </div>
</div>

Options

  • sticky-offset
    • top(number) - set the top breakpoint (default: 0)
    • bottom(number) - set the bottom breakpoint (default: 0)
  • sticky-side(string) decide which side should be stikcy, you can set topbottom or both (default: top)

License

MIT

About

A powerful vue directive make element sticky.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%