svelte-tweakpane-ui 1.5.16 → 1.5.17

package/dist/control/Button.svelte

@@ -17,7 +17,9 @@
 	let button
 	let index
 	function create() {
-		if (button) button.dispose()
+		if (button) {
+			button.dispose()
+		}
 		button = $parentStore?.addButton({
 			disabled,
 			index,

package/dist/control/Button.svelte.d.ts

@@ -5,28 +5,34 @@ declare const __propDef: {
 	props: {
 		/**
 		 * Text inside of the button.
+		 *
 		 * @default `'Button'`
 		 */ title?: string
 		/**
 		 * Text displayed next to the button.
+		 *
 		 * @default `undefined`
 		 */ label?: string | undefined
 		/**
 		 * Prevent interactivity and gray out the control.
+		 *
 		 * @default `false`
 		 */ disabled?: boolean
 		/**
 		 * Custom color scheme.
-		 * @default `undefined`  \
+		 *
 		 * Inherits default Tweakpane theme equivalent to
 		 * `ThemeUtils.presets.standard`, or the theme set with
 		 * `setGlobalDefaultTheme()`.)
+		 *
+		 * @default `undefined`
 		 */ theme?: Theme | undefined
 	}
 	slots: {}
 	events: {
 		/**
 		 * Fires when the button is clicked.
+		 *
 		 * @event
 		 */
 		click: ButtonClickEvent

package/dist/control/ButtonGrid.svelte.d.ts

@@ -15,41 +15,50 @@ declare const __propDef: {
 			/**
 			 * Blade configuration exposing Tweakpane's internal
 			 * [`BladeParams`](https://tweakpane.github.io/docs/api/interfaces/BaseBladeParams.html).
-			 *
 			 */
 			options: ButtonGridOptions
 			/**
 			 * Prevent interactivity and gray out the control.
+			 *
 			 * @default `false`
 			 */
 			disabled?: boolean
 			/**
 			 * Custom color scheme.
-			 * @default `undefined`  \
-			 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
-			 * set with `setGlobalDefaultTheme()`.
+			 *
+			 * If undefined, inherits default Tweakpane theme equivalent to
+			 * `ThemeUtils.presets.standard`, or the theme set with
+			 * `setGlobalDefaultTheme()`.
+			 *
+			 * @default `undefined`
 			 */
 			theme?: import('..').Theme | undefined
 			/**
 			 * Reference to internal Tweakpane
-			 * [`BladeApi`](https://tweakpane.github.io/docs/api/classes/BladeApi.html) for this blade.
+			 * [`BladeApi`](https://tweakpane.github.io/docs/api/classes/BladeApi.html)
+			 * for this blade.
+			 *
+			 * This property is exposed for advanced use cases only, such as when
+			 * implementing convenience components wrapping `<Blade>`'s functionality.
 			 *
-			 * This property is exposed for advanced use cases only, such as when implementing convenience
-			 * components wrapping `<Blade>`'s functionality.
+			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane
+			 * UI_ abstractions.
 			 *
-			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
 			 * @bindable
 			 * @readonly
 			 */
 			ref?: ButtonGridRef | undefined
 			/**
-			 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
-			 * the `<Blade>`'s containing `<Pane>`.
+			 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to
+			 * automatically register in the `<Blade>`'s containing `<Pane>`.
+			 *
+			 * This property is exposed for advanced use cases only, such as when
+			 * implementing convenience components wrapping `<Blade>`'s functionality in
+			 * combination with a Tweakpane plugin.
 			 *
-			 * This property is exposed for advanced use cases only, such as when implementing convenience
-			 * components wrapping `<Blade>`'s functionality in combination with a Tweakpane plugin.
+			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane
+			 * UI_ abstractions.
 			 *
-			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
 			 * @default `undefined`
 			 */
 			plugin?: import('../utils.js').Plugin | undefined
@@ -57,30 +66,34 @@ declare const __propDef: {
 		'ref' | 'options' | 'plugin'
 	> & {
 		/**
-		 * Array of names, each of which will become the title of a button in the grid.
+		 * Array of names, each of which will become the title of a button in the
+		 * grid.
 		 */
 		buttons: string[]
 		/**
 		 * Number of columns to arrange the buttons into.
 		 *
-		 * Setting `columns` without setting `rows` will lock the column count and allow the row
-		 * count to change dynamically based on the number of buttons.
-		 * @default `undefined`  \
-		 * Dynamic based on quantity of `buttons`.
+		 * Setting `columns` without setting `rows` will lock the column count and
+		 * allow the row count to change dynamically based on the number of
+		 * buttons.
+		 *
+		 * @default `undefined`
 		 */
 		columns?: number
 		/**
 		 * Text displayed next to the button grid.
+		 *
 		 * @default `undefined`
 		 */
 		label?: string
 		/**
 		 * Number of rows to arrange the buttons into.
 		 *
-		 * Setting `rows` without setting `columns` will lock the column count and allow the column
-		 * count to change dynamically based on the number of buttons.
-		 * @default `undefined`  \
-		 * Dynamic based on quantity of `buttons`.
+		 * Setting `rows` without setting `columns` will lock the column count and
+		 * allow the column count to change dynamically based on the number of
+		 * buttons.
+		 *
+		 * @default `undefined`
 		 */
 		rows?: number
 	}
@@ -89,8 +102,9 @@ declare const __propDef: {
 		/**
 		 * Fires when a button is clicked.
 		 *
-		 * Note that the values described in the `ButtonGridClickEvent` type are available on the
-		 * `event.detail` parameter.
+		 * Note that the values described in the `ButtonGridClickEvent` type are
+		 * available on the `event.detail` parameter.
+		 *
 		 * @event
 		 */
 		click: ButtonGridClickEvent

package/dist/control/Checkbox.svelte.d.ts

@@ -7,62 +7,79 @@ declare const __propDef: {
 			{
 				/**
 				 * The binding's target object with values to manipulate.
+				 *
 				 * @bindable
 				 */
 				object: import('@tweakpane/core').Bindable & Record<string, boolean>
-				/** The key for the value in the target `object` that the control should manipulate. */
+				/**
+				 * The key for the value in the target `object` that the control should
+				 * manipulate.
+				 */
 				key: string
 				/**
 				 * Prevent interactivity and gray out the control.
+				 *
 				 * @default `false`
 				 */
 				disabled?: boolean
 				/**
 				 * Text displayed next to control.
+				 *
 				 * @default `undefined`
 				 */
 				label?: string | undefined
 				/**
 				 * Tweakpane's internal options object.
 				 *
-				 * See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
+				 * See
+				 * [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
+				 *
+				 * Valid types are contingent on the type of the value `key` points to in
+				 * `object`.
 				 *
-				 * Valid types are contingent on the type of the value `key` points to in `object`.
+				 * This is intended internal use, when implementing convenience components
+				 * wrapping Binding's functionality. Options of interest are instead exposed
+				 * as top-level props in _Svelte Tweakpane UI_.
 				 *
-				 * This is intended internal use, when implementing convenience components wrapping Binding's
-				 * functionality. Options of interest are instead exposed as top-level props in _Svelte
-				 * Tweakpane UI_.
 				 * @default `undefined`
 				 */
 				options?: import('@tweakpane/core').BaseInputParams | undefined
 				/**
 				 * Custom color scheme.
-				 * @default `undefined`  \
-				 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
-				 * set with `setGlobalDefaultTheme()`.
+				 *
+				 * If undefined, inherits default Tweakpane theme equivalent to
+				 * `ThemeUtils.presets.standard`, or the theme set with
+				 * `setGlobalDefaultTheme()`.
+				 *
+				 * @default `undefined`
 				 */
 				theme?: import('..').Theme | undefined
 				/**
 				 * Reference to internal Tweakpane
-				 * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
-				 * this control.
+				 * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html)
+				 * for this control.
 				 *
-				 * This property is exposed for advanced use cases only, such as when implementing convenience
-				 * components wrapping `<Binding>`'s functionality.
+				 * This property is exposed for advanced use cases only, such as when
+				 * implementing convenience components wrapping `<Binding>`'s functionality.
+				 *
+				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane
+				 * UI_ abstractions.
 				 *
-				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
 				 * @bindable
 				 * @readonly
 				 */
 				ref?: import('../internal/GenericInput.svelte').GenericInputRef | undefined
 				/**
-				 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
-				 * the `<Binding>`'s containing `<Pane>`.
+				 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to
+				 * automatically register in the `<Binding>`'s containing `<Pane>`.
+				 *
+				 * This property is exposed for advanced use cases only, such as when
+				 * implementing convenience components wrapping `<Binding>`'s functionality in
+				 * combination with a Tweakpane plugin.
 				 *
-				 * This property is exposed for advanced use cases only, such as when implementing convenience
-				 * components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
+				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane
+				 * UI_ abstractions.
 				 *
-				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
 				 * @default `undefined`
 				 */
 				plugin?: import('../utils.js').Plugin | undefined
@@ -71,6 +88,7 @@ declare const __propDef: {
 		> & {
 			/**
 			 * The value to control.
+			 *
 			 * @bindable
 			 */
 			value: boolean
@@ -82,10 +100,14 @@ declare const __propDef: {
 		/**
 		 * Fires when `value` changes.
 		 *
-		 * _This event is provided for advanced use cases. It's usually preferred to bind to the `value` prop instead._
+		 * _This event is provided for advanced use cases. It's usually preferred to
+		 * bind to the `value` prop instead._
+		 *
+		 * The `event.details` payload includes a copy of the value and an `origin`
+		 * field to distinguish between user-interactive changes (`internal`) and
+		 * changes resulting from programmatic manipulation of the `value`
+		 * (`external`).
 		 *
-		 * The `event.details` payload includes a copy of the value and an `origin` field to distinguish between user-interactive changes (`internal`)
-		 * and changes resulting from programmatic manipulation of the `value` (`external`).
 		 * @extends ValueChangeEvent
 		 * @event
 		 */
@@ -107,9 +129,9 @@ export type CheckboxSlots = typeof __propDef.slots
  * @example
  * ```svelte
  * <script lang="ts">
- *  import { Checkbox } from 'svelte-tweakpane-ui'
+ * import { Checkbox } from 'svelte-tweakpane-ui'
  *
- *  let reticulationEnabled: boolean = false
+ * let reticulationEnabled: boolean = false
  * </script>
  *
  * <Checkbox bind:value={reticulationEnabled} label="Reticulation" />

package/dist/control/Color.svelte.d.ts

@@ -24,62 +24,79 @@ declare const __propDef: {
 			{
 				/**
 				 * The binding's target object with values to manipulate.
+				 *
 				 * @bindable
 				 */
 				object: import('@tweakpane/core').Bindable & Record<string, ColorValue>
-				/** The key for the value in the target `object` that the control should manipulate. */
+				/**
+				 * The key for the value in the target `object` that the control should
+				 * manipulate.
+				 */
 				key: string
 				/**
 				 * Prevent interactivity and gray out the control.
+				 *
 				 * @default `false`
 				 */
 				disabled?: boolean
 				/**
 				 * Text displayed next to control.
+				 *
 				 * @default `undefined`
 				 */
 				label?: string | undefined
 				/**
 				 * Tweakpane's internal options object.
 				 *
-				 * See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
+				 * See
+				 * [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
 				 *
-				 * Valid types are contingent on the type of the value `key` points to in `object`.
+				 * Valid types are contingent on the type of the value `key` points to in
+				 * `object`.
+				 *
+				 * This is intended internal use, when implementing convenience components
+				 * wrapping Binding's functionality. Options of interest are instead exposed
+				 * as top-level props in _Svelte Tweakpane UI_.
 				 *
-				 * This is intended internal use, when implementing convenience components wrapping Binding's
-				 * functionality. Options of interest are instead exposed as top-level props in _Svelte
-				 * Tweakpane UI_.
 				 * @default `undefined`
 				 */
 				options?: ColorOptions | undefined
 				/**
 				 * Custom color scheme.
-				 * @default `undefined`  \
-				 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
-				 * set with `setGlobalDefaultTheme()`.
+				 *
+				 * If undefined, inherits default Tweakpane theme equivalent to
+				 * `ThemeUtils.presets.standard`, or the theme set with
+				 * `setGlobalDefaultTheme()`.
+				 *
+				 * @default `undefined`
 				 */
 				theme?: import('..').Theme | undefined
 				/**
 				 * Reference to internal Tweakpane
-				 * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
-				 * this control.
+				 * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html)
+				 * for this control.
+				 *
+				 * This property is exposed for advanced use cases only, such as when
+				 * implementing convenience components wrapping `<Binding>`'s functionality.
 				 *
-				 * This property is exposed for advanced use cases only, such as when implementing convenience
-				 * components wrapping `<Binding>`'s functionality.
+				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane
+				 * UI_ abstractions.
 				 *
-				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
 				 * @bindable
 				 * @readonly
 				 */
 				ref?: import('../internal/GenericInput.svelte').GenericInputRef | undefined
 				/**
-				 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
-				 * the `<Binding>`'s containing `<Pane>`.
+				 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to
+				 * automatically register in the `<Binding>`'s containing `<Pane>`.
 				 *
-				 * This property is exposed for advanced use cases only, such as when implementing convenience
-				 * components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
+				 * This property is exposed for advanced use cases only, such as when
+				 * implementing convenience components wrapping `<Binding>`'s functionality in
+				 * combination with a Tweakpane plugin.
+				 *
+				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane
+				 * UI_ abstractions.
 				 *
-				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
 				 * @default `undefined`
 				 */
 				plugin?: import('../utils.js').Plugin | undefined
@@ -89,30 +106,36 @@ declare const __propDef: {
 			/**
 			 * A color value to control.
 			 *
-			 * Use either a color-like string (e.g. #ff00ff), or an object with `r`, `b`, `g`, and
-			 * optional `a` keys.
+			 * Use either a color-like string (e.g. #ff00ff), or an object with `r`,
+			 * `b`, `g`, and optional `a` keys.
+			 *
 			 * @bindable
 			 */
 			value: ColorValue
 		} & {
 			/**
-			 * DOM class name of the button used to expand and collapse the input's picker.
+			 * DOM class name of the button used to expand and collapse the input's
+			 * picker.
+			 *
 			 * @default `undefined`
 			 */
 			buttonClass?: string
 			/**
 			 * Expand or collapse the input's picker.
+			 *
 			 * @default `false`
 			 * @bindable
 			 */
 			expanded?: boolean
 			/**
 			 * The style of value "picker" to use in the input.
+			 *
 			 * @default `'popup'`
 			 */
 			picker?: 'inline' | 'popup'
 			/**
 			 * Allow users to interactively expand / contract the picker.
+			 *
 			 * @default `true`
 			 */
 			userExpandable?: boolean
@@ -122,13 +145,16 @@ declare const __propDef: {
 		/**
 		 * A color value to control.
 		 *
-		 * Use either a color-like string (e.g. #ff00ff), or an object with `r`, `b`, `g`, and
-		 * optional `a` keys.
+		 * Use either a color-like string (e.g. #ff00ff), or an object with `r`,
+		 * `b`, `g`, and optional `a` keys.
+		 *
 		 * @bindable
 		 */
 		value: ColorValue
 		/**
-		 * Whether to treat values as floats from 0.0 to 1.0, or integers from 0 to 255.
+		 * Whether to treat values as floats from 0.0 to 1.0, or integers from 0 to
+		 * 255.
+		 *
 		 * @default `'int'`
 		 */
 		type?: 'float' | 'int'
@@ -138,10 +164,14 @@ declare const __propDef: {
 		/**
 		 * Fires when `value` changes.
 		 *
-		 * _This event is provided for advanced use cases. It's usually preferred to bind to the `value` prop instead._
+		 * _This event is provided for advanced use cases. It's usually preferred to
+		 * bind to the `value` prop instead._
+		 *
+		 * The `event.details` payload includes a copy of the value and an `origin`
+		 * field to distinguish between user-interactive changes (`internal`) and
+		 * changes resulting from programmatic manipulation of the `value`
+		 * (`external`).
 		 *
-		 * The `event.details` payload includes a copy of the value and an `origin` field to distinguish between user-interactive changes (`internal`)
-		 * and changes resulting from programmatic manipulation of the `value` (`external`).
 		 * @extends ValueChangeEvent
 		 * @event
 		 */

package/dist/control/CubicBezier.svelte.d.ts

@@ -17,65 +17,80 @@ declare const __propDef: {
 			/**
 			 * Blade configuration exposing Tweakpane's internal
 			 * [`BladeParams`](https://tweakpane.github.io/docs/api/interfaces/BaseBladeParams.html).
-			 *
 			 */
 			options: CubicBezierOptions
 			/**
 			 * Prevent interactivity and gray out the control.
+			 *
 			 * @default `false`
 			 */
 			disabled?: boolean
 			/**
 			 * Custom color scheme.
-			 * @default `undefined`  \
-			 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
-			 * set with `setGlobalDefaultTheme()`.
+			 *
+			 * If undefined, inherits default Tweakpane theme equivalent to
+			 * `ThemeUtils.presets.standard`, or the theme set with
+			 * `setGlobalDefaultTheme()`.
+			 *
+			 * @default `undefined`
 			 */
 			theme?: import('..').Theme | undefined
 			/**
 			 * Reference to internal Tweakpane
-			 * [`BladeApi`](https://tweakpane.github.io/docs/api/classes/BladeApi.html) for this blade.
+			 * [`BladeApi`](https://tweakpane.github.io/docs/api/classes/BladeApi.html)
+			 * for this blade.
+			 *
+			 * This property is exposed for advanced use cases only, such as when
+			 * implementing convenience components wrapping `<Blade>`'s functionality.
 			 *
-			 * This property is exposed for advanced use cases only, such as when implementing convenience
-			 * components wrapping `<Blade>`'s functionality.
+			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane
+			 * UI_ abstractions.
 			 *
-			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
 			 * @bindable
 			 * @readonly
 			 */
 			ref?: CubicBezierRef | undefined
 			/**
-			 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
-			 * the `<Blade>`'s containing `<Pane>`.
+			 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to
+			 * automatically register in the `<Blade>`'s containing `<Pane>`.
+			 *
+			 * This property is exposed for advanced use cases only, such as when
+			 * implementing convenience components wrapping `<Blade>`'s functionality in
+			 * combination with a Tweakpane plugin.
 			 *
-			 * This property is exposed for advanced use cases only, such as when implementing convenience
-			 * components wrapping `<Blade>`'s functionality in combination with a Tweakpane plugin.
+			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane
+			 * UI_ abstractions.
 			 *
-			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
 			 * @default `undefined`
 			 */
 			plugin?: import('../utils.js').Plugin | undefined
 		} & {
 			/**
-			 * DOM class name of the button used to expand and collapse the blade's picker.
+			 * DOM class name of the button used to expand and collapse the blade's
+			 * picker.
+			 *
 			 * @default `undefined`
 			 */
 			buttonClass?: string
 			/**
 			 * Expand or collapse the blade's picker.
+			 *
 			 * @default `true`
 			 * @bindable
 			 */
 			expanded?: boolean
 			/**
 			 * The style of value "picker" to use in the blade.
+			 *
 			 * @default `'popup'`
 			 */
 			picker?: 'inline' | 'popup'
 			/**
-			 * Allow users to interactively expand / contract the value picker by clicking its icon.
+			 * Allow users to interactively expand / contract the value picker by
+			 * clicking its icon.
 			 *
 			 * Most useful when `picker` is `inline`.
+			 *
 			 * @default `true`
 			 */
 			userExpandable?: boolean
@@ -85,13 +100,15 @@ declare const __propDef: {
 		/**
 		 * The cubic bezier value to control.
 		 *
-		 * Object value type is a convenience added by _Svelte Tweakpane UI_, and is not part of the
-		 * original `@tweakpane/plugin-essentials` API.
+		 * Object value type is a convenience added by _Svelte Tweakpane UI_, and is
+		 * not part of the original `@tweakpane/plugin-essentials` API.
+		 *
 		 * @bindable
 		 */
 		value: CubicBezierValue
 		/**
 		 * Text displayed next to the control.
+		 *
 		 * @default `undefined`
 		 */
 		label?: string
@@ -101,10 +118,14 @@ declare const __propDef: {
 		/**
 		 * Fires when `value` changes.
 		 *
-		 * _This event is provided for advanced use cases. It's usually preferred to bind to the `value` prop instead._
+		 * _This event is provided for advanced use cases. It's usually preferred to
+		 * bind to the `value` prop instead._
+		 *
+		 * The `event.details` payload includes a copy of the value and an `origin`
+		 * field to distinguish between user-interactive changes (`internal`) and
+		 * changes resulting from programmatic manipulation of the `value`
+		 * (`external`).
 		 *
-		 * The `event.details` payload includes a copy of the value and an `origin` field to distinguish between user-interactive changes (`internal`)
-		 * and changes resulting from programmatic manipulation of the `value` (`external`).
 		 * @extends ValueChangeEvent
 		 * @event
 		 */