ant-design-vue/components/vc-lazy-load/src/LazyLoad.jsx

152 lines
4.2 KiB
Vue
Raw Normal View History

2019-01-12 03:33:27 +00:00
import PropTypes from '../../_util/vue-types';
import BaseMixin from '../../_util/BaseMixin';
Feat 1.5.0 (#1853) * feat: add Result component * fix: update md template tag html>tpl - fix `result` typo - update jest `result` snapshots * refactor: svg file to functional component icon - update jest snapshot * feat: add result * Feat descriptions (#1251) * feat: add descriptions * fix: add descriptions types and fix docs * fix: lint change code * fix: demo warning * fix: update demo, snapshot and remove classnames * test: add descriptions test * fix: descriptions demo (#1498) * feat: add page header (#1250) * feat: add page-header component * update site: page-header * ts definition update: page-header * get page-header props with getComponentFromProp func * optimize page-header * doc: add page-header actions.md responsive.md * breadcrumb itemRender add pure function support * style: format code * feat: update style to 3.23.6 from 2.13.6 * feat: update style to 3.26.8 from 3.23.6 * chore: update util * chore: update util * feat: update affix * feat: update alert * feat: update anchor * feat: update auto-complete * feat: update avatar * feat: update back-top * feat: update badge * feat: update button * feat: update breadcrumb * feat: update ts * docs: update doc * feat: update calendat * feat: update card * feat: update carousel * feat: update carousel * feat: update checkbox * feat: update comment * feat: update config-provider * docs: update doc * feat: update collapse * feat: update locale * feat: update date-picker * feat: update divider * feat: update drawer * feat: update dropdown * feat: update rc-trigger * feat: update dropdown * feat: update empty * test: add empty test * feat: update form * feat: update form * feat: update spin * feat: update grid * docs: update grid doc * feat: update icon * feat: update slider * feat: update textarea * feat: update input-number * feat: update layout * feat: update list * feat: update menu * feat: meaage add key for update content * feat: modal add closeIcon support * feat: update notification * feat: add pagination disabled support * feat: popconfirm add disabled support * test: update popover * feat: progress support custom line-gradiend * feat: update radio * test: update radio test * docs: update rate demo * feat: skeleton add avatar support number type * test: add switch test * test: update statistic test * fix: input clear icon event * feat: steps add type、 v-model、subTitle * feat: delete typography component * feat: delete Typography style * perf: update select * feat: add download transformFile previewFile actio * docs: update upload * feat: update tree-select * docs: update tree-select * feat: tree add blockNode selectable * docs: add tree demo * test: update snap * docs: updatedoc * feat: update tag * docs: update ad doc * feat: update tooltip * feat: update timeline * feat: time-picker add clearIcon * docs: update tabs * feat: transfer support custom children * test: update transfer test * feat: update table * test: update table test * test: update test * feat: calendar update locale * test: update test snap * feat: add mentions (#1790) * feat: mentions style * feat: theme default * feat: add mentions component * feat: mentions API * feat: add unit test for mentions * feat: update mentions demo * perf: model and inheritAttrs for mentions * perf: use getComponentFromProp instead of this.$props * perf: mentions rm defaultProps * feat: rm rows in mentionsProps * fix: mentions keyDown didn't work * docs: update mentions api * perf: mentions code * feat: update mentions * bump 1.5.0-alpha.1 * feat: pageheader add ghost prop * docs: update descriptions demo * chore: page-header add ghost type * fix: color error * feat: update to 3.26.12 * fix: some prop default value * fix(typo): form, carousel, upload. duplicate identifier (#1848) * Add Mentions Type (#1845) * feat: add mentions type * feat: add mentions in ant-design-vue.d.ts * docs: update doc * docs: add changelog * fix: mentions getPopupCotainer value (#1850) * docs: update doc * docs: uptate demo * docs: update demo * docs: delete demo * docs: delete doc * test: update snapshots * style: format code * chore: update travis * docs: update demo Co-authored-by: Sendya <18x@loacg.com> Co-authored-by: zkwolf <chenhao5866@gmail.com> Co-authored-by: drafish <xwlyy1991@163.com> Co-authored-by: Amour1688 <31695475+Amour1688@users.noreply.github.com>
2020-03-07 11:45:13 +00:00
import addEventListener from '../../vc-util/Dom/addEventListener';
2020-07-18 13:54:46 +00:00
import { initDefaultProps, findDOMNode, getSlot } from '../../_util/props-util';
2019-01-12 03:33:27 +00:00
import warning from '../../_util/warning';
import debounce from 'lodash-es/debounce';
import throttle from 'lodash-es/throttle';
2019-01-12 03:33:27 +00:00
import parentScroll from './utils/parentScroll';
import inViewport from './utils/inViewport';
2020-10-12 05:27:16 +00:00
import { watchEffect, defineComponent } from 'vue';
2018-04-06 16:20:45 +00:00
const lazyLoadProps = {
debounce: PropTypes.looseBool,
2018-04-06 16:20:45 +00:00
elementType: PropTypes.string,
2019-01-12 03:33:27 +00:00
height: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
2018-04-06 16:20:45 +00:00
offset: PropTypes.number,
offsetBottom: PropTypes.number,
offsetHorizontal: PropTypes.number,
offsetLeft: PropTypes.number,
offsetRight: PropTypes.number,
offsetTop: PropTypes.number,
offsetVertical: PropTypes.number,
threshold: PropTypes.number,
throttle: PropTypes.number,
2019-01-12 03:33:27 +00:00
width: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
};
2018-04-06 16:20:45 +00:00
2020-10-12 05:27:16 +00:00
export default defineComponent({
2018-04-06 16:20:45 +00:00
name: 'LazyLoad',
mixins: [BaseMixin],
2020-07-18 13:54:46 +00:00
inheritAttrs: false,
2018-04-06 16:20:45 +00:00
props: initDefaultProps(lazyLoadProps, {
elementType: 'div',
debounce: true,
offset: 0,
offsetBottom: 0,
offsetHorizontal: 0,
offsetLeft: 0,
offsetRight: 0,
offsetTop: 0,
offsetVertical: 0,
throttle: 250,
}),
2019-01-12 03:33:27 +00:00
data() {
2018-04-06 16:20:45 +00:00
if (this.throttle > 0) {
if (this.debounce) {
2019-01-12 03:33:27 +00:00
this.lazyLoadHandler = debounce(this.lazyLoadHandler, this.throttle);
2018-04-06 16:20:45 +00:00
} else {
2019-01-12 03:33:27 +00:00
this.lazyLoadHandler = throttle(this.lazyLoadHandler, this.throttle);
2018-04-06 16:20:45 +00:00
}
}
return {
visible: false,
2019-01-12 03:33:27 +00:00
};
2018-04-06 16:20:45 +00:00
},
2019-01-12 03:33:27 +00:00
mounted() {
2018-04-06 16:20:45 +00:00
this.$nextTick(() => {
2020-08-27 14:38:56 +00:00
watchEffect(() => {
if (!this.visible) {
this.lazyLoadHandler(this.$props);
}
});
2019-01-12 03:33:27 +00:00
const eventNode = this.getEventNode();
2018-04-06 16:20:45 +00:00
if (this.lazyLoadHandler.flush) {
2019-01-12 03:33:27 +00:00
this.lazyLoadHandler.flush();
2018-04-06 16:20:45 +00:00
}
2019-01-12 03:33:27 +00:00
this.resizeHander = addEventListener(window, 'resize', this.lazyLoadHandler);
this.scrollHander = addEventListener(eventNode, 'scroll', this.lazyLoadHandler);
});
2018-04-06 16:20:45 +00:00
},
2020-06-11 08:13:09 +00:00
beforeUnmount() {
2018-04-06 16:20:45 +00:00
if (this.lazyLoadHandler.cancel) {
2019-01-12 03:33:27 +00:00
this.lazyLoadHandler.cancel();
2018-04-06 16:20:45 +00:00
}
2019-01-12 03:33:27 +00:00
this.detachListeners();
2018-04-06 16:20:45 +00:00
},
methods: {
2019-01-12 03:33:27 +00:00
getEventNode() {
2020-07-18 13:54:46 +00:00
return parentScroll(findDOMNode(this));
2018-04-06 16:20:45 +00:00
},
2019-01-12 03:33:27 +00:00
getOffset() {
2018-04-06 16:20:45 +00:00
const {
2019-01-12 03:33:27 +00:00
offset,
offsetVertical,
offsetHorizontal,
offsetTop,
offsetBottom,
offsetLeft,
offsetRight,
threshold,
} = this.$props;
2018-04-06 16:20:45 +00:00
2019-01-12 03:33:27 +00:00
const _offsetAll = threshold || offset;
const _offsetVertical = offsetVertical || _offsetAll;
const _offsetHorizontal = offsetHorizontal || _offsetAll;
2018-04-06 16:20:45 +00:00
return {
top: offsetTop || _offsetVertical,
bottom: offsetBottom || _offsetVertical,
left: offsetLeft || _offsetHorizontal,
right: offsetRight || _offsetHorizontal,
2019-01-12 03:33:27 +00:00
};
2018-04-06 16:20:45 +00:00
},
2019-01-12 03:33:27 +00:00
lazyLoadHandler() {
2020-08-27 14:38:56 +00:00
if (!this._.isMounted) {
2019-01-12 03:33:27 +00:00
return;
2018-04-06 16:20:45 +00:00
}
2019-01-12 03:33:27 +00:00
const offset = this.getOffset();
2020-07-18 13:54:46 +00:00
const node = findDOMNode(this);
2019-01-12 03:33:27 +00:00
const eventNode = this.getEventNode();
2018-04-06 16:20:45 +00:00
if (inViewport(node, eventNode, offset)) {
this.setState({ visible: true }, () => {
2019-01-12 03:33:27 +00:00
this.__emit('contentVisible');
});
this.detachListeners();
2018-04-06 16:20:45 +00:00
}
},
2019-01-12 03:33:27 +00:00
detachListeners() {
this.resizeHander && this.resizeHander.remove();
this.scrollHander && this.scrollHander.remove();
2018-04-06 16:20:45 +00:00
},
},
2020-07-18 13:54:46 +00:00
render() {
const children = getSlot(this);
2018-04-06 16:20:45 +00:00
if (children.length !== 1) {
2019-01-12 03:33:27 +00:00
warning(false, 'lazyLoad组件只能包含一个子元素');
return null;
2018-04-06 16:20:45 +00:00
}
2020-07-18 13:54:46 +00:00
const { height, width, elementType: ElementType } = this.$props;
2019-01-12 03:33:27 +00:00
const { visible } = this;
2020-07-18 13:54:46 +00:00
const { class: className } = this.$attrs;
2018-04-06 16:20:45 +00:00
const elStyles = {
height: typeof height === 'number' ? height + 'px' : height,
width: typeof width === 'number' ? width + 'px' : width,
2019-01-12 03:33:27 +00:00
};
2018-04-06 16:20:45 +00:00
const elClasses = {
2019-01-12 03:33:27 +00:00
LazyLoad: true,
2018-04-06 16:20:45 +00:00
'is-visible': visible,
2020-07-18 13:54:46 +00:00
[className]: className,
2019-01-12 03:33:27 +00:00
};
2020-07-18 13:54:46 +00:00
return (
<ElementType class={elClasses} style={elStyles}>
{visible ? children[0] : null}
</ElementType>
2019-01-12 03:33:27 +00:00
);
2018-04-06 16:20:45 +00:00
},
2020-10-12 05:27:16 +00:00
});