mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-20 20:33:32 +08:00
chore(packages): move the packages to root
This commit is contained in:
236
core/src/components/infinite-scroll/infinite-scroll.tsx
Normal file
236
core/src/components/infinite-scroll/infinite-scroll.tsx
Normal file
@ -0,0 +1,236 @@
|
||||
import { Component, Element, Event, EventEmitter, EventListenerEnable, Listen, Method, Prop, State, Watch } from '@stencil/core';
|
||||
import { DomController } from '../../index';
|
||||
|
||||
const enum Position {
|
||||
Top = 'top',
|
||||
Bottom = 'bottom',
|
||||
}
|
||||
|
||||
|
||||
@Component({
|
||||
tag: 'ion-infinite-scroll',
|
||||
styleUrl: 'infinite-scroll.scss'
|
||||
})
|
||||
export class InfiniteScroll {
|
||||
|
||||
private thrPx = 0;
|
||||
private thrPc = 0;
|
||||
private scrollEl: HTMLIonScrollElement|null = null;
|
||||
private didFire = false;
|
||||
private isBusy = false;
|
||||
private init = false;
|
||||
|
||||
@Element() private el: HTMLElement;
|
||||
@State() isLoading = false;
|
||||
|
||||
@Prop({ context: 'dom' }) dom: DomController;
|
||||
@Prop({ context: 'enableListener' }) enableListener: EventListenerEnable;
|
||||
|
||||
/**
|
||||
* The threshold distance from the bottom
|
||||
* of the content to call the `infinite` output event when scrolled.
|
||||
* The threshold value can be either a percent, or
|
||||
* in pixels. For example, use the value of `10%` for the `infinite`
|
||||
* output event to get called when the user has scrolled 10%
|
||||
* from the bottom of the page. Use the value `100px` when the
|
||||
* scroll is within 100 pixels from the bottom of the page.
|
||||
* Defaults to `15%`.
|
||||
*/
|
||||
@Prop() threshold = '15%';
|
||||
|
||||
@Watch('threshold')
|
||||
protected thresholdChanged(val: string) {
|
||||
if (val.lastIndexOf('%') > -1) {
|
||||
this.thrPx = 0;
|
||||
this.thrPc = (parseFloat(val) / 100);
|
||||
|
||||
} else {
|
||||
this.thrPx = parseFloat(val);
|
||||
this.thrPc = 0;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* If true, the infinite scroll will be hidden and scroll event listeners
|
||||
* will be removed.
|
||||
*
|
||||
* Call `enable(false)` to disable the infinite scroll from actively
|
||||
* trying to receive new data while scrolling. This method is useful
|
||||
* when it is known that there is no more data that can be added, and
|
||||
* the infinite scroll is no longer needed.
|
||||
*/
|
||||
@Prop() disabled = false;
|
||||
|
||||
@Watch('disabled')
|
||||
protected disabledChanged(val: boolean) {
|
||||
this.enableScrollEvents(!val);
|
||||
}
|
||||
|
||||
/**
|
||||
* The position of the infinite scroll element.
|
||||
* The value can be either `top` or `bottom`.
|
||||
* Defaults to `bottom`.
|
||||
*/
|
||||
@Prop() position: string = Position.Bottom;
|
||||
|
||||
/**
|
||||
* Emitted when the scroll reaches
|
||||
* the threshold distance. From within your infinite handler,
|
||||
* you must call the infinite scroll's `complete()` method when
|
||||
* your async operation has completed.
|
||||
*/
|
||||
@Event() ionInfinite: EventEmitter;
|
||||
|
||||
componentWillLoad() {
|
||||
const scrollEl = this.el.closest('ion-scroll');
|
||||
return scrollEl.componentOnReady().then((el) => {
|
||||
this.scrollEl = el;
|
||||
});
|
||||
}
|
||||
|
||||
componentDidLoad() {
|
||||
if (this.init) {
|
||||
console.warn('instance was already initialized');
|
||||
return;
|
||||
}
|
||||
this.init = true;
|
||||
this.thresholdChanged(this.threshold);
|
||||
this.enableScrollEvents(!this.disabled);
|
||||
if (this.position === Position.Top) {
|
||||
this.dom.write(() => this.scrollEl && this.scrollEl.scrollToBottom(0));
|
||||
}
|
||||
}
|
||||
|
||||
componentDidUnload() {
|
||||
this.scrollEl = null;
|
||||
}
|
||||
|
||||
@Listen('scroll', {enabled: false})
|
||||
protected onScroll() {
|
||||
const scrollEl = this.scrollEl;
|
||||
if (!scrollEl || !this.canStart()) {
|
||||
return 1;
|
||||
}
|
||||
|
||||
const infiniteHeight = this.el.offsetHeight;
|
||||
if (!infiniteHeight) {
|
||||
// if there is no height of this element then do nothing
|
||||
return 2;
|
||||
}
|
||||
const scrollTop = scrollEl.scrollTop;
|
||||
const scrollHeight = scrollEl.scrollHeight;
|
||||
const height = scrollEl.offsetHeight;
|
||||
const threshold = this.thrPc ? (height * this.thrPc) : this.thrPx;
|
||||
|
||||
const distanceFromInfinite = (this.position === Position.Bottom)
|
||||
? scrollHeight - infiniteHeight - scrollTop - threshold - height
|
||||
: scrollTop - infiniteHeight - threshold;
|
||||
|
||||
if (distanceFromInfinite < 0) {
|
||||
if (!this.didFire) {
|
||||
this.isLoading = true;
|
||||
this.didFire = true;
|
||||
this.ionInfinite.emit(this);
|
||||
return 3;
|
||||
}
|
||||
} else {
|
||||
this.didFire = false;
|
||||
}
|
||||
|
||||
return 4;
|
||||
}
|
||||
|
||||
/**
|
||||
* Call `complete()` within the `infinite` output event handler when
|
||||
* your async operation has completed. For example, the `loading`
|
||||
* state is while the app is performing an asynchronous operation,
|
||||
* such as receiving more data from an AJAX request to add more items
|
||||
* to a data list. Once the data has been received and UI updated, you
|
||||
* then call this method to signify that the loading has completed.
|
||||
* This method will change the infinite scroll's state from `loading`
|
||||
* to `enabled`.
|
||||
*/
|
||||
@Method()
|
||||
complete() {
|
||||
const scrollEl = this.scrollEl;
|
||||
if (!this.isLoading || !scrollEl) {
|
||||
return;
|
||||
}
|
||||
this.isLoading = false;
|
||||
|
||||
if (this.position === Position.Top) {
|
||||
/**
|
||||
* New content is being added at the top, but the scrollTop position stays the same,
|
||||
* which causes a scroll jump visually. This algorithm makes sure to prevent this.
|
||||
* (Frame 1)
|
||||
* - complete() is called, but the UI hasn't had time to update yet.
|
||||
* - Save the current content dimensions.
|
||||
* - Wait for the next frame using _dom.read, so the UI will be updated.
|
||||
* (Frame 2)
|
||||
* - Read the new content dimensions.
|
||||
* - Calculate the height difference and the new scroll position.
|
||||
* - Delay the scroll position change until other possible dom reads are done using _dom.write to be performant.
|
||||
* (Still frame 2, if I'm correct)
|
||||
* - Change the scroll position (= visually maintain the scroll position).
|
||||
* - Change the state to re-enable the InfiniteScroll.
|
||||
* - This should be after changing the scroll position, or it could
|
||||
* cause the InfiniteScroll to be triggered again immediately.
|
||||
* (Frame 3)
|
||||
* Done.
|
||||
*/
|
||||
this.isBusy = true;
|
||||
// ******** DOM READ ****************
|
||||
// Save the current content dimensions before the UI updates
|
||||
const prev = scrollEl.scrollHeight - scrollEl.scrollTop;
|
||||
|
||||
// ******** DOM READ ****************
|
||||
this.dom.read(() => {
|
||||
// UI has updated, save the new content dimensions
|
||||
const scrollHeight = scrollEl.scrollHeight;
|
||||
// New content was added on top, so the scroll position should be changed immediately to prevent it from jumping around
|
||||
const newScrollTop = scrollHeight - prev;
|
||||
|
||||
// ******** DOM WRITE ****************
|
||||
this.dom.write(() => {
|
||||
scrollEl.scrollTop = newScrollTop;
|
||||
this.isBusy = false;
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Pass a promise inside `waitFor()` within the `infinite` output event handler in order to
|
||||
* change state of infiniteScroll to "complete"
|
||||
*/
|
||||
@Method()
|
||||
waitFor(action: Promise<any>) {
|
||||
const enable = this.complete.bind(this);
|
||||
action.then(enable, enable);
|
||||
}
|
||||
|
||||
private canStart(): boolean {
|
||||
return (
|
||||
!this.disabled &&
|
||||
!this.isBusy &&
|
||||
!!this.scrollEl &&
|
||||
!this.isLoading);
|
||||
}
|
||||
|
||||
private enableScrollEvents(shouldListen: boolean) {
|
||||
if (this.scrollEl) {
|
||||
this.enableListener(this, 'scroll', shouldListen, this.scrollEl);
|
||||
}
|
||||
}
|
||||
|
||||
hostData() {
|
||||
return {
|
||||
class: {
|
||||
'infinite-scroll-loading': this.isLoading,
|
||||
'infinite-scroll-enabled': !this.disabled
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
}
|
Reference in New Issue
Block a user