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

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

@@ -1,7 +1,6 @@
 import { SvelteComponent } from 'svelte'
-import type { Simplify } from '../utils'
-import type { ValueChangeEvent } from '../utils.js'
 import type { Point2dInputParams, Point3dInputParams, Point4dInputParams } from 'tweakpane'
+import type { Simplify, ValueChangeEvent } from '../utils.js'
 export type PointValue2dObject = {
 	x: number
 	y: number
@@ -38,56 +37,92 @@ export type PointOptions<
 			: never
 export type PointChangeEvent = ValueChangeEvent<PointValue2d | PointValue3d | PointValue4d>
 declare class __sveltets_Render<T extends PointValue2d | PointValue3d | PointValue4d> {
-	props(): {
-		/**
-		 * A 2D, 3D, or 4D point object to control.
-		 *
-		 * Takes a tuple with a `number` value for each dimension, or an object with at least `x`
-		 * and `y` values, and optionally `z` and `w` values for additional dimensions.
-		 *
-		 * The type of this value will determine the availability of axis-specific option props.
-		 * @bindable
-		 * */
-		value: T
-		/**
-		 * The minimum value for all dimensions.
-		 * @default `undefined`  \
-		 * No minimum.
-		 * */
-		min?: number
-		/**
-		 * The maximum value for all dimensions.
-		 * @default `undefined`  \
-		 * No maximum.
-		 * */
-		max?: number
-		/**
-		 * A function to customize the point value's string representation (e.g. rounding, etc.).
-		 * @default `undefined`  \
-		 * Normal `.toString()` formatting.
-		 * */
-		format?: ((value: number) => string) | undefined
-		/**
-		 * The unit scale for key-based input for all dimensions (e.g. the up and down arrow keys).
-		 * @default `1`  \
-		 * Or `stepValue` if defined.
-		 *  */
-		keyScale?: number
-		/**
-		 * The unit scale for pointer-based input for all dimensions.
-		 * @default `undefined`  \
-		 * [Dynamic based on magnitude of
-		 * `value`](https://github.com/cocopon/tweakpane/blob/66dfbea04bfe9b7f031673c955ceda1f92356e75/packages/core/src/common/number/util.ts#L54).
-		 * */
-		pointerScale?: number
-		/**
-		 * The minimum step interval for all dimensions.
-		 * @default `undefined`  \
-		 * No step constraint.
-		 * */
-		step?: number
-	} & Omit<
-		{
+	props(): Omit<
+		Omit<
+			{
+				/**
+				 * The binding's target object with values to manipulate.
+				 * @bindable
+				 */
+				object: import('@tweakpane/core').Bindable & Record<string, T>
+				/** 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?:
+					| (T extends PointValue4d
+							? Point4dInputParams
+							: T extends PointValue3d
+								? Point3dInputParams
+								: T extends PointValue2d
+									? Point2dInputParams
+									: unknown)
+					| 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'
+		> & {
+			/**
+			 * A 2D, 3D, or 4D point object to control.
+			 *
+			 * Takes a tuple with a `number` value for each dimension, or an object with at least `x`
+			 * and `y` values, and optionally `z` and `w` values for additional dimensions.
+			 *
+			 * The type of this value will determine the availability of axis-specific option props.
+			 * @bindable
+			 */
+			value: T
+		} & {
 			/**
 			 * DOM class name of the button used to expand and collapse the input's picker.
 			 * @default `undefined`
@@ -109,94 +144,7 @@ declare class __sveltets_Render<T extends PointValue2d | PointValue3d | PointVal
 			 * @default `true`
 			 */
 			userExpandable?: boolean
-		} & {
-			/**
-			 * A 2D, 3D, or 4D point object to control.
-			 *
-			 * Takes a tuple with a `number` value for each dimension, or an object with at least `x`
-			 * and `y` values, and optionally `z` and `w` values for additional dimensions.
-			 *
-			 * The type of this value will determine the availability of axis-specific option props.
-			 * @bindable
-			 */
-			value: T
-		} & Omit<
-				{
-					/**
-					 * The binding's target object with values to manipulate.
-					 * @bindable
-					 */
-					object: import('@tweakpane/core').Bindable & Record<string, T>
-					/** 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?:
-						| (T extends PointValue4d
-								? Point4dInputParams
-								: T extends PointValue3d
-									? Point3dInputParams
-									: T extends PointValue2d
-										? Point2dInputParams
-										: unknown)
-						| 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'
 	> &
 		(T extends PointValue2d | PointValue3d | PointValue4d
@@ -207,7 +155,7 @@ declare class __sveltets_Render<T extends PointValue2d | PointValue3d | PointVal
 					 * Renamed from `x` in Tweakpane API to clarify that it is an object of options, not
 					 * a value.
 					 * @default `undefined`
-					 * */
+					 */
 					optionsX?:
 						| (T extends infer T_1
 								? T_1 extends T
@@ -231,7 +179,7 @@ declare class __sveltets_Render<T extends PointValue2d | PointValue3d | PointVal
 					 * a value.
 					 * @default `undefined`  \
 					 * `inverted` is `false`
-					 * */
+					 */
 					optionsY?:
 						| (T extends infer T_2
 								? T_2 extends T
@@ -255,7 +203,7 @@ declare class __sveltets_Render<T extends PointValue2d | PointValue3d | PointVal
 					 * Renamed from `z` in Tweakpane API to clarify that it is an object of options,
 					 * not a value.
 					 * @default `undefined`
-					 * */
+					 */
 					optionsZ?:
 						| (T extends infer T_3
 								? T_3 extends T
@@ -279,7 +227,7 @@ declare class __sveltets_Render<T extends PointValue2d | PointValue3d | PointVal
 					 * Renamed from `w` in Tweakpane API to clarify that it is an object of options,
 					 * not a value.
 					 * @default `undefined`
-					 * */
+					 */
 					optionsW?:
 						| (T extends infer T_4
 								? T_4 extends T
@@ -294,7 +242,55 @@ declare class __sveltets_Render<T extends PointValue2d | PointValue3d | PointVal
 								: never)['w']
 						| undefined
 				}
-			: unknown)
+			: unknown) & {
+			/**
+			 * A 2D, 3D, or 4D point object to control.
+			 *
+			 * Takes a tuple with a `number` value for each dimension, or an object with at least `x`
+			 * and `y` values, and optionally `z` and `w` values for additional dimensions.
+			 *
+			 * The type of this value will determine the availability of axis-specific option props.
+			 * @bindable
+			 */
+			value: T
+			/**
+			 * The minimum value for all dimensions.
+			 * @default `undefined`  \
+			 * No minimum.
+			 */
+			min?: number
+			/**
+			 * The maximum value for all dimensions.
+			 * @default `undefined`  \
+			 * No maximum.
+			 */
+			max?: number
+			/**
+			 * A function to customize the point value's string representation (e.g. rounding, etc.).
+			 * @default `undefined`  \
+			 * Normal `.toString()` formatting.
+			 */
+			format?: ((value: number) => string) | undefined
+			/**
+			 * The unit scale for key-based input for all dimensions (e.g. the up and down arrow keys).
+			 * @default `1`  \
+			 * Or `stepValue` if defined.
+			 */
+			keyScale?: number
+			/**
+			 * The unit scale for pointer-based input for all dimensions.
+			 * @default `undefined`  \
+			 * [Dynamic based on magnitude of
+			 * `value`](https://github.com/cocopon/tweakpane/blob/66dfbea04bfe9b7f031673c955ceda1f92356e75/packages/core/src/common/number/util.ts#L54).
+			 */
+			pointerScale?: number
+			/**
+			 * The minimum step interval for all dimensions.
+			 * @default `undefined`  \
+			 * No step constraint.
+			 */
+			step?: number
+		}
 	events(): {
 		/**
 		 * Fires when `value` changes.
@@ -303,10 +299,9 @@ declare class __sveltets_Render<T extends PointValue2d | PointValue3d | PointVal
 		 *
 		 * 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: PointChangeEvent
 	}
 	slots(): {}

package/dist/control/RadioGrid.svelte

@@ -1,13 +1,12 @@
 <script context="module"></script>
 
 <script generics="T extends boolean | number | string">
-	import ClsPad from '../internal/ClsPad.svelte'
-	import GenericInput from '../internal/GenericInput.svelte'
-	import { fillWith } from '../utils'
-	import { getGridDimensions } from '../utils.js'
 	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-essentials'
 	import { BROWSER } from 'esm-env'
 	import { nanoid } from 'nanoid'
+	import ClsPad from '../internal/ClsPad.svelte'
+	import GenericInput from '../internal/GenericInput.svelte'
+	import { fillWith, getGridDimensions } from '../utils.js'
 	const defaultGroupName = nanoid()
 	export let groupName = void 0
 	export let values

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

@@ -2,61 +2,8 @@ import { SvelteComponent } from 'svelte'
 import type { ValueChangeEvent } from '../utils.js'
 export type RadioGridChangeEvent = ValueChangeEvent<boolean | number | string>
 declare class __sveltets_Render<T extends boolean | number | string> {
-	props(): {
-		/**
-		 * Value of selected radio button.
-		 *
-		 * Bind to this prop to receive updates when the user clicks a radio button.
-		 * @bindable
-		 * @default `undefined` If undefined, the first value in the `values` array is assigned.
-		 *  */
-		value?: T | undefined
-		/**
-		 * Number of columns to arrange the radio buttons into.
-		 * @default `undefined`
-		 * */
-		columns?: number
-		/**
-		 * Name allowing multiple radio groups to share mutually exclusive selection state.
-		 *
-		 * Allows spanning exclusive selection state across multiple independent `<RadioGrid>`
-		 * components, but should remain `undefined` for most use cases to keep exclusivity scoped
-		 * to a single `<RadioGrid>`.
-		 * @default `undefined`  \
-		 * Uses a dynamically generated globally unique id internally.
-		 */
-		groupName?: string
-		/**
-		 * Text to show in the radio button label before the value.
-		 * @default `undefined`
-		 * */
-		prefix?: string
-		/**
-		 * Number of rows to arrange the radio buttons into.
-		 * @default `undefined`
-		 * */
-		rows?: number
-		/**
-		 * Text to show in the radio button label after the value.
-		 * @default `undefined`
-		 * */
-		suffix?: string
-		/**
-		 * Array of `number`, `string` or `boolean` values, each of which will become a button in
-		 * the radio grid.
-		 * */
-		values: T[]
-	} & Omit<
-		{
-			/**
-			 * Value of selected radio button.
-			 *
-			 * Bind to this prop to receive updates when the user clicks a radio button.
-			 * @bindable
-			 * @default `undefined` If undefined, the first value in the `values` array is assigned.
-			 */
-			value: T
-		} & Omit<
+	props(): Omit<
+		Omit<
 			{
 				/**
 				 * The binding's target object with values to manipulate.
@@ -88,7 +35,7 @@ declare class __sveltets_Render<T extends boolean | number | string> {
 				 * @default `undefined`
 				 */
 				options?:
-					| ({
+					| (import('@tweakpane/core').BaseInputParams & {
 							cells: (
 								x: number,
 								y: number,
@@ -99,11 +46,10 @@ declare class __sveltets_Render<T extends boolean | number | string> {
 							groupName: string
 							size: [number, number]
 							view: 'radiogrid'
-					  } & 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()`.
@@ -118,7 +64,6 @@ declare class __sveltets_Render<T extends boolean | number | string> {
 				 * components wrapping `<Binding>`'s functionality.
 				 *
 				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-				 *
 				 * @bindable
 				 * @readonly
 				 */
@@ -131,15 +76,67 @@ declare class __sveltets_Render<T extends boolean | number | string> {
 				 * 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'
-		>,
+		> & {
+			/**
+			 * Value of selected radio button.
+			 *
+			 * Bind to this prop to receive updates when the user clicks a radio button.
+			 * @bindable
+			 * @default `undefined` If undefined, the first value in the `values` array is assigned.
+			 */
+			value: T
+		},
 		'ref' | 'options' | 'plugin'
-	>
+	> & {
+		/**
+		 * Value of selected radio button.
+		 *
+		 * Bind to this prop to receive updates when the user clicks a radio button.
+		 * @bindable
+		 * @default `undefined` If undefined, the first value in the `values` array is assigned.
+		 */
+		value?: T | undefined
+		/**
+		 * Number of columns to arrange the radio buttons into.
+		 * @default `undefined`
+		 */
+		columns?: number
+		/**
+		 * Name allowing multiple radio groups to share mutually exclusive selection state.
+		 *
+		 * Allows spanning exclusive selection state across multiple independent `<RadioGrid>`
+		 * components, but should remain `undefined` for most use cases to keep exclusivity scoped
+		 * to a single `<RadioGrid>`.
+		 * @default `undefined`  \
+		 * Uses a dynamically generated globally unique id internally.
+		 */
+		groupName?: string
+		/**
+		 * Text to show in the radio button label before the value.
+		 * @default `undefined`
+		 */
+		prefix?: string
+		/**
+		 * Number of rows to arrange the radio buttons into.
+		 * @default `undefined`
+		 */
+		rows?: number
+		/**
+		 * Text to show in the radio button label after the value.
+		 * @default `undefined`
+		 */
+		suffix?: string
+		/**
+		 * Array of `number`, `string` or `boolean` values, each of which will become a button in
+		 * the radio grid.
+		 */
+		values: T[]
+	}
 	events(): {
 		/**
 		 * Fires when `value` changes.
@@ -148,10 +145,9 @@ declare class __sveltets_Render<T extends boolean | number | string> {
 		 *
 		 * 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: RadioGridChangeEvent
 	}
 	slots(): {}

package/dist/control/Ring.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 series = void 0
 	export let unit = void 0