jquery.nicescroll介绍 配置说明 使用指引

Gitee
GitHub

jQuery NiceScroll 是一个基于 jQuery 的插件，可用于实现具有平滑滚动效果的自定义滚动条。这个插件可以让网站看起来更加精致和专业，并且在用户交互体验方面也会带来更好的效果。

以下是对 jQuery NiceScroll 的介绍、配置说明和使用指引：

介绍

jQuery NiceScroll 是一种 JavaScript 库，能够为您的网站添加自定义的滚动条。
这个插件跨浏览器兼容，因此几乎所有用户都可以获得相同的优秀体验。
可以使用多种不同的方法定义自定义滚动条，从而实现完全符合独特设计要求的外观和感觉。

配置说明

在开始使用 jQuery NiceScroll 之前，您需要了解如何配置它。以下是配置文件中包含的主要变量：

• cursorcolor: “#424242”, 滚动条颜色，使用16进制颜色值
• cursoropacitymin: 0, 当滚动条是隐藏状态时改变透明度, 值范围 1 到 0
• cursoropacitymax: 1, 当滚动条是显示状态时改变透明度, 值范围 1 到 0
• cursorwidth: “5px”, // 滚动条的宽度，单位：便素
• cursorborder: “1px solid #fff”, // CSS方式定义滚动条边框
• cursorborderradius: “5px”, // 滚动条圆角（像素）
• zindex: “auto” | , // 改变滚动条的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 // 防止多触点事件引发滚动

这些变量与配置文件中提供的其他变量配合使用。您可以通过以下方式自定义任何属性来获得快速滚动、渐隐或频率高的滚动条：

$("#zhongjyuan").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 // 防止多触点事件引发滚动
    });

使用指引

下面是 jQuery NiceScroll 的使用指南：

1. 引入 jQuery 库和 jQuery NiceScroll 插件

首先，确保已经在你的项目中引入了 jQuery 库和 jQuery NiceScroll 插件。

<head>
    <script src="http://zhongjyuan.net/static/js/jquery-2.2.4.min.js"></script>
    <script src="http://zhongjyuan.net/static/js/jquery.nicescroll.min.js"></script>
</head>

2. 激活 NiceScroll

为要应用 NiceScroll 的元素调用 niceScroll() 方法：

$(document).ready(function() {  
    $("zhongjyuan").niceScroll();
});

在上面的代码中，我们选择了整个HTML文档并启用了 NiceScroll。如果想要禁用某个元素的 NiceSroll，只需向 niceScroll() 方法传递一个值为 false 的参数。

$("#zhongjyuan").niceScroll(false);

3. 自定义滚动条

如果需要自定义 NiceScroll 的样式，可以在 niceScroll()方法中传入一个配置对象。如下所示：

$(document).ready(function() {  
    $("zhongjyuan").niceScroll({
        cursorwidth: "10px",
        cursorcolor:"#414A4C",
        background:"rgba(0,0,0,0.07)",
        autohidemode:false,
        horizrailenabled:false,
        smoothscroll:true,
        scrollspeed:60,
        touchbehavior:true
    });
});

以上代码定义了滚动条的一些属性，具体请参考上面的配置说明。

4. 销毁 NiceScroll

如果要禁用 NiceScroll 并删除该元素上的自定义滚动条，请调用 remove() 方法。

$("#zhongjyuan").getNiceScroll().remove();

好了，使用 jQuery NiceScroll 就是这么简单！通过吸引人的自定义外观和平滑的滚动效果，您可以使网站更加专业，并带来更好的用户交互体验。