dropload.js 提供了最基礎的下拉刷新與上拉載入能力,對於「後端一次返回全部資料」的場景基本開箱即用。但真實需求往往伴隨後端分頁、關鍵字搜尋、排序、多條件篩選,這時如果只會調用默認回呼,就會遇到各種「拉不動」「不出資料」的問題。本文記錄在類似美團美食列表的場景下的改造過程。
有搜尋與篩選時,使用者可能搜了一個後端並不存在的名字,此時頁面不該顯示「上拉載入更多」。因此新增一個介面用來告訴插件當前是否有資料:
MyDropLoad.prototype.setHasData = function (ishasData) {
var me = this;
if (ishasData) {
me.isData = true;
me.$domDown.html(me.opts.domDown.domRefresh);
} else {
me.isData = false;
me.$domDown.html(me.opts.domDown.domNoData);
}
fnRecoverContentHeight(me);
};
不同篩選條件返回的資料量不同,如果不執行 resetload,插件內部用於判斷「是否觸底」的捲動計算距離就會出錯,表現為上拉毫無反應。
解決原則有兩條:
MyDropLoad.prototype.resetload = function () {
var me = this;
if (me.direction == 'down' && me.upInsertDOM) {
me.$domUp.css({ 'height': '0' }).on('webkitTransitionEnd mozTransitionEnd transitionend', function () {
me.loading = false;
me.upInsertDOM = false;
$(this).remove();
fnRecoverContentHeight(me);
});
} else if (me.direction == 'up') {
me.loading = false;
me.$domDown.html(me.isData ? me.opts.domDown.domRefresh : me.opts.domDown.domNoData);
fnRecoverContentHeight(me);
}
};
現象:篩選條件 1 返回 20 條,上拉又返回 10 條後呼叫 setHasData(false);切到篩選條件 2 返回 20 條,此時上拉卻完全拉不動。
原因:setHasData(false) 之後插件仍停留在「沒有更多資料」的鎖定狀態,切換條件時沒有解除鎖定。
解法:每次變更搜尋、篩選、排序條件時,都要主動呼叫 setHasData(true) 並 unlock()。
1. 初始化實例
self.moreFund = $('#table-fundlist').dropload({
scrollArea: window,
domDown: {
domClass: 'dropload-down',
domRefresh: '<div class="dropload-refresh"><span>上拉加載更多</span></div>',
domLoad: '<div class="dropload-load"><span class="loading"></span></div>',
domNoData: ''
},
loadDownFn: function () {
self.apiParams.offset += 20; // 翻頁
self.fetchData(true);
}
});
三個必記的事項:記得保存回傳物件;loadDownFn 是上拉後的回呼,翻頁邏輯寫在這裡;無論請求成敗都要 resetload,失敗時直接呼叫,成功時要在新 HTML 渲染之後呼叫。
2. setHasData 的呼叫時機
設為 true:非翻頁請求觸發之前,也就是切換篩選、搜尋、排序條件時。
this.moreFund.setHasData(true);
設為 false:後端返回後,比較實際條數與請求的每頁條數,不足即代表已到底。
if (data.length < this.apiParams.count) {
this.moreFund.setHasData(false);
this.moreFund.lock();
}
3. lock 與 unlock 的呼叫時機
lock:後端返回不足一頁時;或當前頁面狀態本來就不該上拉(例如使用者正在搜尋框中輸入)。
unlock:只有一個地方需要呼叫——發送請求之前。
if (self.moreFund) {
self.moreFund.unlock();
}
核心狀態由幾個旗標構成,理解它們就能自行擴展:
(function ($) {
'use strict';
var win = window, doc = document;
var $win = $(win), $doc = $(doc);
$.fn.dropload = function (options) {
return new MyDropLoad(this, options);
};
var MyDropLoad = function (element, options) {
var me = this;
me.$element = $(element);
me.upInsertDOM = false; // 上方 DOM 是否已插入
me.loading = false; // 是否正在載入
me.isLockUp = false; // 是否鎖定下拉
me.isLockDown = false; // 是否鎖定上拉
me.isData = true; // 是否還有更多資料
me._scrollTop = 0;
me.init(options);
};
MyDropLoad.prototype.init = function (options) {
var me = this;
me.opts = $.extend({}, {
scrollArea: me.$element,
domUp: {
domClass: 'dropload-up',
domRefresh: '<div class="dropload-refresh">下拉刷新</div>',
domUpdate: '<div class="dropload-update">釋放更新</div>',
domLoad: '<div class="dropload-load"><span class="loading"></span></div>'
},
domDown: {
domClass: 'dropload-down',
domRefresh: '<div class="dropload-refresh">上拉加載更多</div>',
domLoad: '<div class="dropload-load"><span class="loading"></span></div>',
domNoData: '<div class="dropload-noData">暫無更多資料</div>'
},
distance: 50, // 觸發門檻
threshold: '', // 提前載入距離
loadUpFn: '',
loadDownFn: ''
}, options);
if (me.opts.loadDownFn !== '') {
me.$element.append('<div class="' + me.opts.domDown.domClass + '">' +
me.opts.domDown.domRefresh + '</div>');
me.$domDown = $('.' + me.opts.domDown.domClass);
}
if (me.opts.scrollArea == win) {
me.$scrollArea = $win;
me._scrollContentHeight = $doc.height();
me._scrollWindowHeight = doc.documentElement.clientHeight;
} else {
me.$scrollArea = me.opts.scrollArea;
me._scrollContentHeight = me.$element[0].scrollHeight;
me._scrollWindowHeight = me.$element.height();
}
$win.on('resize', function () {
if (me.opts.scrollArea == win) {
me._scrollWindowHeight = win.innerHeight;
} else {
me._scrollWindowHeight = me.$element.height();
}
});
me.$element.on('touchstart', function (e) {
if (!me.loading) { fnTouches(e); fnTouchstart(e, me); }
});
me.$element.on('touchmove', function (e) {
if (!me.loading) { fnTouches(e); fnTouchmove(e, me); }
});
me.$element.on('touchend', function () {
if (!me.loading) { fnTouchend(me); }
});
me.$scrollArea.on('scroll', function () {
me._scrollTop = me.$scrollArea.scrollTop();
fnRecoverContentHeight(me);
me._threshold = (me.opts.threshold === '')
? Math.floor(me.$domDown.height() * 1 / 3)
: me.opts.threshold;
// 觸底判斷
if (me.opts.loadDownFn !== '' && !me.loading && !me.isLockDown &&
me._threshold != 0 &&
(me._scrollContentHeight - me._threshold) <= (me._scrollWindowHeight + me._scrollTop)) {
fnLoadDown();
}
});
function fnLoadDown() {
me.direction = 'up';
me.$domDown.html(me.opts.domDown.domLoad);
me.loading = true;
me.opts.loadDownFn(me);
}
};
function fnTouches(e) {
if (!e.touches) { e.touches = e.originalEvent.touches; }
}
function fnTouchstart(e, me) {
me._startY = e.touches[0].pageY;
me.touchScrollTop = me.$scrollArea.scrollTop();
}
function fnTouchmove(e, me) {
me._curY = e.touches[0].pageY;
me._moveY = me._curY - me._startY;
if (me._moveY > 0) { me.direction = 'down'; }
else if (me._moveY < 0) { me.direction = 'up'; }
var _absMoveY = Math.abs(me._moveY);
if (me.opts.loadUpFn !== '' && me.touchScrollTop <= 0 &&
me.direction == 'down' && !me.isLockUp) {
e.preventDefault();
me.$domUp = $('.' + me.opts.domUp.domClass);
if (!me.upInsertDOM) {
me.$element.prepend('<div class="' + me.opts.domUp.domClass + '"></div>');
me.upInsertDOM = true;
}
fnTransition(me.$domUp, 0);
if (_absMoveY <= me.opts.distance) {
me._offsetY = _absMoveY;
me.$domUp.html(me.opts.domUp.domRefresh);
} else if (_absMoveY <= me.opts.distance * 2) {
me._offsetY = me.opts.distance + (_absMoveY - me.opts.distance) * 0.5;
me.$domUp.html(me.opts.domUp.domUpdate);
} else {
me._offsetY = me.opts.distance * 1.5 + (_absMoveY - me.opts.distance * 2) * 0.2;
}
me.$domUp.css({ 'height': me._offsetY });
}
}
function fnTouchend(me) {
var _absMoveY = Math.abs(me._moveY);
if (me.opts.loadUpFn !== '' && me.touchScrollTop <= 0 &&
me.direction == 'down' && !me.isLockUp) {
fnTransition(me.$domUp, 300);
if (_absMoveY > me.opts.distance) {
me.$domUp.css({ 'height': me.$domUp.children().height() });
me.$domUp.html(me.opts.domUp.domLoad);
me.loading = true;
me.opts.loadUpFn(me);
} else {
me.$domUp.css({ 'height': '0' }).on('webkitTransitionEnd transitionend', function () {
me.upInsertDOM = false;
$(this).remove();
});
}
me._moveY = 0;
}
}
// 重新計算文檔高度,是分頁場景下必須的一環
function fnRecoverContentHeight(me) {
if (me.opts.scrollArea == win) {
me._scrollContentHeight = $doc.height();
} else {
me._scrollContentHeight = me.$element[0].scrollHeight;
}
}
function fnTransition(dom, num) {
dom.css({
'-webkit-transition': 'all ' + num + 'ms',
'transition': 'all ' + num + 'ms'
});
}
MyDropLoad.prototype.lock = function (direction) {
var me = this;
if (direction === undefined) {
if (me.direction == 'up') { me.isLockDown = true; }
else if (me.direction == 'down') { me.isLockUp = true; }
else { me.isLockUp = true; me.isLockDown = true; }
} else if (direction == 'up') { me.isLockUp = true; }
else if (direction == 'down') { me.isLockDown = true; }
};
MyDropLoad.prototype.unlock = function () {
this.isLockUp = false;
this.isLockDown = false;
};
MyDropLoad.prototype.setHasData = function (ishasData) {
var me = this;
me.isData = !!ishasData;
me.$domDown.html(ishasData ? me.opts.domDown.domRefresh : me.opts.domDown.domNoData);
fnRecoverContentHeight(me);
};
MyDropLoad.prototype.resetload = function () {
var me = this;
if (me.direction == 'down' && me.upInsertDOM) {
me.$domUp.css({ 'height': '0' }).on('webkitTransitionEnd mozTransitionEnd transitionend', function () {
me.loading = false;
me.upInsertDOM = false;
$(this).remove();
fnRecoverContentHeight(me);
});
} else if (me.direction == 'up') {
me.loading = false;
me.$domDown.html(me.isData ? me.opts.domDown.domRefresh : me.opts.domDown.domNoData);
fnRecoverContentHeight(me);
}
};
})(window.Zepto || window.jQuery);
.dropload-up, .dropload-down {
background-color: #F0EFF5;
position: relative;
height: 0;
overflow: hidden;
}
.dropload-down { height: 50px; border-top: 1px solid #e5e5e5; }
.dropload-refresh .drop-up-icon, .dropload-refresh .drop-down-icon,
.dropload-update .drop-up-icon, .dropload-update .drop-down-icon {
vertical-align: text-bottom; margin-right: 3px; height: 16px; width: 12px;
}
.dropload-load .loading-icon { vertical-align: middle; height: 20px; width: 20px; }
.dropload-refresh span, .dropload-update span {
vertical-align: middle; line-height: 18px; font-size: 16px; color: #585858;
}
.dropload-noData { border-bottom: 1px solid #e5e5e5; background-color: #FFFFFF; }
.dropload-noData span { line-height: 18px; font-size: 14px; color: #999999; }
.dropload-refresh, .dropload-update, .dropload-load, .dropload-noData {
position: absolute; width: 100%; height: 50px; bottom: 0;
line-height: 50px; text-align: center;
}
.dropload-down .dropload-refresh,
.dropload-down .dropload-update,
.dropload-down .dropload-load { top: 0; bottom: auto; }
用這類捲動載入外掛時,最容易忽略的不是 API 怎麼調,而是狀態同步:請求結束了沒有?還有多少資料?是否處於鎖定?這三個問題只要有一個沒照顧到,就會表現成「拉不動」或「重複載入」。把 resetload、setHasData、lock / unlock 的呼叫時機固定成一套紀律,絕大多數奇怪的 bug 都能提前避免。