滚动条美化-nicescroll

滚动条美化

一、官网与文档

https://nicescroll.areaaperta.com/

https://github.com/inuyaksa/jquery.nicescroll

二、引入

引用jquery.js和jquery.nicescroll.js

<script src="js/jquery.min.js"></script>
<script src="js/jquery.nicescroll.min.js"></script>

三、使用

• html结构

<div class="scroll-box scroll-bar">

</div>

• 初始化：注意：一定要放在$(document).ready(function(){})中进行初始化！

$("#scroll-bar").niceScroll({ 
    cursorcolor: "#99bbba", //滚动条的颜色
    cursoropacitymax: 0.9, //滚动条的透明度，从0-1   
    touchbehavior: false, //使是否是触摸式滚动效果
    cursorwidth: "6px", //滚动条的宽度 
    cursorborder: "0", // 滚动条边框 
    cursorborderradius: "3px", //滚动条圆角   
    autohidemode: false, //是否隐藏滚动条  true的时候默认不显示滚动条，当鼠标经过的时候显示滚动条   
    zindex: "auto", //给滚动条设置z-index值    
    background:"#00F",//滚动条的背景色
    railvalign:'defaul',
    railpadding: {
        top: 0,
        right: -6,
        left: 0,
        bottom: 0
    }, //滚动条的位置
});

• 隐藏滚动条，注意：这个只是把滚动条隐藏，使用鼠标滚轮仍然可以进行滚动。

$(".scroll-bar").getNiceScroll().hide();

• 重置滚动条大小

$(".scroll-bar").getNiceScroll().resize();

• 滚动到某个指定位置

//水平方向滚动（距左侧100px）
$(".scroll-bar").getNiceScroll(0).doScrollLeft(100); 
//垂直方向滚动（距上方100px）
$(".scroll-bar").getNiceScroll(0).doScrollTop(100);

• 注意1：当在同一页面中使用多个nicescroll插件时，要及时隐藏用完的nicescroll对象，加载时，需要先show,再resize。

//默认可先隐藏滚动条。使用时：
$(".scroll-bar").getNiceScroll().show();
$(".scroll-bar").getNiceScroll().resize();

• 注意2：使用swiper页面轮播中的滚动条会错位，解决：可将父元素设置position:ansolute。

四、参数

zIndex:9999 , //改变z-index值的滚动条的div
    
cursoropacitymin: 0,  // 当滚动条是隐藏状态时改变透明度，值范围1到0

cursoropacitymax: 1,  // 当滚动条是显示状态时改变透明度，值范围1到0

cursorcolor: "#424242",  // 滚动条颜色，使用16进制颜色值

cursorwidth: "6px",  // 滚动条的宽度，单位：像素

cursorborder: "1px solid #fff",  // CSS 方式定义滚动条边框

cursorborderradius: "5px",  // 滚动条圆角（像素）
    
background:"#00F",  //滚动条的背景色，默认是透明的
    
scrollspeed: 60,  // 滚动速度

mousescrollstep:40, //鼠标滚动的滚动速度

touchbehavior: false, // 激活拖拽滚动 （不赞成，不宜用）

hwacceleration: true,  // 激活硬件加速

boxzoom: false,  // 激活放大box的内容

dblclickzoom: true,  // （仅当 boxzoom=true 时有效）双击 box 时放大 

gesturezoom: true,  // （仅 boxzoom=true 和触屏设备时有效）激活变焦当 out/in （两个手指外账或收缩）

grabcursorenabled: true,  // （仅当透彻behavior=true）显示“抓住”图标 display "grab" icon

autohidemode: true,  // 隐藏滚动条的方式，可用的值：true|无滚动时隐藏，"cursor"|隐藏，false|不隐藏，"leave"|仅在指针离开内容时隐藏，"hidden"|一直隐藏，"scroll"|仅在滚动时显示

iframeautoresize: true,  // 在加载事件时自动重置 iframe 大小

cursorminheight:20,  // 设置滚动条的最小高度（像素）

preservenativescrolling: true,  // 你可以用鼠标滚动可滚动区域的滚动条和增加鼠标滚轮事件 

railoffset: false,  // 可以使用 top/left 来修正位置

bouncescroll: false,  // （only hw accell）启用滚动跳跃的内容移动

spacebarenabled: true,  // 当按下空格时使页面向下滚动

 railpadding: {  // 设置轨道的内间距
      top: 0,
      right: 0,
      left: 0,
      bottom: 0
}, 

 disableoutline: true,  // 当选中一个使用 niceScroll 的 div 时，Chrome浏览器中禁用 outline  

horizrailenabled: true,  // niceScroll 可以管理水平滚动

railalign: "right",  // 对齐垂直轨道

railvalign: "bottom",  // 对齐水平轨道 

enabletranslate3d: true,  // niceScroll 可以使用 CSS 变型来滚动内容

enablemousewheel: true,  // niceScroll 可以管理鼠标滚轮事件

enablekeyboard: true,  // niceScroll 可以管理键盘事件

smoothscroll: true,  // ease 动画滚动

sensitiverail: true,  // 单击轨道产生滚动

enablemouselockapi: true,  // 可以用鼠标锁定 API 标题（类似对象拖动） 

cursorfixedheight: false,  // 修正光标的高度（像素）

hidecursordelay: 400,  // 设置滚动条淡出的延迟时间（毫秒） 

directionlockdeadzone: 6,  // 设定死区，为激活方向锁定（像素）

nativeparentscrolling: true,  // 检测内容底部便于让父级滚动

enablescrollonselection: true,  // 当选择文本时激活内容自动滚动
    
overflowx: true,

overflowy: true,

cursordragspeed: 0.3,  // 设置拖拽的速度

rtlmode: "auto",  // DIV 的水平滚动从左边开始

cursordragontouch: false,  // 使用触屏模式来实现拖拽

oneaxismousemode: "auto",  // 当只用水平滚动时可以用鼠标来滚动，如果设为 false 则不支持水平滚动，如果设为 auto 支持双轴滚动

scriptpath: getScriptPath(),  // 为 boxmode 图片自定义路径

preventmultitouchscrolling: true,  // 防止多触点时间引发滚动

disablemutationobserver: false,

enableobserver: true,

scrollbarid: false