nanoScrollerJS是一款使用簡單方式實現 Mac OS X Lion 系統滾動條效果的jQuery插件。該滾動條插件使用最小的HTML結構 .nano > .nano-content 。其它的滾動條元素 .pane > .nano-slider 是在插件運行時動態加載的。該滾動條插件利用原生的滾動條可以工作在 iPad、iPhone 和一些 Android Tablets上。
使用方法
HTML結構
下面是該滾動條插件工作所必須的HTML結構:
代碼如下:
<div id="about" class="nano">
<div class="nano-content"> ... content here ... </div>
</div>
nano 和 nano-content 的class名稱可以通過插件參數來改變(改變後插件的CSS文件也要相應的改變)。
CSS樣式
在HTML <header> 中引入 nanoscroller.css 文件。
代碼如下:
<link rel="stylesheet" href="nanoscroller.css">
你必須為容器指定一個寬度和高度,並為你的滾動條定制一些基本樣式,例如:
代碼如下:
.nano { background: #bba; width: 500px; height: 500px; }
.nano > .nano-content { padding: 10px; }
.nano > .nano-pane { background: #888; }
.nano > .nano-pane > .nano-slider { background: #111; }
JAVASCRIPT
在頁面中引入 jquery.nanoscroller.js 文件。
代碼如下:
<script type="text/javascript" src="js/jquery.nanoscroller.js"></script>
然後使用下面的方法調用該滾動條插件,HTML中所有帶有 .nano 的DOM元素都會被應用上該方法:
代碼如下:
$(".nano").nanoScroller();
高級方法
滾動到頂部:
代碼如下:
$(".nano").nanoScroller({ scroll: 'top' });
滾動到底部:
代碼如下:
$(".nano").nanoScroller({ scroll: 'bottom' });
滾動到頂部並帶個偏移值:
代碼如下:
$(".nano").nanoScroller({ scrollTop: value });
滾動到底部並帶個偏移值:
代碼如下:
$(".nano").nanoScroller({ scrollBottom: value });
滾動一個元素:
代碼如下:
$(".nano").nanoScroller({ scrollTo: $('#a_node') });
停止滾動操作。這個選項將會使滾動條插件的所有綁定事件無效,並在UI上隱藏滾動條。
代碼如下:
$(".nano").nanoScroller({ stop: true });
destroy
銷毀nanoScroller滾動條並將滾動條重置為浏覽器原生滾動條:
代碼如下:
$(".nano").nanoScroller({ destroy: true });
設置滾動條閃動,閃動時間由參數來設置(默認1.5秒)。
代碼如下:
$(".nano").nanoScroller({ flash: true });
nanoScroller();
刷新滾動條。該操作會簡單的重新計算滾動條的位置和高度:
代碼如下:
$(".nano").nanoScroller();
自定義事件
scrollend
一個自定義的 scrollend 事件會在每次滾動條滾動到容器底部時觸發。(當滾動條已經到達容器底部,用戶再次滾動時不會觸發該事件)
代碼如下:
$(".nano").bind("scrollend", function(e){
console.log("current HTMLDivElement", e.currentTarget);
});
有些浏覽器會在同一時間多次觸發該事件,所以應該使用jQuery .bind 或 .on 來綁定該事件。你可以使用 jquery-debounce 插件來使浏覽器每隔100毫秒才觸發一次該事件:
代碼如下:
$(".nano").debounce("scrollend", function() {
alert("The end");
}, 100);
scrolltop
和 scrollend 事件相同,它是每次用戶滾動到容器的頂部時觸發。
和 scrollend 事件和 scrolltop 事件相同,它在用戶每次滾動時觸發。該事件附帶滾動條當前位置、最大高度和方向( up 或 down )的js對象參數:
代碼如下:
$(".nano").on("update", function(event, values){
console.debug( values );
});
配置參數
該滾動條插件中有一組參數可以使用:
iOSNativeScrolling
如果你希望在 iOS 5+ 中使用原生的滾動條,可以設置為 true 。在 iOS 5+ 中原生的滾動條會工作的更好。
注意當 iOSNativeScrolling 設置為 true 時, .pane 和 .slider 不會被設備生成/添加來支持原生的滾動條。
默認值 :false。
代碼如下:
$(".nano").nanoScroller({ iOSNativeScrolling: true });
sliderMinHeight
設置滾動元素的最小高度:
默認值 :20。
代碼如下:
$(".nano").nanoScroller({ sliderMinHeight: 40 })
sliderMaxHeight
設置滾動元素的最大高度:
默認值 :null。
代碼如下:
$(".nano").nanoScroller({ sliderMaxHeight: 200 });
preventPageScrolling
設置為 true 時可以在容器內容滾動到頂部或底部時阻止頁面滾動:
默認值 :false。
代碼如下:
$(".nano").nanoScroller({ preventPageScrolling: true });
disableResize
設置為 true 阻止nanoscroller改變大小。如果你設置該選項為 true ,記住要調用reset方法,否則會產生奇怪的問題:
默認值 :false。
代碼如下:
$(".nano").nanoScroller({ disableResize: true });
alwaysVisible
設置為 true 關閉滾動條停止時自動隱藏功能:
默認值 :false。
代碼如下:
$(".nano").nanoScroller({ alwaysVisible: true });
flashDelay
在你開啟 flash 選項時,該選項用於指定閃動的延時:
默認值 :1500。
代碼如下:
$(".nano").nanoScroller({ flashDelay: 1000 });
paneClass
滾動條track元素的class名稱。如果你修改了它,需要在CSS文件中做相應的修改:
默認值 : 'nano-pane'。
代碼如下:
$(".nano").nanoScroller({ sliderClass: 'scrollSlider' });
contentClass
滾動條容器div的class名稱。如果你修改了它,需要在CSS文件中做相應的修改:
默認值 : 'nano-content'。
代碼如下:
$(".nano").nanoScroller({ contentClass: 'sliderContent' });
tabIndex
設置可滾動內容的順序,設置為-1時使用tab鍵會跳過該內容:
默認值 :0。
代碼如下:
$(".nano").nanoScroller({ tabIndex: 0 });
浏覽器兼容
桌面設備
IE7+
Firefox 3+
Chrome
Safari 4+
Opera 11.60+
移動設備
iOS 5+ (iPhone, iPad 和 iPod Touch)
iOS 4 (附帶一個插件)
Android Firefox
Android 2.2/2.3 native browser (附帶一個插件)
Android Opera 11.6 (附帶一個插件)
通過插件在移動設備浏覽器更好的運行nanoScroller
你可以通過 overthrow.js 來使nanoScroller 在移動浏覽器上更好的工作。它會在移動設備上模擬CSS的overflow( overflow: auto;/overflow: scroll; )。
要使用overthrow,在頁面中引入overthrow.js:
代碼如下:
<script src="overthrow.js"></script>
然後在你的滾動條內容 div 中添加 overthrow class:
代碼如下:
<div id="about" class="nano">
<div class="overthrow nano-content"> ... content here ... </div>
</div>
以上就是關於nanoscroller插件的使用方法,希望大家能夠喜歡。