Skip to content

Duplicated GUI with vite + react + three.js #323

Open

Description

@Creative-Ataraxia

I'm trying to use dat.gui with vite + react + tailwind + three.js:

function App() {
  useEffect(() => {
    const gui = new dat.GUI({ width: 400 })
    gui.add(..etc..)

  return (
    <>
      <canvas className='fixed top-0 left-0 outline-none' id="MyCanvas" />
    </>
  )
}

but the gui is duplicated, showing another panel on the back:
1
and if I click on open, it will open two sets of controls like so:
2
one set of control do work as intended, the other set does not work at all;

I've tried to pass the autoPlace: false but then the gui won't show up at all anymore

any help is much appreciated

edit:
also each time vite re-render's the page, a new set of gui is added to the viewport:
3
so it will become unusable like this:
4

do I have to unmount gui after each render somehow?
btw, I'm putting all the three.js code in a useEffect() hook to be able to render it via react..

edit2:
so on a first glance this seeks to be an issue of gui.dat not dismounting and/or removing the last <div> created on the dom when vite rebuilds the build as I save code changes in the IDE;
does dat.gui have a built-in API to remove the last created DOM element?

Activity

  1. rickyzhangca commented on Apr 1, 2023

    @rickyzhangca

    can confirm this happening on vite + react

  2. lesha-co commented on Dec 2, 2023

    @lesha-co

    or you can put gui in a ref
    or you can call gui.destroy() in useEffect return (just make sure it doesn't trigger unless needed to)

    anyway this looks more like react issue than library issue

  3. Kvisaz commented on Dec 24, 2023

    @Kvisaz

    It is normal behavior for useEffect with creation/subscription

    To avoid bugs - always use return in useEffect

    We need return some callback to unsubscribe, to destroy etc....

    useEffect(() => {
        const gui = new dat.GUI({ width: 400 })
        gui.add(..etc..)
        return ()=> gui.destroy()
      }  
        ```
    
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions