svelte-tweakpane-ui 1.6.0-preview.3 → 1.6.0-preview.5

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

@@ -1,30 +1,81 @@
 import { SvelteComponent } from 'svelte'
-import type { ValueChangeEvent } from '../utils.js'
 import type { SliderInputBindingApi as GenericSliderRef } from 'tweakpane'
+import type { ValueChangeEvent } from '../utils.js'
 export type StepperChangeEvent = ValueChangeEvent<number>
 declare const __propDef: {
-	props: {
-		/**
-		 * A `number` value to control.
-		 * @bindable
-		 * */
-		value: number
-	} & Omit<
-		{
-			/**
-			 * Minimum value.
-			 *
-			 * Specifying both a `min` and a `max` prop turns the control into a slider.
-			 * @default `undefined`
-			 */
-			min?: number
+	props: Omit<
+		Omit<
+			{
+				/**
+				 * The binding's target object with values to manipulate.
+				 * @bindable
+				 */
+				object: import('@tweakpane/core').Bindable & Record<string, number>
+				/** 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).
+				 *
+				 * 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_.
+				 * @default `undefined`
+				 */
+				options?: import('tweakpane').NumberInputParams | undefined
+				/**
+				 * Custom color scheme.
+				 * @default `undefined`  \
+				 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
+				 * set with `setGlobalDefaultTheme()`.
+				 */
+				theme?: import('..').Theme | undefined
+				/**
+				 * Reference to internal Tweakpane
+				 * [`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.
+				 *
+				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
+				 * @bindable
+				 * @readonly
+				 */
+				ref?: GenericSliderRef | undefined
+				/**
+				 * 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.
+				 *
+				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
+				 * @default `undefined`
+				 */
+				plugin?: import('../utils.js').Plugin | undefined
+			},
+			'object' | 'key'
+		> & {
 			/**
-			 * Maximum value.
-			 *
-			 * Specifying both a `min` and a `max` prop turns the control into a slider.
-			 * @default `undefined`
+			 * A `number` value to control.
+			 * @bindable
 			 */
-			max?: number
+			value: number
+		} & {
 			/**
 			 * A function to customize the point value's string representation (e.g. rounding, etc.).
 			 * @default `undefined`  \
@@ -37,6 +88,20 @@ declare const __propDef: {
 			 * Or `stepValue` if defined.
 			 */
 			keyScale?: number
+			/**
+			 * Maximum value.
+			 *
+			 * Specifying both a `min` and a `max` prop turns the control into a slider.
+			 * @default `undefined`
+			 */
+			max?: number
+			/**
+			 * Minimum value.
+			 *
+			 * Specifying both a `min` and a `max` prop turns the control into a slider.
+			 * @default `undefined`
+			 */
+			min?: number
 			/**
 			 * The unit scale for pointer-based input for all dimensions.
 			 * @default `undefined`  \
@@ -56,83 +121,15 @@ declare const __propDef: {
 			 * @default `false`
 			 */
 			wide?: boolean
-		} & {
-			/**
-			 * A `number` value to control.
-			 * @bindable
-			 */
-			value: number
-		} & Omit<
-				{
-					/**
-					 * The binding's target object with values to manipulate.
-					 * @bindable
-					 */
-					object: import('@tweakpane/core').Bindable & Record<string, number>
-					/** 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).
-					 *
-					 * 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_.
-					 * @default `undefined`
-					 */
-					options?: import('tweakpane').NumberInputParams | undefined
-					/**
-					 * Custom color scheme.
-					 *
-					 * @default `undefined`  \
-					 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
-					 * set with `setGlobalDefaultTheme()`.
-					 */
-					theme?: import('..').Theme | undefined
-					/**
-					 * Reference to internal Tweakpane
-					 * [`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.
-					 *
-					 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-					 *
-					 * @bindable
-					 * @readonly
-					 */
-					ref?: GenericSliderRef | undefined
-					/**
-					 * 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.
-					 *
-					 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-					 *
-					 * @default `undefined`
-					 */
-					plugin?: import('../utils.js').Plugin | undefined
-				},
-				'object' | 'key'
-			>,
+		},
 		'ref' | 'options' | 'plugin' | 'amount'
-	>
+	> & {
+		/**
+		 * A `number` value to control.
+		 * @bindable
+		 */
+		value: number
+	}
 	slots: {}
 	events: {
 		/**
@@ -142,10 +139,9 @@ declare const __propDef: {
 		 *
 		 * 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
-		 * */
+		 */
 		change: StepperChangeEvent
 	}
 }

package/dist/control/Text.svelte

@@ -1,8 +1,8 @@
 <script context="module"></script>
 
 <script>
-	import GenericInput from '../internal/GenericInput.svelte'
 	import { onDestroy } from 'svelte'
+	import GenericInput from '../internal/GenericInput.svelte'
 	export let value
 	export let live = true
 	const options = { view: 'text' }

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

@@ -3,28 +3,8 @@ import type { ValueChangeEvent } from '../utils.js'
 export type TextChangeEvent = ValueChangeEvent<string>
 import { type GenericInputRef } from '../internal/GenericInput.svelte'
 declare const __propDef: {
-	props: {
-		/**
-		 * A `string` value to control.
-		 * @bindable
-		 * */
-		value: string
-		/**
-		 * Whether to provide live updates to the bound `value` on every keystroke.
-		 *
-		 * To match expectations around reactive components, the default here diverges from the
-		 * vanilla JS Tweakpane behavior, which only updates on blur.
-		 * @default `true`
-		 * */
-		live?: boolean
-	} & Omit<
-		{
-			/**
-			 * A `string` value to control.
-			 * @bindable
-			 */
-			value: string
-		} & Omit<
+	props: Omit<
+		Omit<
 			{
 				/**
 				 * The binding's target object with values to manipulate.
@@ -58,7 +38,6 @@ declare const __propDef: {
 				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()`.
@@ -73,7 +52,6 @@ declare const __propDef: {
 				 * components wrapping `<Binding>`'s functionality.
 				 *
 				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-				 *
 				 * @bindable
 				 * @readonly
 				 */
@@ -86,15 +64,34 @@ declare const __propDef: {
 				 * components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
 				 *
 				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-				 *
 				 * @default `undefined`
 				 */
 				plugin?: import('../utils.js').Plugin | undefined
 			},
 			'object' | 'key'
-		>,
+		> & {
+			/**
+			 * A `string` value to control.
+			 * @bindable
+			 */
+			value: string
+		},
 		'ref' | 'options' | 'plugin'
-	>
+	> & {
+		/**
+		 * A `string` value to control.
+		 * @bindable
+		 */
+		value: string
+		/**
+		 * Whether to provide live updates to the bound `value` on every keystroke.
+		 *
+		 * To match expectations around reactive components, the default here diverges from the
+		 * vanilla JS Tweakpane behavior, which only updates on blur.
+		 * @default `true`
+		 */
+		live?: boolean
+	}
 	slots: {}
 	events: {
 		/**
@@ -104,10 +101,9 @@ declare const __propDef: {
 		 *
 		 * 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
-		 * */
+		 */
 		change: TextChangeEvent
 	}
 }

package/dist/control/Textarea.svelte

@@ -1,11 +1,11 @@
 <script context="module"></script>
 
 <script>
-	import GenericInput from '../internal/GenericInput.svelte'
-	import {} from '../utils.js'
 	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-textarea'
 	import { BROWSER } from 'esm-env'
 	import { createEventDispatcher, onDestroy } from 'svelte'
+	import GenericInput from '../internal/GenericInput.svelte'
+	import {} from '../utils.js'
 	export let value
 	export let live = true
 	export let rows = void 0

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

@@ -4,37 +4,8 @@ export type TextareaChangeEvent = ValueChangeEvent<string>
 import type { TextareaPluginInputParams } from '@kitschpatrol/tweakpane-plugin-textarea/dist/types/plugin.js'
 import { type GenericInputRef } from '../internal/GenericInput.svelte'
 declare const __propDef: {
-	props: {
-		/**
-		 * Whether to provide live updates to the bound `value` on every keystroke.
-		 * @default `true`
-		 */
-		live?: boolean
-		/**
-		 * A `string` value to control.
-		 * @bindable
-		 */
-		value: string
-		/**
-		 * Placeholder text to display when the `value` is empty.
-		 * @default `'Enter text here'`
-		 */
-		placeholder?: string
-		/**
-		 * The number of lines of text to display.
-		 *
-		 * If lines of input exceed this value, then the text area will scroll.
-		 * @default `3`
-		 */
-		rows?: number
-	} & Omit<
-		{
-			/**
-			 * A `string` value to control.
-			 * @bindable
-			 */
-			value: string
-		} & Omit<
+	props: Omit<
+		Omit<
 			{
 				/**
 				 * The binding's target object with values to manipulate.
@@ -68,7 +39,6 @@ declare const __propDef: {
 				options?: TextareaPluginInputParams | undefined
 				/**
 				 * Custom color scheme.
-				 *
 				 * @default `undefined`  \
 				 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
 				 * set with `setGlobalDefaultTheme()`.
@@ -83,7 +53,6 @@ declare const __propDef: {
 				 * components wrapping `<Binding>`'s functionality.
 				 *
 				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-				 *
 				 * @bindable
 				 * @readonly
 				 */
@@ -96,15 +65,43 @@ declare const __propDef: {
 				 * components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
 				 *
 				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-				 *
 				 * @default `undefined`
 				 */
 				plugin?: import('../utils.js').Plugin | undefined
 			},
 			'object' | 'key'
-		>,
+		> & {
+			/**
+			 * A `string` value to control.
+			 * @bindable
+			 */
+			value: string
+		},
 		'ref' | 'options' | 'plugin'
-	>
+	> & {
+		/**
+		 * A `string` value to control.
+		 * @bindable
+		 */
+		value: string
+		/**
+		 * Whether to provide live updates to the bound `value` on every keystroke.
+		 * @default `true`
+		 */
+		live?: boolean
+		/**
+		 * Placeholder text to display when the `value` is empty.
+		 * @default `'Enter text here'`
+		 */
+		placeholder?: string
+		/**
+		 * The number of lines of text to display.
+		 *
+		 * If lines of input exceed this value, then the text area will scroll.
+		 * @default `3`
+		 */
+		rows?: number
+	}
 	slots: {}
 	events: {
 		/**
@@ -114,10 +111,9 @@ declare const __propDef: {
 		 *
 		 * 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
-		 * */
+		 */
 		change: TextareaChangeEvent
 	}
 }

package/dist/control/Wheel.svelte

@@ -1,8 +1,8 @@
 <script context="module"></script>
 
 <script>
-	import GenericSlider from '../internal/GenericSlider.svelte'
 	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-camerakit'
+	import GenericSlider from '../internal/GenericSlider.svelte'
 	export let value
 	export let amount = void 0
 	export let wide = void 0