滚动条插件 NiceScroll 使用详解

有时为了保持页面风格的统一,我们需要修改滚动条的样式。虽然我们可以通过 CSS 设置滚动条各部分的颜色样式,但这种方式不支持老版本的浏览器。而且不同的浏览器下,CSS 滚动条属性的写法也不一样,如果各个浏览器都需要兼容(特别是移动设备的浏览器),那就十分麻烦了。

这里推荐一个十分好用的滚动条插件:Nicescroll

一、NiceScroll 介绍

NiceScroll 是一款完全基于 jQuery 框架的滚动条插件,它不仅有着类似 iOS 系统设备的滚动条外观,而且还支持任意的 <div>、<iframe>、<body> 元素的滚动效果。

1.GitHub 主页

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

2.功能特点

  • 不需要增加额外的 CSS。
  • 几乎全浏览器兼容:Chrome、Firefox、Edge、IE8+、Safari、Opera
  • 实现只需要一段代码,侵入性非常小。
  • 样式可完全自定义。
  • 支持触摸事件,可在触摸屏上使用。

3.配置说明

(1)页面中引入 jquery.js
(2)页面中引入 jquery.nicescroll.js
(3)如果需要用到全屏放大功能的话,还要把 zoomico.png 复制到与 jquery.nicescroll.js 同一个文件夹下。

二、基本用法

1.最简单的用法

(1)我们只需在页面初始化完毕后,对需要使用这个滚动条插件的元素调用 niceScroll() 方法即可。

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title></title>
    <script src="js/jquery-3.1.1.js" charset="utf-8"></script>
    <script src="js/jquery.nicescroll.js" charset="utf-8"></script>
    <script type="text/javascript">
      $(document).ready(
        function() {
          $("html").niceScroll();
        }
      );
    </script>
  </head>
  <style>
    li {
      height: 50px;
    }
  </style>
  <body>
    <ul>
      <li>条目1</li>

      <li>条目2</li>

      <li>条目3</li>

      <li>条目4</li>

      <li>条目5</li>

    </ul>

  </body>

</html> 

(2)这里我直接是让整个页面使用 NiceScroll 插件,默认情况下滚动条是自动隐藏的,即内容如果超出窗口时滚动条也不会显示。(当然此时通过鼠标滚轮还是可以滚动页面的)

(3)当鼠标移到窗口右侧时,滚动条则会显示出来。我们可以拖动它进行页面滚动。

2.返回滚动条对象

var nice = false;

$(function() {  

    nice = $("body").niceScroll();

}); 

3.使用容器“wrapper”包含DIV

这种方式由两个 DIV 组成,前一个为 vieport,后一个为里面内容。

$("#viewportdiv").niceScroll("#wrapperdiv",{cursorcolor:"#00F"}); 

如果遇到加载数据的时候 nicescroll 滚动条闪烁,还有对绝对定位的元素(例如下拉框)使用滚动条,特别是在需要滚动条比较多的页面,导致位置错乱的等问题。那么需要使用这个方法对设置滚动条的元素的直接子元素进行设置,比如:

    $("#viewportdiv").niceScroll("#wrapperdiv",{
             'cursorcolor':'#686868',
             'cursorborder':'none',
             'smoothscroll': 'false',
             'autohidemode':false
     }); 

4.隐藏滚动条

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

$("#div1").getNiceScroll().hide(); 

5.重置滚动条大小

$("#div1").getNiceScroll().resize(); 

6.滚动到某个指定位置

//水平方向滚动(距左侧100px)

$("#div1").getNiceScroll(0).doScrollLeft(100);

//垂直方向滚动(距上方100px)

$("#div1").getNiceScroll(0).doScrollTop(100); 

三、常用配置参数
在调用 niceScroll() 方法初始化滚动条时,我们可以传入一些参数属性,从而对滚动条的样式以及行为进行修改。

1.简单的样式修改

(1)这里我们对滚动条的颜色和触摸滚动模式进行的修改。

$("#div1").niceScroll({

    touchbehavior:true,     //是否是触摸式滚动效果

    cursorcolor:"#333",     //滚动条的颜色值

    cursoropacitymax:0.6,   //滚动条的透明度值

    cursorwidth:20,         //滚动条的宽度值

    background:"#00F",  //滚动条的背景色,默认是透明的

    autohidemode:true,      //滚动条是否是自动隐藏,默认值为 true

}); 

(2)效果图

2.全屏放大显示

(1)要开启全屏放大功能,只需把 boxzoom 参数设置为 true。(同时记得把 zoomico.png 放到与 jquery.nicescroll.js 同一个文件夹下)

$("#div1").niceScroll({

    boxzoom: true  //显示放大镜标按钮,(默认为false)

}); 

(2)当我们将鼠标移到滚动区域右侧时,在滚动条旁边会显示出一个“放大”图标。点击后该区域会自动放大占满整个浏览器窗口。

(3)而当这个区域放大后,右上角的这个图标又会变成“缩小”图标,点击后该区域则又还原回原来的位置和尺寸。

3.完整的配置参数表

$("#div1").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值(auto或数字)

        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 // 防止多触点事件引发滚动

    }); 

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,137评论 6 511
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,824评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,465评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,131评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,140评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,895评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,535评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,435评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,952评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,081评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,210评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,896评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,552评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,089评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,198评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,531评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,209评论 2 357