Skip to content
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

fix(virtual-core): add support to multi window #738

Merged
merged 4 commits into from
Jun 5, 2024
Merged

fix(virtual-core): add support to multi window #738

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5488893
add fix to globals that are problematic when using multiple windows
YuanboXue-Amber Jun 3, 2024
31ac3e4
use instance.targetWindow
YuanboXue-Amber Jun 4, 2024
4d2088f
apply code review
YuanboXue-Amber Jun 4, 2024
8a60b26
apply suggestions
YuanboXue-Amber Jun 5, 2024
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
67 changes: 48 additions & 19 deletions packages/virtual-core/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ export const observeElementRect = <T extends Element>(
if (!element) {
return
}
const targetWindow = element.ownerDocument.defaultView
piecyk marked this conversation as resolved.
Show resolved Hide resolved
if (!targetWindow) {
return
}

const handler = (rect: Rect) => {
const { width, height } = rect
Expand All @@ -79,7 +83,7 @@ export const observeElementRect = <T extends Element>(
return () => {}
}

const observer = new ResizeObserver((entries) => {
const observer = new targetWindow.ResizeObserver((entries) => {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also check if ResizeObserver is on targetWindow

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here it should be guarded by type as well. (If you meant by checking if (targetWindow.ResizeObserver))

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, same as in comment below, we check if ResizeObserver is on global context on L82, but the create instance on targetWindow

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated :) could you give it one more round of review

const entry = entries[0]
if (entry?.borderBoxSize) {
const box = entry.borderBoxSize[0]
Expand Down Expand Up @@ -134,13 +138,21 @@ export const observeElementOffset = <T extends Element>(
if (!element) {
return
}
const targetWindow = element.ownerDocument.defaultView
YuanboXue-Amber marked this conversation as resolved.
Show resolved Hide resolved
if (!targetWindow) {
return
}

let offset = 0
const fallback = supportsScrollend
? () => undefined
: debounce(() => {
cb(offset, false)
}, instance.options.isScrollingResetDelay)
: debounce(
targetWindow,
() => {
cb(offset, false)
},
instance.options.isScrollingResetDelay,
)

const createHandler = (isScrolling: boolean) => () => {
offset = element[instance.options.horizontal ? 'scrollLeft' : 'scrollTop']
Expand Down Expand Up @@ -168,13 +180,21 @@ export const observeWindowOffset = (
if (!element) {
return
}
const targetWindow = element.window
YuanboXue-Amber marked this conversation as resolved.
Show resolved Hide resolved
if (!targetWindow) {
return
}

let offset = 0
const fallback = supportsScrollend
? () => undefined
: debounce(() => {
cb(offset, false)
}, instance.options.isScrollingResetDelay)
: debounce(
targetWindow,
() => {
cb(offset, false)
},
instance.options.isScrollingResetDelay,
)

const createHandler = (isScrolling: boolean) => () => {
offset = element[instance.options.horizontal ? 'scrollX' : 'scrollY']
Expand Down Expand Up @@ -307,8 +327,9 @@ export class Virtualizer<
private unsubs: (void | (() => void))[] = []
options!: Required<VirtualizerOptions<TScrollElement, TItemElement>>
scrollElement: TScrollElement | null = null
private targetWindow: (Window & typeof globalThis) | null = null
piecyk marked this conversation as resolved.
Show resolved Hide resolved
isScrolling: boolean = false
private scrollToIndexTimeoutId: ReturnType<typeof setTimeout> | null = null
private scrollToIndexTimeoutId: number | null = null
measurementsCache: VirtualItem[] = []
private itemSizeCache = new Map<Key, number>()
private pendingMeasuredCacheIndexes: number[] = []
Expand All @@ -330,15 +351,17 @@ export class Virtualizer<
const get = () => {
if (_ro) {
return _ro
} else if (typeof ResizeObserver !== 'undefined') {
return (_ro = new ResizeObserver((entries) => {
entries.forEach((entry) => {
this._measureElement(entry.target as TItemElement, entry)
})
}))
} else {
}

if (typeof ResizeObserver === 'undefined' || !this.targetWindow) {
piecyk marked this conversation as resolved.
Show resolved Hide resolved
return null
}

return (_ro = new this.targetWindow.ResizeObserver((entries) => {
entries.forEach((entry) => {
this._measureElement(entry.target as TItemElement, entry)
})
}))
}

return {
Expand Down Expand Up @@ -432,6 +455,12 @@ export class Virtualizer<

this.scrollElement = scrollElement

if (this.scrollElement && 'ownerDocument' in this.scrollElement) {
this.targetWindow = this.scrollElement.ownerDocument.defaultView
} else {
this.targetWindow = this.scrollElement?.window ?? null
}

this._scrollToOffset(this.scrollOffset, {
adjustments: undefined,
behavior: undefined,
Expand Down Expand Up @@ -807,8 +836,8 @@ export class Virtualizer<
private isDynamicMode = () => this.measureElementCache.size > 0

private cancelScrollToIndex = () => {
if (this.scrollToIndexTimeoutId !== null) {
clearTimeout(this.scrollToIndexTimeoutId)
if (this.scrollToIndexTimeoutId !== null && this.targetWindow) {
this.targetWindow.clearTimeout(this.scrollToIndexTimeoutId)
this.scrollToIndexTimeoutId = null
}
}
Expand Down Expand Up @@ -849,8 +878,8 @@ export class Virtualizer<

this._scrollToOffset(toOffset, { adjustments: undefined, behavior })

if (behavior !== 'smooth' && this.isDynamicMode()) {
this.scrollToIndexTimeoutId = setTimeout(() => {
if (behavior !== 'smooth' && this.isDynamicMode() && this.targetWindow) {
this.scrollToIndexTimeoutId = this.targetWindow.setTimeout(() => {
this.scrollToIndexTimeoutId = null

const elementInDOM = this.measureElementCache.has(
Expand Down
12 changes: 8 additions & 4 deletions packages/virtual-core/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,14 @@ export function notUndefined<T>(value: T | undefined, msg?: string): T {

export const approxEqual = (a: number, b: number) => Math.abs(a - b) < 1

export const debounce = (fn: Function, ms: number) => {
let timeoutId: ReturnType<typeof setTimeout>
export const debounce = (
targetWindow: Window & typeof globalThis,
fn: Function,
ms: number,
) => {
let timeoutId: number
return function (this: any, ...args: any[]) {
clearTimeout(timeoutId)
timeoutId = setTimeout(() => fn.apply(this, args), ms)
targetWindow.clearTimeout(timeoutId)
timeoutId = targetWindow.setTimeout(() => fn.apply(this, args), ms)
}
}