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

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

@@ -1,7 +1,6 @@
 import { SvelteComponent } from 'svelte'
-import type { Simplify } from '../utils'
-import type { ValueChangeEvent } from '../utils.js'
 import type { SliderInputBindingApi as GenericSliderRef } from 'tweakpane'
+import type { Simplify, ValueChangeEvent } from '../utils.js'
 export type IntervalSliderValueTuple = [min: number, max: number]
 export type IntervalSliderValueObject = {
 	min: number
@@ -10,35 +9,81 @@ export type IntervalSliderValueObject = {
 export type IntervalSliderValue = Simplify<IntervalSliderValueObject | IntervalSliderValueTuple>
 export type IntervalSliderChangeEvent = ValueChangeEvent<IntervalSliderValue>
 declare const __propDef: {
-	props: {
-		/**
-		 * Interval value to control.
-		 *
-		 * Tuples are a convenience addition to the vanilla JS Tweakpane API.
-		 * @bindable
-		 */
-		value: IntervalSliderValue
-		/**
-		 * Midpoint of the interval range value.
-		 * @bindable
-		 * */
-		meanValue?: 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, IntervalSliderValue>
+				/** 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.
+			 * Interval value to control.
 			 *
-			 * Specifying both a `min` and a `max` prop turns the control into a slider.
-			 * @default `undefined`
+			 * Tuples are a convenience addition to the vanilla JS Tweakpane API.
+			 * @bindable
 			 */
-			max?: number
+			value: IntervalSliderValue
+		} & {
 			/**
 			 * A function to customize the point value's string representation (e.g. rounding, etc.).
 			 * @default `undefined`  \
@@ -51,6 +96,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`  \
@@ -70,85 +129,22 @@ declare const __propDef: {
 			 * @default `false`
 			 */
 			wide?: boolean
-		} & {
-			/**
-			 * Interval value to control.
-			 *
-			 * Tuples are a convenience addition to the vanilla JS Tweakpane API.
-			 * @bindable
-			 */
-			value: IntervalSliderValue
-		} & Omit<
-				{
-					/**
-					 * The binding's target object with values to manipulate.
-					 * @bindable
-					 */
-					object: import('@tweakpane/core').Bindable & Record<string, IntervalSliderValue>
-					/** 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').Plugin | undefined
-				},
-				'object' | 'key'
-			>,
+		},
 		'ref' | 'options' | 'plugin'
-	>
+	> & {
+		/**
+		 * Interval value to control.
+		 *
+		 * Tuples are a convenience addition to the vanilla JS Tweakpane API.
+		 * @bindable
+		 */
+		value: IntervalSliderValue
+		/**
+		 * Midpoint of the interval range value.
+		 * @bindable
+		 */
+		meanValue?: number
+	}
 	slots: {}
 	events: {
 		/**
@@ -158,10 +154,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: IntervalSliderChangeEvent
 	}
 }

package/dist/control/List.svelte

@@ -1,13 +1,13 @@
 <script context="module"></script>
 
 <script generics="T extends any">
-	import Blade from '../core/Blade.svelte'
-	import ClsPad from '../internal/ClsPad.svelte'
-	import {} from '../utils'
 	import { BROWSER } from 'esm-env'
-	import copy from 'fast-copy'
+	import { copy } from 'fast-copy'
 	import { shallowEqual } from 'fast-equals'
 	import { createEventDispatcher } from 'svelte'
+	import Blade from '../core/Blade.svelte'
+	import ClsPad from '../internal/ClsPad.svelte'
+	import {} from '../utils.js'
 	export let value
 	export let options
 	export let label = void 0
@@ -68,9 +68,9 @@
 		}
 	}
 	$: bladeOptions = {
-		value: getInitialValue(),
 		label,
 		options: getInternalOptions(options),
+		value: getInitialValue(),
 		view: 'list',
 	}
 	$: listBlade && addEvent()

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

@@ -1,6 +1,5 @@
 import { SvelteComponent } from 'svelte'
-import type { Simplify } from '../utils'
-import type { ValueChangeEvent } from '../utils.js'
+import type { Simplify, ValueChangeEvent } from '../utils.js'
 export type ListOptionsArray<T> = T[]
 export type ListOptionsObjectArray<T> = Array<{
 	value: T
@@ -13,25 +12,7 @@ export type ListOptions<T> = Simplify<
 export type ListChangeEvent = ValueChangeEvent<unknown>
 import type { ListBladeApi, ListBladeParams } from 'tweakpane'
 declare class __sveltets_Render<T extends any> {
-	props(): {
-		/**
-		 * Value of the selected `options` item.
-		 * @bindable
-		 * */
-		value: T
-		/**
-		 * Text displayed next to list.
-		 * @default `undefined`
-		 * */
-		label?: string
-		/**
-		 * A collection of options to select from.
-		 *
-		 * The arbitrary array list type is a convenience addition to to the vanilla JS Tweakpane
-		 * API.
-		 * */
-		options: ListOptions<T>
-	} & Omit<
+	props(): Omit<
 		{
 			/**
 			 * A collection of options to select from.
@@ -60,7 +41,6 @@ declare class __sveltets_Render<T extends any> {
 			 * components wrapping `<Blade>`'s functionality.
 			 *
 			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-			 *
 			 * @bindable
 			 * @readonly
 			 */
@@ -73,13 +53,30 @@ declare class __sveltets_Render<T extends any> {
 			 * components wrapping `<Blade>`'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').Plugin | undefined
+			plugin?: import('../utils.js').Plugin | undefined
 		},
 		'ref' | 'options' | 'plugin'
-	>
+	> & {
+		/**
+		 * Value of the selected `options` item.
+		 * @bindable
+		 */
+		value: T
+		/**
+		 * Text displayed next to list.
+		 * @default `undefined`
+		 */
+		label?: string
+		/**
+		 * A collection of options to select from.
+		 *
+		 * The arbitrary array list type is a convenience addition to to the vanilla JS Tweakpane
+		 * API.
+		 */
+		options: ListOptions<T>
+	}
 	events(): {
 		/**
 		 * Fires when `value` changes.
@@ -88,10 +85,9 @@ declare class __sveltets_Render<T extends any> {
 		 *
 		 * 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: ListChangeEvent
 	}
 	slots(): {}
@@ -123,8 +119,8 @@ export type ListSlots<T extends any> = ReturnType<__sveltets_Render<T>['slots']>
  * import { List, type ListOptions } from 'svelte-tweakpane-ui'
  *
  * const options: ListOptions<number> = {
- *   b: 2,
  *   a: 1,
+ *   b: 2,
  *   c: 3,
  * }
  * let selection: number = 1

package/dist/control/Point.svelte

@@ -1,11 +1,11 @@
 <script context="module"></script>
 
 <script generics="T extends PointValue2d | PointValue3d | PointValue4d">
-	import ClsPad from '../internal/ClsPad.svelte'
-	import GenericInputFolding from '../internal/GenericInputFolding.svelte'
-	import { removeKeys } from '../utils'
 	import { BROWSER } from 'esm-env'
 	import { shallowEqual } from 'fast-equals'
+	import ClsPad from '../internal/ClsPad.svelte'
+	import GenericInputFolding from '../internal/GenericInputFolding.svelte'
+	import { removeKeys } from '../utils.js'
 	export let value
 	export let expanded = $$props.expanded ?? void 0
 	let pointerScale = $$props['pointerScale'] ?? void 0
@@ -54,16 +54,16 @@
 	$: (value, updateInternalValueFromValue())
 	$: (internalValue, updateValueFromInternalValue())
 	$: options = {
-		x: optionsX,
-		y: optionsY,
-		z: optionsZ,
-		w: optionsW,
-		min,
-		max,
 		format,
 		keyScale,
+		max,
+		min,
 		pointerScale,
 		step,
+		w: optionsW,
+		x: optionsX,
+		y: optionsY,
+		z: optionsZ,
 	}
 </script>