svelte-tweakpane-ui 1.5.11 → 1.5.13

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

@@ -1,6 +1,6 @@
 import { SvelteComponent } from 'svelte'
-import type { ValueChangeEvent } from '../utils.js'
 import type { RingSeries } from '@kitschpatrol/tweakpane-plugin-camerakit/dist/types/util.js'
+import type { ValueChangeEvent } from '../utils.js'
 type RingUnit = {
 	/**
 	 * The value for the unit.
@@ -28,38 +28,79 @@ type RingUnit = {
 export type { RingSeries, RingUnit }
 export type RingChangeEvent = ValueChangeEvent<number>
 declare const __propDef: {
-	props: {
-		/**
-		 * A `number` value to control.
-		 * @bindable
-		 * */
-		value: number
-		/**
-		 * Style variations.
-		 * @default `0`
-		 * */
-		series?: RingSeries
-		/**
-		 * Density and value mapping of the ring's tick marks.
-		 * @default `{ ticks: 5, pixels: 40, value: 10 }`
-		 * */
-		unit?: RingUnit
-	} & 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?: import('tweakpane').SliderInputBindingApi | 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`  \
@@ -72,6 +113,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`  \
@@ -91,83 +146,25 @@ 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?: import('tweakpane').SliderInputBindingApi | 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'
-	>
+	> & {
+		/**
+		 * A `number` value to control.
+		 * @bindable
+		 */
+		value: number
+		/**
+		 * Style variations.
+		 * @default `0`
+		 */
+		series?: RingSeries
+		/**
+		 * Density and value mapping of the ring's tick marks.
+		 * @default `{ ticks: 5, pixels: 40, value: 10 }`
+		 */
+		unit?: RingUnit
+	}
 	slots: {}
 	events: {
 		/**
@@ -177,10 +174,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: RingChangeEvent
 	}
 }

package/dist/control/RotationEuler.svelte

@@ -1,11 +1,11 @@
 <script context="module"></script>
 
 <script>
-	import ClsPad from '../internal/ClsPad.svelte'
-	import GenericInputFolding from '../internal/GenericInputFolding.svelte'
 	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-rotation'
 	import { BROWSER } from 'esm-env'
 	import { shallowEqual } from 'fast-equals'
+	import ClsPad from '../internal/ClsPad.svelte'
+	import GenericInputFolding from '../internal/GenericInputFolding.svelte'
 	export let value
 	export let order = void 0
 	export let unit = void 0
@@ -39,13 +39,13 @@
 	$: (value, updateInternalValueFromValue())
 	$: (internalValue, updateValueFromInternalValue())
 	$: options = {
-		x: optionsX,
-		y: optionsY,
-		z: optionsZ,
 		order,
 		rotationMode: 'euler',
 		unit,
 		view: 'rotation',
+		x: optionsX,
+		y: optionsY,
+		z: optionsZ,
 	}
 </script>
 

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

@@ -1,9 +1,8 @@
 import { SvelteComponent } from 'svelte'
-import type { Simplify } from '../utils'
-import type { ValueChangeEvent } from '../utils.js'
 import type { EulerOrder } from '@kitschpatrol/tweakpane-plugin-rotation/dist/types/EulerOrder.js'
 import type { EulerUnit } from '@kitschpatrol/tweakpane-plugin-rotation/dist/types/EulerUnit.js'
 import type { PointDimensionParams } from '@tweakpane/core'
+import type { Simplify, ValueChangeEvent } from '../utils.js'
 export type RotationEulerOptions = Simplify<PointDimensionParams>
 export type RotationEulerOrder = EulerOrder
 export type RotationEulerUnit = EulerUnit
@@ -17,7 +16,108 @@ export type RotationEulerValue = Simplify<RotationEulerValueObject | RotationEul
 export type RotationEulerChangeEvent = ValueChangeEvent<RotationEulerValue>
 import type { RotationInputPluginEulerParams as RotationEulerOptionsInternal } from '@kitschpatrol/tweakpane-plugin-rotation/dist/types/RotationInputPluginEulerParams'
 declare const __propDef: {
-	props: {
+	props: Omit<
+		Omit<
+			{
+				/**
+				 * The binding's target object with values to manipulate.
+				 * @bindable
+				 */
+				object: import('@tweakpane/core').Bindable & Record<string, RotationEulerValue>
+				/** 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?: RotationEulerOptionsInternal | 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?: import('../internal/GenericInput.svelte').GenericInputRef | 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'
+		> & {
+			/**
+			 * The rotation value to control.
+			 *
+			 * Tuple values are a convenience added by _Svelte Tweakpane UI_, and are not part of the
+			 * original TweakpaneRotationPlugin API.
+			 *
+			 * See the `order` prop to specify the sequence in which rotations are applied.
+			 * @bindable
+			 */
+			value: RotationEulerValue
+		} & {
+			/**
+			 * 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
+		},
+		'ref' | 'options' | 'plugin' | 'buttonClass'
+	> & {
 		/**
 		 * The rotation value to control.
 		 *
@@ -26,7 +126,7 @@ declare const __propDef: {
 		 *
 		 * See the `order` prop to specify the sequence in which rotations are applied.
 		 * @bindable
-		 * */
+		 */
 		value: RotationEulerValue
 		/**
 		 * Input parameters specific to the X dimension.
@@ -34,7 +134,7 @@ declare const __propDef: {
 		 * Renamed from `x` in the original TweakpaneRotationPlugin API to clarify that it is an
 		 * object of options, not a value.
 		 * @default `undefined`
-		 * */
+		 */
 		optionsX?: RotationEulerOptions
 		/**
 		 * Input parameters specific to the Y dimension.
@@ -42,7 +142,7 @@ declare const __propDef: {
 		 * Renamed from `y` in the original TweakpaneRotationPlugin API to clarify that it is an
 		 * object of options, not a value.
 		 * @default `undefined`
-		 * */
+		 */
 		optionsY?: RotationEulerOptions
 		/**
 		 * Input parameters specific to the Z dimension.
@@ -50,7 +150,7 @@ declare const __propDef: {
 		 * Renamed from `z` in the original TweakpaneRotationPlugin API to clarify that it is an
 		 * object of options, not a value.
 		 * @default `undefined`
-		 * */
+		 */
 		optionsZ?: RotationEulerOptions
 		/**
 		 * Order of in which rotations are applied.
@@ -59,118 +159,14 @@ declare const __propDef: {
 		 * intrinsic rotations, so you have to reverse the order if you want to match Three.js'
 		 * behavior.
 		 * @default `'XYZ'`
-		 * */
+		 */
 		order?: RotationEulerOrder
 		/**
 		 * Units of rotation.
 		 * @default `'rad'`
 		 */
 		unit?: RotationEulerUnit
-	} & Omit<
-		{
-			/**
-			 * 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
-		} & {
-			/**
-			 * The rotation value to control.
-			 *
-			 * Tuple values are a convenience added by _Svelte Tweakpane UI_, and are not part of the
-			 * original TweakpaneRotationPlugin API.
-			 *
-			 * See the `order` prop to specify the sequence in which rotations are applied.
-			 * @bindable
-			 */
-			value: RotationEulerValue
-		} & Omit<
-				{
-					/**
-					 * The binding's target object with values to manipulate.
-					 * @bindable
-					 */
-					object: import('@tweakpane/core').Bindable & Record<string, RotationEulerValue>
-					/** 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?: RotationEulerOptionsInternal | 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?: import('../internal/GenericInput.svelte').GenericInputRef | 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' | 'buttonClass'
-	>
+	}
 	slots: {}
 	events: {
 		/**
@@ -180,10 +176,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: RotationEulerChangeEvent
 	}
 }

package/dist/control/RotationQuaternion.svelte

@@ -1,11 +1,11 @@
 <script context="module"></script>
 
 <script>
-	import ClsPad from '../internal/ClsPad.svelte'
-	import GenericInputFolding from '../internal/GenericInputFolding.svelte'
 	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-rotation'
 	import { BROWSER } from 'esm-env'
 	import { shallowEqual } from 'fast-equals'
+	import ClsPad from '../internal/ClsPad.svelte'
+	import GenericInputFolding from '../internal/GenericInputFolding.svelte'
 	export let value
 	export let optionsX = void 0
 	export let optionsY = void 0
@@ -38,12 +38,12 @@
 	$: (value, updateInternalValueFromValue())
 	$: (internalValue, updateValueFromInternalValue())
 	$: options = {
+		rotationMode: 'quaternion',
+		view: 'rotation',
+		w: optionsW,
 		x: optionsX,
 		y: optionsY,
 		z: optionsZ,
-		w: optionsW,
-		rotationMode: 'quaternion',
-		view: 'rotation',
 	}
 </script>