Socket
Socket
Sign inDemoInstall

vue-agile-scrollbar

Package Overview
Dependencies
0
Maintainers
2
Versions
22
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    vue-agile-scrollbar

Custom agile scroll bar


Version published
Weekly downloads
9
increased by200%
Maintainers
2
Install size
21.4 kB
Created
Weekly downloads
 

Readme

Source

vue-agile-scrollbar

基于vue的自定义滚动条组件,完全基于浏览器的原生滚动,拥有原生滚动体验,又能自定义滚动条样式,简单而强大

Demo

查看demo

Simple usage

通过npm 或者 yarn安装

yarn add vue-agile-scrollbar

npm i vue-agile-scrollbar

引入

import 'vue-agile-scrollbar/dist/style.css'
import vueAgileScrollbar from 'vue-agile-scrollbar'
<template>
  <div style="height:200px;width:500px;border:solid #eee 1px">
    <vueAgileScrollbar>
      <div style="width:10000px; height:100000px"></div>
    </vueAgileScrollbar>
  </div>
</template>

<script>
import vueAgileScrollbar from 'vue-agile-scrollbar'
import 'vue-agile-scrollbar/dist/style.css'

export default {
  components: { vueAgileScrollbar },
  data () {
    return {
      
    }
  }
}
</script>

Api

scroll props

name类型默认值说明
minBarSizeNumber50滚动条最小尺寸,
Y轴滚动条的高度或X轴滚动条的宽度不会小于这个值
scrollTopNumber0指定滚动条滚到距离顶部某个位置
scrollLeftNumber0指定滚动条滚到距离左边某个位置
offsetLeftNumber0滚动距离左边的偏移量
offsetRightNumber10滚动距离右边的偏移量
offsetTopNumber0滚动距离顶部的偏移量
offsetBottomNumber10滚动距离底部的偏移量
isAutoUpdateBooleantrueelement改变后,是否自动更新
dragSpeedXNumber1拖拽X滚动条滚动阀值,
值越大滚动越快,越小滚动越慢
dragSpeedYNumber1拖拽Y滚动条滚动阀值,
值越大滚动越快,越小滚动越慢
displayTypeStringhover滚动条显示类型
show: 一直显示
hover:鼠标移入显示
hide:一直不显示

event

name回调参数说明
scrollfunction(scrollValue: Object, $event)滚动会触发该事件
scroll-hitfunction(type: String, scrollValue: Object)滚动条触底、触顶、触左、触右后出发该事件
updatedfunction(scrollValue: Object)容器更新后会触发该事件

方法

name参数说明
updated()-element改变后,
可以通过该方法手动更新滚动容器状态
setScrollLeft(number)-改变滚动条左边滚动距离
setScrollTop(number)-改变滚动条上边滚动距离

FAQs

Last updated on 12 Jun 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc