Nicescroll滾動條插件的用法(轉)

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

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

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

最簡單的用法以下：

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

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

隱藏滾動條

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

檢測滾動條是否重置大小（當窗口改變大小時）

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

滾動到某個位置

$("#mydiv").getNiceScroll(0).doScrollLeft(x, duration); // Scroll X Axis
$("#mydiv").getNiceScroll(0).doScrollTop(y, duration); // Scroll Y Axis

可增長各類參數

$(document).ready(
  function() { 
    $("#thisdiv").niceScroll({cursorcolor:"#00F"});
  }
);

配置參數表

$("#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 // 防止多觸點事件引起滾動
    });

另外注意：當在同一頁面中使用多個nicescroll插件時，要及時隱藏用完的nicescroll對象，加載時，須要先show,再resize。

當插件放在具備absolute浮動的容器中，並設置了top值時，插件的top會出現問題，解決方法使用插件的railoffset屬性：

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