Skip to content

Adding keepAliveOnHidden option to keep items mounted in case of a tab switch, e.g., in ion-tabs. #1104

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
j4hangir wants to merge 4 commits into
base: main
Choose a base branch
from
+16 −0
Open

Adding keepAliveOnHidden option to keep items mounted in case of a tab switch, e.g., in ion-tabs. #1104

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dc2c5f4
add keepAliveOnHidden option in order to prevent mount/unmount on vis…
j4hangir Jan 2, 2026
aff6e4f
remove broken return
j4hangir Jan 2, 2026
fde6c64
fix keepAliveOnHidden
j4hangir Jan 2, 2026
83ad2f6
fix keepActiveOnHidden not working on measured items
j4hangir Jan 3, 2026
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
16 changes: 16 additions & 0 deletions packages/virtual-core/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,7 @@ export interface VirtualizerOptions<
enabled?: boolean
isRtl?: boolean
useAnimationFrameWithResizeObserver?: boolean
keepAliveOnHidden?: boolean
}

export class Virtualizer<
Expand Down Expand Up @@ -447,6 +448,7 @@ export class Virtualizer<
isRtl: false,
useScrollendEvent: false,
useAnimationFrameWithResizeObserver: false,
keepAliveOnHidden: false,
...opts,
}
}
Expand Down Expand Up @@ -793,6 +795,14 @@ export class Virtualizer<
},
)

private isVisible = () => {
if (!this.scrollElement) return false
return (
this.scrollElement instanceof Window ||
(this.scrollElement as HTMLElement).offsetWidth > 0
)
}

calculateRange = memo(
() => [
this.getMeasurements(),
Expand All @@ -801,6 +811,9 @@ export class Virtualizer<
this.options.lanes,
],
(measurements, outerSize, scrollOffset, lanes) => {
if (this.options.keepAliveOnHidden && !this.isVisible()) {
return this.range
}
return (this.range =
measurements.length > 0 && outerSize > 0
? calculateRange({
Expand Down Expand Up @@ -869,6 +882,9 @@ export class Virtualizer<
node: TItemElement,
entry: ResizeObserverEntry | undefined,
) => {
if (this.options.keepAliveOnHidden && !this.isVisible()) {
return
}
const index = this.indexFromElement(node)
const item = this.measurementsCache[index]
if (!item) {
Expand Down