jQuery插件之 Nicescroll滚动条

今天药忘吃喽~ 2022-05-30 02:50 582阅读 0赞

Nicescroll滚动条插件是一个非常强大的基于JQUERY的滚动条插件，不需要增加额外的css，几乎全浏览器兼容。ie6+，实现只需要一段代码，侵入性非常小，样式可完全自定义，支持触摸事件，可在触摸屏上使用。  
效果图：![这里写图片描述][70]

//基础用法
    1 $(document).ready(
    2   function() {  
    3     $("html").niceScroll();
    4   }
    5 );

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

隐藏滚动条：（当在同一页面中使用多个nicescroll插件时，要及时隐藏用完的nicescroll对象，加载时，需要先show,再resize。）

1 $("#mydiv").getNiceScroll().hide();

检测滚动条是否重置大小（当窗口改变大小时）：

1 $("#mydiv").getNiceScroll().resize();

滚动到某个位置：

1 $("#mydiv").getNiceScroll(0).doScrollLeft(x, duration); // Scroll X Axis；第一个参数为滚动的位置，第二个为滚动需要的时间
    2 $("#mydiv").getNiceScroll(0).doScrollTop(y, duration); // Scroll Y Axis

设置各种参数：

$("#thisdiv").niceScroll({
            cursorcolor: "#424242", // 改变滚动条颜色，使用16进制颜色值
            cursoropacitymin: 0, // 当滚动条是隐藏状态时改变透明度, 值范围 1 到 0
            cursoropacitymax: 1, // 当滚动条是显示状态时改变透明度, 值范围 1 到 0
            cursorwidth: "5px", // 滚动条的宽度，单位：便素
            cursorborder: "1px solid #fff", // CSS方式定义滚动条边框
            cursorborderradius: "5px", // 滚动条圆角（像素）
            zindex: "auto" | <number>, // 改变滚动条的DIV的z-index值
            scrollspeed: 60, // 滚动速度
            mousescrollstep: 40, // 鼠标滚轮的滚动速度 (像素)
            touchbehavior: false, // 激活拖拽滚动
            hwacceleration: true, // 激活硬件加速
            boxzoom: false, // 激活放大box的内容
            dblclickzoom: true, // (仅当 boxzoom=true时有效)双击box时放大
            gesturezoom: true, // (仅 boxzoom=true 和触屏设备时有效) 激活变焦当out/in（两个手指外张或收缩）
            grabcursorenabled: true // (仅当 touchbehavior=true) 显示“抓住”图标display "grab" icon
            autohidemode: true, // 隐藏滚动条的方式, 可用的值: 
              true | // 无滚动时隐藏
              "cursor" | // 隐藏
              false | // 不隐藏,
              "leave" | // 仅在指针离开内容时隐藏
              "hidden" | // 一直隐藏
              "scroll", // 仅在滚动时显示 
            background: "", // 轨道的背景颜色
            iframeautoresize: true, // 在加载事件时自动重置iframe大小
            cursorminheight: 32, // 设置滚动条的最小高度 (像素)
            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, // 当选择文本时激活内容自动滚动
            cursordragspeed: 0.3, // 设置拖拽的速度
            rtlmode: "auto", // DIV的水平滚动从左边开始
            cursordragontouch: false, // 使用触屏模式来实现拖拽
            oneaxismousemode: "auto", // 当只有水平滚动时可以用鼠标滚轮来滚动，如果设为false则不支持水平滚动，如果设为auto支持双轴滚动
            scriptpath: "" // 为boxmode图片自定义路径 ("" => same script path)
            preventmultitouchscrolling: true // 防止多触点事件引发滚动
        });

当插件放在具有absolute浮动的容器中，并设置了top值时，插件的top会出现问题，解决方法使用插件的railoffset属性：

1 railoffset, you can add offset top/left for rail position (default:false)

加载数据的时候nicescroll滚动条闪烁，还有对绝对定位的元素（例如下拉框）使用滚动条，特别是在需要滚动条比较多的页面，导致位置错乱，这些问题需要对设置滚动条的元素的直接子元素设置,官方给出的答案是：

1 $('#addContent_scroll_wrap').niceScroll('#sumStackColumn',{
       'cursorcolor':'#686868','cursorborder':'none','smoothscroll': 'false','autohidemode':false});

但是之后仍然发现一个问题，在页面比较复杂的情况下，可能会出现，下拉框出来了，但是滚动条没出来，官方给出的说法是：当在同一页面中使用多个nicescroll插件时，要及时隐藏用完的nicescroll对象，加载时，需要先show,再resize。  
所以采用resize()的方法，重置了滚动条，但是一定要注意，这里选择滚动条的对象，一定不能选错，否则也是无效的：

1 $('#addContent_scroll_wrap').getNiceScroll().show();
    2 $('#addContent_scroll_wrap').getNiceScroll().resize();

示例代码

<!DOCTYPE html>
    <html>
    <head>
        <script src="jquery-2.1.4.js"></script>
        <script src="jquery.nicescroll.js"></script>
    </head>
    <body>
    <div id="div1" style="width:100%;height:600px;overflow:auto;">
        <h1>这里是滚动条插件niceScroll的测试页面</h1>
        <h2>这里是滚动条插件niceScroll的测试页面</h2>
        <h3>这里是滚动条插件niceScroll的测试页面</h3>
        <h4>这里是滚动条插件niceScroll的测试页面</h4>
        <h5>这里是滚动条插件niceScroll的测试页面</h5>
        <h6>这里是滚动条插件niceScroll的测试页面</h6>
        <p>这里是滚动条插件niceScroll的测试页面</p>
        <span>这里是滚动条插件niceScroll的测试页面</span>
        <h1>下面是带有滚动条的子div</h1>
        <div id="div2" style="width:350px;height:200px;overflow:auto;border:1px solid red;">
            <div id="warp">
                <h1>我是带有滚动条的子div</h1>
                <h2>我是带有滚动条的子div</h2>
                <h3>我是带有滚动条的子div</h3>
                <h4>我是带有滚动条的子div</h4>
                <h5>我是带有滚动条的子div</h5>
                <h6>我是带有滚动条的子div</h6>
            </div>
        </div>
        <h1>这里是滚动条插件niceScroll的测试页面</h1>
        <h2>这里是滚动条插件niceScroll的测试页面</h2>
        <h3>这里是滚动条插件niceScroll的测试页面</h3>
        <h4>这里是滚动条插件niceScroll的测试页面</h4>
        <h5>这里是滚动条插件niceScroll的测试页面</h5>
        <h6>这里是滚动条插件niceScroll的测试页面</h6>
    </div>
    </body>
    <script> $(function () { $("#div1").niceScroll({ cursorborder: "", cursorcolor: "#00F", boxzoom: false, autohidemode: false }); $("#div2").niceScroll('#warp', { cursorborder: "", cursorcolor: "#00F", boxzoom: false, autohidemode: false }); }); </script>
    </html>

[地址：http://www.cnblogs.com/jinqi79731/p/nicescroll.html][http_www.cnblogs.com_jinqi79731_p_nicescroll.html]  
[官网：https://nicescroll.areaaperta.com/how-to-use/][https_nicescroll.areaaperta.com_how-to-use]

[70]: /images/20220530/58fbbcd01427404f8893882f78f0f233.png
[http_www.cnblogs.com_jinqi79731_p_nicescroll.html]: http://www.cnblogs.com/jinqi79731/p/nicescroll.html
[https_nicescroll.areaaperta.com_how-to-use]: https://nicescroll.areaaperta.com/how-to-use/