nanoScrollerJS 是一款能以簡單方式實現 Mac OS X Lion 系統滾動條風格的 jQuery 插件。它以最精簡的 HTML 結構 .nano > .nano-content 為基礎,其餘滾動條元素 .pane > .nano-slider 則在插件運行時動態產生。透過原生滾動條的支援,它也能在 iPad、iPhone 與部分 Android 平板裝置上正常運作。
以下為該插件運作所必需的 HTML 結構:
<div id="about" class="nano">
<div class="nano-content"> ... content here ... </div>
</div>
nano 與 nano-content 的 class 名稱可以透過插件參數來變更(變更後插件的 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; }
在頁面中引入 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 });
銷毀 nanoScroller 滾動條並還原為瀏覽器原生滾動條:$(".nano").nanoScroller({ destroy: true });
讓滾動條閃動,閃動時間由參數設定(預設 1.5 秒):$(".nano").nanoScroller({ flash: true });
刷新滾動條,重新計算滾動條的位置與高度:$(".nano").nanoScroller();
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 相同,在用戶每次滾動到容器頂部時觸發。此外 update 事件會在用戶每次滾動時觸發,並附上滾動條當前位置、最大高度與方向(up 或 down)的 JS 物件參數:
$(".nano").on("update", function(event, values){
console.debug( values );
});
iOSNativeScrolling:希望在 iOS 5+ 使用原生滾動條時設為 true(預設 false)。注意設為 true 時 .pane 與 .slider 不會被產生以支援原生滾動條。
$(".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 改變大小;若啟用此選項,記得呼叫 reset 方法,否則可能出現奇怪問題(預設 false)。$(".nano").nanoScroller({ disableResize: true });
alwaysVisible:設為 true 關閉滾動條停止時自動隱藏的功能(預設 false)。$(".nano").nanoScroller({ alwaysVisible: true });
flashDelay:開啟 flash 選項時,指定閃動延時(預設 1500)。$(".nano").nanoScroller({ flashDelay: 1000 });
paneClass:滾動條 track 元素的 class 名稱(預設 'nano-pane')。$(".nano").nanoScroller({ sliderClass: 'scrollSlider' });
contentClass:滾動條容器 div 的 class 名稱(預設 '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 原生瀏覽器(需搭配插件)、Android Opera 11.6(需搭配插件)。
若要讓 nanoScroller 在移動瀏覽器上運作得更好,可以透過 overthrow.js,它會在移動裝置上模擬 CSS 的 overflow(overflow: auto;/overflow: scroll;)。使用前先引入:
<script src="overthrow.js"></script>
接著在滾動條內容 div 中加入 overthrow class:
<div id="about" class="nano">
<div class="overthrow nano-content"> ... content here ... </div>
</div>
以上就是 nanoscroller 插件的使用方式,希望對你的開發有所幫助。