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

docs(configuration): disabling the GUI #448

Merged
merged 1 commit into from
Jan 22, 2025
Merged

docs(configuration): disabling the GUI #448

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
25 changes: 25 additions & 0 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,28 @@ export default function MyApp() {
```

- TODO // Add default config for LevaPanel as well

### Disabling the GUI

Each instance of the `useControls` hook will render the panel. If you want to completely disable the GUI based on preferences, you need to explicitly set `hidden` to false.

```jsx
import { Leva } from 'leva'

function MyComponent() {
const { myValue } = useControls({ myValue: 10 }) // Won't be visible because the panel will not render.

return myValue
}

export default function MyApp() {
return (
<>
<Leva
{...config}
hidden={false}
/>
</>
)
}
```