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

Jump to bottom

fix: make track prop of View optional #1839

Merged
merged 3 commits into from
Mar 7, 2024
Merged

fix: make track prop of View optional #1839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9d7fc0
fix: make `track` prop of `View` optional
Feb 21, 2024
ba8d03a
fix(View): null check track
CodyJasonBennett Feb 21, 2024
5c84cec
Merge branch 'master' into view-props
drcmda Mar 7, 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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3796,9 +3796,9 @@ export type ViewProps = {
/** The scene to render, if you leave this undefined it will render the default scene */
children?: React.ReactNode
/** The tracking element, the view will be cut according to its whereabouts
* @deprecated
* @deprecated You can use inline Views now, see: https://github.com/pmndrs/drei/pull/1784
*/
track: React.MutableRefObject<HTMLElement>
track?: React.MutableRefObject<HTMLElement>
}

export type ViewportProps = { Port: () => React.ReactNode } & React.ForwardRefExoticComponent<
Expand Down
19 changes: 12 additions & 7 deletions src/web/View.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,10 @@ export type ContainerProps = {
children?: React.ReactNode
frames: number
rect: React.MutableRefObject<DOMRect>
track: React.MutableRefObject<HTMLElement>
/**
* @deprecated You can use inline Views now, see: https://github.com/pmndrs/drei/pull/1784
*/
track?: React.MutableRefObject<HTMLElement>
canvasSize: LegacyCanvasSize | CanvasSize
}

Expand All @@ -57,9 +60,9 @@ export type ViewProps = {
/** The scene to render, if you leave this undefined it will render the default scene */
children?: React.ReactNode
/** The tracking element, the view will be cut according to its whereabouts
* @deprecated
* @deprecated You can use inline Views now, see: https://github.com/pmndrs/drei/pull/1784
*/
track: React.MutableRefObject<HTMLElement>
track?: React.MutableRefObject<HTMLElement>
}

function computeContainerPosition(canvasSize: LegacyCanvasSize | CanvasSize, trackRect: DOMRect) {
Expand Down Expand Up @@ -123,7 +126,7 @@ function Container({ visible = true, canvasSize, scene, index, children, frames,
let frameCount = 0
useFrame((state) => {
if (frames === Infinity || frameCount <= frames) {
rect.current = track.current?.getBoundingClientRect()
if (track) rect.current = track.current?.getBoundingClientRect()
frameCount++
}
if (rect.current) {
Expand All @@ -150,6 +153,8 @@ function Container({ visible = true, canvasSize, scene, index, children, frames,
}, [visible, isOffscreen])

React.useEffect(() => {
if (!track) return

const curRect = rect.current
// Connect the event layer to the tracking element
const old = rootState.get().events.connected
Expand All @@ -163,7 +168,7 @@ function Container({ visible = true, canvasSize, scene, index, children, frames,
}
rootState.setEvents({ connected: old })
}
}, [])
}, [track])

React.useEffect(() => {
if (isNonLegacyCanvasSize(canvasSize)) return
Expand Down Expand Up @@ -194,7 +199,7 @@ const CanvasView = React.forwardRef(

const compute = React.useCallback(
(event, state) => {
if (rect.current && track.current && event.target === track.current) {
if (rect.current && track && track.current && event.target === track.current) {
const { width, height, left, top } = rect.current
const x = event.clientX - left
const y = event.clientY - top
Expand All @@ -207,7 +212,7 @@ const CanvasView = React.forwardRef(

React.useEffect(() => {
// We need the tracking elements bounds beforehand in order to inject it into the portal
rect.current = track.current?.getBoundingClientRect()
if (track) rect.current = track.current?.getBoundingClientRect()
// And now we can proceed
toggle()
}, [track])
Expand Down
Loading