diff --git a/.cspell.json b/.cspell.json index 60e4b4b..3947b17 100644 --- a/.cspell.json +++ b/.cspell.json @@ -1,5 +1,5 @@ { "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json", "import": "@kitschpatrol/cspell-config", - "words": ["borked", "discoverability", "pangenerator", "playform"] + "words": ["borked", "discoverability", "gzipped", "pangenerator", "playform"] } diff --git a/docs/src/content/docs/docs/plugins.mdx b/docs/src/content/docs/docs/plugins.mdx index a6188b8..74145ff 100644 --- a/docs/src/content/docs/docs/plugins.mdx +++ b/docs/src/content/docs/docs/plugins.mdx @@ -20,10 +20,9 @@ _Svelte Tweakpane UI_ takes a slightly different approach to plugins than the un To keep bundle size down, it's recommended to use [per-component imports](/svelte-tweakpane-ui/docs#importing-components) when you're ready to go to production. -Many of the most popular Tweakpane plugins are already bundled with _Svelte Tweakpane UI_, and have been "wrapped" according to the conventions of the library. Plugins _**not**_ currently bundled with the _Svelte Tweakpane UI_ library _**will not work**_ seamlessly unless they are explicitly wrapped. +Many of the most popular Tweakpane plugins are already bundled with _Svelte Tweakpane UI_, and have been "wrapped" according to the conventions of the library. Plugins **_not_** currently bundled with the _Svelte Tweakpane UI_ library **_will not work_** seamlessly unless they are explicitly wrapped. :::note[Implicit vs. Explicit Controls] - _Svelte Tweakpane UI_'s approach to structuring a component library is a subtle inversion of the underlying vanilla Tweakpane design. For the most part, vanilla Tweakpane "picks" a component for you based on the type of the value you want to control (or the shape of an object you want to control, in more complex cases). It uses the value's type information — in combination with its internal plugin system — to provide a slider, or a color picker, or a text field. The value type drives the control type. You can still achieve this behavior in _Svelte Tweakpane UI_ through components like `` and ``, but in most cases _Svelte Tweakpane UI_ is designed to make the component choice explicit (e.g. not just an abstract ``, but a concrete ``), and enforce that the value bound to the control is of an appropriate type. The kind of control you're getting is promised explicitly through its name, not implicitly through the type of value under its control. @@ -82,20 +81,36 @@ The result should be the same: The following plugins are included with _Svelte Tweakpane UI_, and are ready to use out of the box: -| Plugin | Components | -| --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [CameraKit](https://github.com/tweakpane/plugin-camerakit) | ``, `` | -| [Essentials](https://github.com/tweakpane/plugin-essentials) | ``, ``, ``, ``, `` | -| [Image](https://github.com/kitschpatrol/tweakpane-image-plugin) | `` _(forked from [ayamflow](https://github.com/ayamflow/tweakpane-image-plugin), [metehus](https://github.com/metehus/tweakpane-image-plugin), and [repalash](https://github.com/repalash/tweakpane-image-plugin) and ported to v4)\*_ | -| [Profiler](https://github.com/0b5vr/tweakpane-plugin-profiler) | `` | -| [Rotation](https://github.com/0b5vr/tweakpane-plugin-rotation) | ``, `` | -| [Textarea](https://github.com/panGenerator/tweakpane-textarea-plugin) | `