nicescroll 使用場景與引數配置
阿新 • • 發佈:2021-08-20
使用場景
// 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
引數配置
$("#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值,不會建立新的層疊上下文,如果是圖片會覆蓋文字,但是會在zindex:0的下面
zindex:0, // 如果是圖片會覆蓋背後文字,會建立一個新的層疊上下文,所以在zindex: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, // 防止多觸點事件引發滾動 disablemutationobserver: false // force MutationObserver disabled });