Skip to content

fix(ui5-list): growing with scroll improved #12087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(ui5-list): growing with scroll improved #12087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 57 additions & 44 deletions packages/main/src/List.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ import type CheckBox from "./CheckBox.js";
import type RadioButton from "./RadioButton.js";
import { isInstanceOfListItemGroup } from "./ListItemGroup.js";
import type ListItemGroup from "./ListItemGroup.js";
import { findVerticalScrollContainer } from "./TableUtils.js";

const INFINITE_SCROLL_DEBOUNCE_RATE = 250; // ms

Expand Down Expand Up @@ -525,17 +524,17 @@ class List extends UI5Element {
static i18nBundle: I18nBundle;
_previouslyFocusedItem: ListItemBase | null;
_forwardingFocus: boolean;
listEndObserved: boolean;
_handleResizeCallback: ResizeObserverCallback;
initialIntersection: boolean;
_selectionRequested?: boolean;
_groupCount: number;
_groupItemCount: number;
growingIntersectionObserver?: IntersectionObserver | null;
_endIntersectionObserver?: IntersectionObserver | null;
_startIntersectionObserver?: IntersectionObserver | null;
_itemNavigation: ItemNavigation;
_beforeElement?: HTMLElement | null;
_afterElement?: HTMLElement | null;
_startMarkerOutOfView: boolean = false;

handleResizeCallback: ResizeObserverCallback;
onItemFocusedBound: (e: CustomEvent) => void;
onForwardAfterBound: (e: CustomEvent) => void;
onForwardBeforeBound: (e: CustomEvent) => void;
Expand All @@ -551,20 +550,14 @@ class List extends UI5Element {
// Indicates that the List is forwarding the focus before or after the internal ul.
this._forwardingFocus = false;

// Indicates if the IntersectionObserver started observing the List
this.listEndObserved = false;

this._itemNavigation = new ItemNavigation(this, {
skipItemsSize: PAGE_UP_DOWN_SIZE, // PAGE_UP and PAGE_DOWN will skip trough 10 items
navigationMode: NavigationMode.Vertical,
getItemsCallback: () => this.getEnabledItems(),
});

this._handleResizeCallback = this._handleResize.bind(this);
this.handleResizeCallback = this._handleResize.bind(this);

// Indicates the List bottom most part has been detected by the IntersectionObserver
// for the first time.
this.initialIntersection = true;
this._groupCount = 0;
this._groupItemCount = 0;

Expand Down Expand Up @@ -600,13 +593,14 @@ class List extends UI5Element {
onEnterDOM() {
registerUI5Element(this, this._updateAssociatedLabelsTexts.bind(this));
DragRegistry.subscribe(this);
ResizeHandler.register(this.getDomRef()!, this._handleResizeCallback);
ResizeHandler.register(this.getDomRef()!, this.handleResizeCallback);
}

onExitDOM() {
deregisterUI5Element(this);
this.unobserveListEnd();
ResizeHandler.deregister(this.getDomRef()!, this._handleResizeCallback);
this.unobserveListStart();
ResizeHandler.deregister(this.getDomRef()!, this.handleResizeCallback);
DragRegistry.unsubscribe(this);
}

Expand All @@ -617,11 +611,10 @@ class List extends UI5Element {

onAfterRendering() {
this.attachGroupHeaderEvents();
if (this.growsOnScroll) {
this.observeListEnd();
} else if (this.listEndObserved) {
this.unobserveListEnd();
}
this.unobserveListEnd();
this.unobserveListStart();
this.observeListEnd();
this.observeListStart();

if (this.grows) {
this.checkListInViewport();
Expand Down Expand Up @@ -670,6 +663,10 @@ class List extends UI5Element {
return this.shadowRoot!.querySelector(".ui5-list-end-marker");
}

get listStartDOM() {
return this.shadowRoot!.querySelector(".ui5-list-start-marker");
}

get dropIndicatorDOM(): DropIndicator | null {
return this.shadowRoot!.querySelector("[ui5-drop-indicator]");
}
Expand Down Expand Up @@ -736,13 +733,9 @@ class List extends UI5Element {
return this.accessibilityAttributes.growingButton?.name ? undefined : `${this._id}-growingButton-text`;
}

get scrollContainer() {
return this.shadowRoot!.querySelector<HTMLElement>(".ui5-list-scroll-container");
}

hasGrowingComponent(): boolean {
if (this.growsOnScroll && this.scrollContainer) {
return this.scrollContainer.clientHeight !== this.scrollContainer.scrollHeight;
if (this.growsOnScroll) {
return this._startMarkerOutOfView;
}

return this.growsWithButton;
Expand Down Expand Up @@ -824,33 +817,43 @@ class List extends UI5Element {
}

async observeListEnd() {
if (!this.listEndObserved) {
await renderFinished();
this.getIntersectionObserver().observe(this.listEndDOM!);
this.listEndObserved = true;
}
await renderFinished();
this.getIntersectionObserver().observe(this.listEndDOM!);
}

unobserveListEnd() {
if (this.growingIntersectionObserver) {
this.growingIntersectionObserver.disconnect();
this.growingIntersectionObserver = null;
this.listEndObserved = false;
if (this._endIntersectionObserver) {
this._endIntersectionObserver.disconnect();
this._endIntersectionObserver = null;
}
}

onInteresection(entries: Array<IntersectionObserverEntry>) {
if (this.initialIntersection) {
this.initialIntersection = false;
return;
async observeListStart() {
await renderFinished();
this.get_StartIntersectionObserver().observe(this.listStartDOM!);
}

unobserveListStart() {
if (this._startIntersectionObserver) {
this._startIntersectionObserver.disconnect();
this._startIntersectionObserver = null;
}
}

onEndIntersection(entries: Array<IntersectionObserverEntry>) {
entries.forEach(entry => {
if (entry.isIntersecting) {
debounce(this.loadMore.bind(this), INFINITE_SCROLL_DEBOUNCE_RATE);
}
});
}

onStartIntersection(entries: Array<IntersectionObserverEntry>) {
entries.forEach(entry => {
this._startMarkerOutOfView = !entry.isIntersecting;
});
}

/*
* ITEM SELECTION BASED ON THE CURRENT MODE
*/
Expand Down Expand Up @@ -1444,17 +1447,27 @@ class List extends UI5Element {
}

getIntersectionObserver() {
if (!this.growingIntersectionObserver) {
const scrollContainer = this.scrollContainer || findVerticalScrollContainer(this.getDomRef()!);
if (!this._endIntersectionObserver) {
this._endIntersectionObserver = new IntersectionObserver(this.onEndIntersection.bind(this), {
root: null, // null means the viewport
rootMargin: "0px",
threshold: 1.0,
});
}

return this._endIntersectionObserver;
}

this.growingIntersectionObserver = new IntersectionObserver(this.onInteresection.bind(this), {
root: scrollContainer,
rootMargin: "5px",
get_StartIntersectionObserver() {
if (!this._startIntersectionObserver) {
this._startIntersectionObserver = new IntersectionObserver(this.onStartIntersection.bind(this), {
root: null, // null means the viewport
rootMargin: "0px",
threshold: 1.0,
});
}

return this.growingIntersectionObserver;
return this._startIntersectionObserver;
}
}

Expand Down
3 changes: 3 additions & 0 deletions packages/main/src/ListTemplate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ export default function ListTemplate(this: List) {
active={this.showBusyIndicatorOverlay}
class="ui5-list-busy-indicator"
>

<div class="ui5-list-scroll-container">
<span tabindex={-1} aria-hidden="true" class="ui5-list-start-marker"></span>

{this.header.length > 0 && <slot name="header" />}

{this.shouldRenderH1 &&
Expand Down
Loading