Skip to content

Commit

Permalink
feat: remove tweakpane deps from final bundle (#169)
Browse files Browse the repository at this point in the history
  • Loading branch information
alvarosabu committed Aug 17, 2023
1 parent 66d1c9b commit b99ac3c
Show file tree
Hide file tree
Showing 4 changed files with 3,526 additions and 2,715 deletions.
17 changes: 17 additions & 0 deletions docs/guide/misc/use-tweakpane.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,23 @@

[TweakPane](https://cocopon.github.io/tweakpane/) is a JavaScript library for creating a user interface for tweaking values of JavaScript variables. It's a great tool for fine-tuning parameters and monitoring value changes on your three.js applications.

::: code-group

```bash [pnpm]
pnpm add @tweakpane/core @tweakpane/essentials -D
```

```bash [npm]
npm install @tweakpane/core @tweakpane/essentials -D

```

```bash [yarn]
yarn add @tweakpane/core @tweakpane/plugin-essentials -D
```

:::

**TresJS** provides a composables called `useTweakPane` that creates a Tweakpane panel to your container so you can add tweaks to it. By default, the panel is created on the top right corner of the canvas and includes a FPS graph monitor to keep and eye on the performance of your scene.

::: info
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@
},
"peerDependencies": {
"three": ">=0.133",
"vue": ">=3.3"
"vue": ">=3.3",
"tweakpane": ">=4.0.0"
},
"devDependencies": {
"@alvarosabu/prettier-config": "^1.3.0",
Expand Down
Loading

0 comments on commit b99ac3c

Please sign in to comment.