jquery滚动条美化插件niceScroll

之前使用并介绍过一款模拟滚动条的插件叫jquery滚动条插件slimScroll,虽然很好用,但不兼容ie7有点头痛,在文章里面有人评论推荐niceScroll 插件,最近项目用到了模拟滚动条的地方,发现 niceScroll 真不错。

官方介绍

NiceScroll 是一个类似于 iOS /移动端 样式的 jQuery 滚动条插件,不需要增加额外的CSS,几乎全浏览器兼容,实现只需要一段代码,侵入性非常小,样式可完全自定义,支持触摸事件,可在触摸屏上使用。

在现代浏览器中还加入了硬件加速,滚动优化,比起原生的滚动会更流畅(跟slimScroll更流畅)。

插件特色

  1. 支持横向滚动条
  2. 支持Divs、IFrames、textarea和文档页面滚动
  3. 兼容所有桌面浏览器:Firefox 4+,Chrome 5+,Safari 4+(win / mac),Opera 10+,IE 6+。 (所有A级浏览器)
  4. 与移动设备兼容:iPad / iPhone / iPod,Android 2.2+,Blackberry手机和Playbook(WebWorks / Table OS),Windows Phone 7.5芒果。
  5. 兼容所有触摸设备:iPad,Android平板电脑,窗口表面。
  6. 可与多输入设备(鼠标与触摸或笔):窗口表面,Chrome桌面触摸笔记本。
  7. 兼容2方向鼠标:苹果魔术鼠标,苹果公司与2 dir轮,PC鼠标与2 dir轮(如果浏览器支持它)。

使用代码

// 1. 简单模式,设置html元素滚动
$(document).ready(function() {  
    $("html").niceScroll();
});

// 2. 返回对象的实例
var nice = false;
$(document).ready(function() {  
    nice = $("html").niceScroll();
});

// 3. 设置一个div,并改变光标颜色
$(document).ready(function() {  
    $("#thisdiv").niceScroll({cursorcolor:"#00F"});
});

// 4. DIV用“wrapper”,由两个div组成,第一个是视口,后面是内容:
$(document).ready(function() {
    $("#viewportdiv").niceScroll("#wrapperdiv",{cursorcolor:"#00F"});
});

// 5. 获得这个对象
var nice = $("#mydiv").getNiceScroll();

// 6. 隐藏滚动条
$("#mydiv").getNiceScroll().hide();

// 7. 检测滚动条是否重置大小(当窗口改变大小时)
$("#mydiv").getNiceScroll().resize();

// 8. 滚动到某个位置
$("#mydiv").getNiceScroll(0).doScrollLeft(x, duration); // Scroll X Axis
$("#mydiv").getNiceScroll(0).doScrollTop(y, duration); // Scroll Y Axis

参数配置

你可以通过给niceScroll传入一些参数来自定义显示效果

$("#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, // 防止多触点事件引发滚动
        disablemutationobserver: false // force MutationObserver disabled
    });

插件下载 演示 niceScroll官网

如果你发现插件使用之后无法显示,可能是插件的bug,你可以给插件设置下面这个参数试试,我就遇到过在ie中无法显示,加了这个参数才显示出来。

autohidemode:false

关注我

我的微信公众号:前端开发博客,在后台回复以下关键字可以获取资源。

  • 回复「小抄」,领取Vue、JavaScript 和 WebComponent 小抄 PDF
  • 回复「Vue脑图」获取 Vue 相关脑图
  • 回复「思维图」获取 JavaScript 相关思维图
  • 回复「简历」获取简历制作建议
  • 回复「简历模板」获取精选的简历模板
  • 回复「加群」进入500人前端精英群
  • 回复「电子书」下载我整理的大量前端资源,含面试、Vue实战项目、CSS和JavaScript电子书等。
  • 回复「知识点」下载高清JavaScript知识点图谱

每日分享有用的前端开发知识,加我微信:caibaojian89 交流