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

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

@@ -1,26 +1,86 @@
 import { SvelteComponent } from 'svelte'
-import type { ValueChangeEvent } from '../utils.js'
 import type { ColorPlusValue } from 'tweakpane-plugin-color-plus/lite'
+import type { ValueChangeEvent } from '../utils.js'
 export type { ColorPlusValue } from 'tweakpane-plugin-color-plus/lite'
 export type ColorPlusChangeEvent = ValueChangeEvent<ColorPlusValue>
-import * as pluginModule from 'tweakpane-plugin-color-plus/lite'
+import type { ColorPlusInputParams as ColorPlusOptions } from 'tweakpane-plugin-color-plus/lite'
 declare const __propDef: {
-	props: {
-		/**
-		 * A color value to control.
-		 *
-		 * Use either a color-like string (e.g. #ff00ff), a number, an object with `r`, `b`, `g`, and
-		 * optional `a` keys, or a tuple.
-		 * @bindable
-		 * */
-		value: ColorPlusValue
-		/**
-		 * Whether to treat values as floats from 0.0 to 1.0, or integers from 0 to 255.
-		 * @default `'int'`
-		 * */
-		type?: 'float' | 'int'
-	} & Omit<
-		{
+	props: Omit<
+		Omit<
+			{
+				/**
+				 * The binding's target object with values to manipulate.
+				 * @bindable
+				 */
+				object: import('@tweakpane/core').Bindable & Record<string, ColorPlusValue>
+				/** 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?: ColorPlusOptions | 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 color value to control.
+			 *
+			 * Use either a color-like string (e.g. #ff00ff), a number, an object with `r`, `b`, `g`, and
+			 * optional `a` keys, or a tuple.
+			 * @bindable
+			 */
+			value: ColorPlusValue
+		} & {
 			/**
 			 * DOM class name of the button used to expand and collapse the input's picker.
 			 * @default `undefined`
@@ -42,86 +102,23 @@ declare const __propDef: {
 			 * @default `true`
 			 */
 			userExpandable?: boolean
-		} & {
-			/**
-			 * A color value to control.
-			 *
-			 * Use either a color-like string (e.g. #ff00ff), a number, an object with `r`, `b`, `g`, and
-			 * optional `a` keys, or a tuple.
-			 * @bindable
-			 */
-			value: ColorPlusValue
-		} & Omit<
-				{
-					/**
-					 * The binding's target object with values to manipulate.
-					 * @bindable
-					 */
-					object: import('@tweakpane/core').Bindable & Record<string, ColorPlusValue>
-					/** 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?: pluginModule.ColorPlusInputParams | 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'
-			>,
+		},
 		'ref' | 'options' | 'plugin' | 'buttonClass'
-	>
+	> & {
+		/**
+		 * A color value to control.
+		 *
+		 * Use either a color-like string (e.g. #ff00ff), a number, an object with `r`, `b`, `g`, and
+		 * optional `a` keys, or a tuple.
+		 * @bindable
+		 */
+		value: ColorPlusValue
+		/**
+		 * Whether to treat values as floats from 0.0 to 1.0, or integers from 0 to 255.
+		 * @default `'int'`
+		 */
+		type?: 'float' | 'int'
+	}
 	slots: {}
 	events: {
 		/**
@@ -131,10 +128,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: ColorPlusChangeEvent
 	}
 }

package/dist/control/CubicBezier.svelte

@@ -1,15 +1,15 @@
 <script context="module"></script>
 
 <script>
-	import ClsPad from '../internal/ClsPad.svelte'
-	import GenericBladeFolding from '../internal/GenericBladeFolding.svelte'
-	import { fillWith } from '../utils'
 	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-essentials'
 	import { CubicBezier } from '@kitschpatrol/tweakpane-plugin-essentials'
 	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 ClsPad from '../internal/ClsPad.svelte'
+	import GenericBladeFolding from '../internal/GenericBladeFolding.svelte'
+	import { fillWith } from '../utils.js'
 	export let value
 	export let label = void 0
 	export let expanded = void 0
@@ -59,8 +59,8 @@
 		})
 	}
 	$: options = {
-		value: getValue(),
 		label,
+		value: getValue(),
 		view: 'cubicbezier',
 	}
 	$: cubicBezierBlade && addEvent()

package/dist/control/CubicBezier.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 CubicBezierValueObject = {
 	x1: number
 	y1: number
@@ -13,46 +12,8 @@ export type CubicBezierChangeEvent = ValueChangeEvent<CubicBezierValue>
 import type { CubicBezierApi as CubicBezierRef } from '@kitschpatrol/tweakpane-plugin-essentials'
 import type { CubicBezierBladeParams as CubicBezierOptions } from '@kitschpatrol/tweakpane-plugin-essentials/dist/types/cubic-bezier/plugin.d.ts'
 declare const __propDef: {
-	props: {
-		/**
-		 * 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.
-		 * @bindable
-		 */
-		value: CubicBezierValue
-		/**
-		 * Text displayed next to the control.
-		 * @default `undefined`
-		 * */
-		label?: string
-	} & Omit<
+	props: Omit<
 		{
-			/**
-			 * 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.
-			 *
-			 * Most useful when `picker` is `inline`.
-			 * @default `true`
-			 */
-			userExpandable?: boolean
-		} & {
 			/**
 			 * Blade configuration exposing Tweakpane's internal
 			 * [`BladeParams`](https://tweakpane.github.io/docs/api/interfaces/BaseBladeParams.html).
@@ -79,7 +40,6 @@ declare const __propDef: {
 			 * components wrapping `<Blade>`'s functionality.
 			 *
 			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-			 *
 			 * @bindable
 			 * @readonly
 			 */
@@ -92,13 +52,50 @@ declare const __propDef: {
 			 * 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
+		} & {
+			/**
+			 * 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.
+			 *
+			 * Most useful when `picker` is `inline`.
+			 * @default `true`
+			 */
+			userExpandable?: boolean
 		},
 		'ref' | 'options' | 'plugin' | 'buttonClass'
-	>
+	> & {
+		/**
+		 * 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.
+		 * @bindable
+		 */
+		value: CubicBezierValue
+		/**
+		 * Text displayed next to the control.
+		 * @default `undefined`
+		 */
+		label?: string
+	}
 	slots: {}
 	events: {
 		/**
@@ -108,10 +105,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: CubicBezierChangeEvent
 	}
 }

package/dist/control/File.svelte

@@ -1,12 +1,12 @@
 <script context="module"></script>
 
 <script>
-	import ClsPad from '../internal/ClsPad.svelte'
-	import GenericInput from '../internal/GenericInput.svelte'
-	import { fillWith } from '../utils'
 	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-file-import'
 	import { BROWSER } from 'esm-env'
 	import { shallowEqual } from 'fast-equals'
+	import ClsPad from '../internal/ClsPad.svelte'
+	import GenericInput from '../internal/GenericInput.svelte'
+	import { fillWith } from '../utils.js'
 	export let value = void 0
 	export let rows = void 0
 	export let invalidExtensionMessage = void 0

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

@@ -3,37 +3,8 @@ import type { ValueChangeEvent } from '../utils.js'
 export type FileValue = File | undefined
 export type FileChangeEvent = ValueChangeEvent<FileValue>
 declare const __propDef: {
-	props: {
-		/**
-		 * File data, or `undefined` to clear the file input.
-		 * @default `undefined`
-		 * @bindable
-		 */
-		value?: FileValue
-		/**
-		 * Array of valid file extensions.
-		 * @default Any file extension
-		 */
-		extensions?: string[] | undefined
-		/**
-		 * String shown when the user tries to upload an invalid filetype.
-		 * @default `'Unaccepted file type.'`
-		 */
-		invalidExtensionMessage?: string | undefined
-		/**
-		 * Height of the file input drop zone, in rows.
-		 * @default `3`
-		 */
-		rows?: number | undefined
-	} & Omit<
-		{
-			/**
-			 * File data, or `undefined` to clear the file input.
-			 * @default `undefined`
-			 * @bindable
-			 */
-			value: string | File | null
-		} & Omit<
+	props: Omit<
+		Omit<
 			{
 				/**
 				 * The binding's target object with values to manipulate.
@@ -67,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()`.
@@ -82,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
 				 */
@@ -95,15 +64,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'
-		>,
+		> & {
+			/**
+			 * File data, or `undefined` to clear the file input.
+			 * @default `undefined`
+			 * @bindable
+			 */
+			value: string | File | null
+		},
 		'ref' | 'plugin' | 'value'
-	>
+	> & {
+		/**
+		 * File data, or `undefined` to clear the file input.
+		 * @default `undefined`
+		 * @bindable
+		 */
+		value?: FileValue
+		/**
+		 * Array of valid file extensions.
+		 * @default Any file extension
+		 */
+		extensions?: string[] | undefined
+		/**
+		 * String shown when the user tries to upload an invalid filetype.
+		 * @default `'Unaccepted file type.'`
+		 */
+		invalidExtensionMessage?: string | undefined
+		/**
+		 * Height of the file input drop zone, in rows.
+		 * @default `3`
+		 */
+		rows?: number | undefined
+	}
 	slots: {}
 	events: {
 		/**
@@ -113,10 +110,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: FileChangeEvent
 	}
 }

package/dist/control/Image.svelte

@@ -1,12 +1,12 @@
 <script context="module"></script>
 
 <script>
-	import ClsPad from '../internal/ClsPad.svelte'
-	import GenericInput from '../internal/GenericInput.svelte'
-	import { fillWith } from '../utils'
 	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-image'
 	import { BROWSER } from 'esm-env'
 	import { shallowEqual } from 'fast-equals'
+	import ClsPad from '../internal/ClsPad.svelte'
+	import GenericInput from '../internal/GenericInput.svelte'
+	import { fillWith } from '../utils.js'
 	export let value = void 0
 	export let fit = void 0
 	export let extensions = void 0

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

@@ -3,34 +3,8 @@ import type { ValueChangeEvent } from '../utils.js'
 export type ImageValue = string | undefined
 export type ImageChangeEvent = ValueChangeEvent<ImageValue>
 declare const __propDef: {
-	props: {
-		/**
-		 * Image data as Base64-encoded string, or `undefined` to clear.
-		 * @default `'undefined'`
-		 * @bindable
-		 */
-		value?: ImageValue
-		/**
-		 * Array of image extension types to accept.
-		 * @default `['.jpg', '.png', '.gif']`
-		 */
-		extensions?: string[]
-		/**
-		 * How to display the image in the preview pane.
-		 *
-		 * Renamed from `imageFit` in `tweakpane-image-plugin` for concision.
-		 * @default `'cover'`
-		 */
-		fit?: 'contain' | 'cover'
-	} & Omit<
-		{
-			/**
-			 * Image data as Base64-encoded string, or `undefined` to clear.
-			 * @default `'undefined'`
-			 * @bindable
-			 */
-			value: string | HTMLImageElement | File | undefined
-		} & Omit<
+	props: Omit<
+		Omit<
 			{
 				/**
 				 * The binding's target object with values to manipulate.
@@ -65,7 +39,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()`.
@@ -80,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
 				 */
@@ -93,15 +65,40 @@ 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'
-		>,
+		> & {
+			/**
+			 * Image data as Base64-encoded string, or `undefined` to clear.
+			 * @default `'undefined'`
+			 * @bindable
+			 */
+			value: string | HTMLImageElement | File | undefined
+		},
 		'ref' | 'plugin' | 'value'
-	>
+	> & {
+		/**
+		 * Image data as Base64-encoded string, or `undefined` to clear.
+		 * @default `'undefined'`
+		 * @bindable
+		 */
+		value?: ImageValue
+		/**
+		 * Array of image extension types to accept.
+		 * @default `['.jpg', '.png', '.gif']`
+		 */
+		extensions?: string[]
+		/**
+		 * How to display the image in the preview pane.
+		 *
+		 * Renamed from `imageFit` in `tweakpane-image-plugin` for concision.
+		 * @default `'cover'`
+		 */
+		fit?: 'contain' | 'cover'
+	}
 	slots: {}
 	events: {
 		/**
@@ -111,10 +108,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: ImageChangeEvent
 	}
 }

package/dist/control/IntervalSlider.svelte

@@ -1,9 +1,9 @@
 <script context="module"></script>
 
 <script>
-	import GenericSlider from '../internal/GenericSlider.svelte'
 	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-essentials'
 	import { shallowEqual } from 'fast-equals'
+	import GenericSlider from '../internal/GenericSlider.svelte'
 	export let value
 	export let meanValue = void 0
 	export let wide = void 0