【轉】Nicescroll滾動條插件的用法

轉自：http://www.cnblogs.com/jinqi79731/p/nicescroll.html

Nicescroll滾動條插件是一個很是強大的基於JQUERY的滾動條插件，不須要增長額外的css，幾乎全瀏覽器兼容。ie6+，實現只須要一段代碼，侵入性很是小，樣式可徹底自定義，支持觸摸事件，可在觸摸屏上使用。

官網地址：http://www.areaaperta.com/nicescroll/

引入核心文件，插件須要引入1.5.X以上版本的jquery庫

最簡單的用法以下：

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

設置各類參數：

 1 $("#thisdiv").niceScroll({
 2         cursorcolor: "#424242", // 改變滾動條顏色，使用16進制顏色值
 3         cursoropacitymin: 0, // 當滾動條是隱藏狀態時改變透明度, 值範圍 1 到 0
 4         cursoropacitymax: 1, // 當滾動條是顯示狀態時改變透明度, 值範圍 1 到 0
 5         cursorwidth: "5px", // 滾動條的寬度，單位：便素
 6         cursorborder: "1px solid #fff", // CSS方式定義滾動條邊框
 7         cursorborderradius: "5px", // 滾動條圓角（像素）
 8         zindex: "auto" | <number>, // 改變滾動條的DIV的z-index值
 9         scrollspeed: 60, // 滾動速度
10         mousescrollstep: 40, // 鼠標滾輪的滾動速度 (像素)
11         touchbehavior: false, // 激活拖拽滾動
12         hwacceleration: true, // 激活硬件加速
13         boxzoom: false, // 激活放大box的內容
14         dblclickzoom: true, // (僅當 boxzoom=true時有效)雙擊box時放大
15         gesturezoom: true, // (僅 boxzoom=true 和觸屏設備時有效) 激活變焦當out/in（兩個手指外張或收縮）
16         grabcursorenabled: true // (僅當 touchbehavior=true) 顯示「抓住」圖標display "grab" icon
17         autohidemode: true, // 隱藏滾動條的方式, 可用的值: 
18           true | // 無滾動時隱藏
19           "cursor" | // 隱藏
20           false | // 不隱藏,
21           "leave" | // 僅在指針離開內容時隱藏
22           "hidden" | // 一直隱藏
23           "scroll", // 僅在滾動時顯示        
24         background: "", // 軌道的背景顏色
25         iframeautoresize: true, // 在加載事件時自動重置iframe大小
26         cursorminheight: 32, // 設置滾動條的最小高度 (像素)
27         preservenativescrolling: true, // 你能夠用鼠標滾動可滾動區域的滾動條和增長鼠標滾輪事件
28         railoffset: false, // 可使用top/left來修正位置
29         bouncescroll: false, // (only hw accell) 啓用滾動跳躍的內容移動
30         spacebarenabled: true, // 當按下空格時使頁面向下滾動
31         railpadding: { top: 0, right: 0, left: 0, bottom: 0 }, // 設置軌道的內間距
32         disableoutline: true, // 當選中一個使用nicescroll的div時，chrome瀏覽器中禁用outline
33         horizrailenabled: true, // nicescroll能夠管理水平滾動
34         railalign: right, // 對齊垂直軌道
35         railvalign: bottom, // 對齊水平軌道
36         enabletranslate3d: true, // nicescroll 可使用CSS變型來滾動內容
37         enablemousewheel: true, // nicescroll能夠管理鼠標滾輪事件
38         enablekeyboard: true, // nicescroll能夠管理鍵盤事件
39         smoothscroll: true, // ease動畫滾動
40         sensitiverail: true, // 單擊軌道產生滾動
41         enablemouselockapi: true, // 能夠用鼠標鎖定API標題 (相似對象拖動)
42         cursorfixedheight: false, // 修正光標的高度（像素）
43         hidecursordelay: 400, // 設置滾動條淡出的延遲時間（毫秒）
44         directionlockdeadzone: 6, // 設定死區，爲激活方向鎖定（像素）
45         nativeparentscrolling: true, // 檢測內容底部便於讓父級滾動
46         enablescrollonselection: true, // 當選擇文本時激活內容自動滾動
47         cursordragspeed: 0.3, // 設置拖拽的速度
48         rtlmode: "auto", // DIV的水平滾動從左邊開始
49         cursordragontouch: false, // 使用觸屏模式來實現拖拽
50         oneaxismousemode: "auto", // 當只有水平滾動時能夠用鼠標滾輪來滾動，若是設爲false則不支持水平滾動，若是設爲auto支持雙軸滾動
51         scriptpath: "" // 爲boxmode圖片自定義路徑 ("" => same script path)
52         preventmultitouchscrolling: true // 防止多觸點事件引起滾動
53     });

當插件放在具備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();