svelte-tweakpane-ui 1.2.2 → 1.2.4

package/dist/monitor/Monitor.svelte.d.ts

@@ -1,89 +1,7 @@
 import { SvelteComponent } from 'svelte';
 declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 	props(): Omit<
-		Omit<
-			{
-				/**
-				 * The binding's target object with values to manipulate.
-				 * @bindable
-				 */
-				object: import('@tweakpane/core').Bindable & Record<string, W>;
-				/** 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 | undefined;
-				/**
-				 * 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?:
-					| (W extends string
-							? import('tweakpane').StringMonitorParams
-							: W extends boolean
-								? import('tweakpane').BooleanMonitorParams
-								: W extends number
-									? import('tweakpane').NumberMonitorParams
-									: import('@tweakpane/core').BaseMonitorParams)
-					| 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/GenericMonitor.svelte').GenericMonitorRef | 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('tweakpane').TpPluginBundle | undefined;
-			},
-			'object' | 'key'
-		> & {
-			/**
-			 * A value to monitor.
-			 * @bindable
-			 */
-			value: W;
-		} & {
+		{
 			/**
 			 * Number of past states to retain.
 			 * @default `1`  \
@@ -106,86 +24,105 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 			 * Or `3` if value is `string` and `multiline` is `true`.
 			 */
 			rows?: number | undefined;
-		},
+		} & {
+			/**
+			 * A value to monitor.
+			 * @bindable
+			 */
+			value: W;
+		} & Omit<
+				{
+					/**
+					 * The binding's target object with values to manipulate.
+					 * @bindable
+					 */
+					object: import('@tweakpane/core').Bindable & Record<string, W>;
+					/** 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 | undefined;
+					/**
+					 * 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?:
+						| (W extends string
+								? import('tweakpane').StringMonitorParams
+								: W extends boolean
+									? import('tweakpane').BooleanMonitorParams
+									: W extends number
+										? import('tweakpane').NumberMonitorParams
+										: import('@tweakpane/core').BaseMonitorParams)
+						| 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/GenericMonitor.svelte').GenericMonitorRef | 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('tweakpane').TpPluginBundle | undefined;
+				},
+				'object' | 'key'
+			>,
 		'ref' | 'options' | 'plugin'
 	> &
 		(W extends string
-			? Omit<
-					Omit<
-						{
-							/**
-							 * The binding's target object with values to manipulate.
-							 * @bindable
-							 */
-							object: import('@tweakpane/core').Bindable & Record<string, string>;
-							/** 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 | undefined;
-							/**
-							 * 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').StringMonitorParams | 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/GenericMonitor.svelte').GenericMonitorRef | 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('tweakpane').TpPluginBundle | undefined;
-						},
-						'object' | 'key'
-					> & {
-						/**
-						 * A value to monitor.
-						 * @bindable
-						 */
-						value: string;
-					} & {
+			? {
+					/**
+					 * A value to monitor.
+					 * @bindable
+					 */
+					value: string;
+					/**
+					 * Display multiline strings.
+					 * @default `false`
+					 */
+					multiline?: boolean | undefined;
+				} & Omit<
+					{
 						/**
 						 * Number of past states to retain.
 						 * @default `1`  \
@@ -208,29 +145,19 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 						 * Or `3` if value is `string` and `multiline` is `true`.
 						 */
 						rows?: number | undefined;
-					},
-					'ref' | 'options' | 'plugin' | 'interval'
-				> & {
-					/**
-					 * A value to monitor.
-					 * @bindable
-					 */
-					value: string;
-					/**
-					 * Display multiline strings.
-					 * @default `false`
-					 */
-					multiline?: boolean | undefined;
-				}
-			: W extends boolean
-				? Omit<
-						Omit<
+					} & {
+						/**
+						 * A value to monitor.
+						 * @bindable
+						 */
+						value: string;
+					} & Omit<
 							{
 								/**
 								 * The binding's target object with values to manipulate.
 								 * @bindable
 								 */
-								object: import('@tweakpane/core').Bindable & Record<string, boolean>;
+								object: import('@tweakpane/core').Bindable & Record<string, string>;
 								/** The key for the value in the target `object` that the control should manipulate. */
 								key: string;
 								/**
@@ -255,7 +182,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 								 * Tweakpane UI_.
 								 * @default `undefined`
 								 */
-								options?: import('tweakpane').BooleanMonitorParams | undefined;
+								options?: import('tweakpane').StringMonitorParams | undefined;
 								/**
 								 * Custom color scheme.
 								 *
@@ -292,13 +219,18 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 								plugin?: import('tweakpane').TpPluginBundle | undefined;
 							},
 							'object' | 'key'
-						> & {
-							/**
-							 * A value to monitor.
-							 * @bindable
-							 */
-							value: boolean;
-						} & {
+						>,
+					'ref' | 'options' | 'plugin' | 'interval'
+				>
+			: W extends boolean
+				? {
+						/**
+						 * A value to monitor.
+						 * @bindable
+						 */
+						value: boolean;
+					} & Omit<
+						{
 							/**
 							 * Number of past states to retain.
 							 * @default `1`  \
@@ -321,24 +253,19 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 * Or `3` if value is `string` and `multiline` is `true`.
 							 */
 							rows?: number | undefined;
-						},
-						'ref' | 'options' | 'plugin' | 'interval'
-					> & {
-						/**
-						 * A value to monitor.
-						 * @bindable
-						 */
-						value: boolean;
-					}
-				: W extends number
-					? Omit<
-							Omit<
+						} & {
+							/**
+							 * A value to monitor.
+							 * @bindable
+							 */
+							value: boolean;
+						} & Omit<
 								{
 									/**
 									 * The binding's target object with values to manipulate.
 									 * @bindable
 									 */
-									object: import('@tweakpane/core').Bindable & Record<string, number>;
+									object: import('@tweakpane/core').Bindable & Record<string, boolean>;
 									/** The key for the value in the target `object` that the control should manipulate. */
 									key: string;
 									/**
@@ -363,7 +290,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 									 * Tweakpane UI_.
 									 * @default `undefined`
 									 */
-									options?: import('tweakpane').NumberMonitorParams | undefined;
+									options?: import('tweakpane').BooleanMonitorParams | undefined;
 									/**
 									 * Custom color scheme.
 									 *
@@ -400,38 +327,11 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 									plugin?: import('tweakpane').TpPluginBundle | undefined;
 								},
 								'object' | 'key'
-							> & {
-								/**
-								 * A value to monitor.
-								 * @bindable
-								 */
-								value: number;
-							} & {
-								/**
-								 * Number of past states to retain.
-								 * @default `1`  \
-								 * Or `64` if value is `number` and `graph` is `true`.
-								 */
-								bufferSize?: number | undefined;
-								/**
-								 * Time between value samples in milliseconds.
-								 *
-								 * Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
-								 * @default `0`
-								 */
-								interval?: number | undefined;
-								/**
-								 * Number of visible rows of state history.
-								 *
-								 * If `bufferSize` is larger, then the value window will scroll once state history exceeds
-								 * row count.
-								 * @default `1`  \
-								 * Or `3` if value is `string` and `multiline` is `true`.
-								 */
-								rows?: number | undefined;
-							},
-							'ref' | 'options' | 'plugin'
-						> & {
+							>,
+						'ref' | 'options' | 'plugin' | 'interval'
+					>
+				: W extends number
+					? {
 							/**
 							 * A value to monitor.
 							 * @bindable
@@ -458,7 +358,107 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 * @default `false`
 							 */
 							graph?: boolean | undefined;
-						}
+						} & Omit<
+							{
+								/**
+								 * Number of past states to retain.
+								 * @default `1`  \
+								 * Or `64` if value is `number` and `graph` is `true`.
+								 */
+								bufferSize?: number | undefined;
+								/**
+								 * Time between value samples in milliseconds.
+								 *
+								 * Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
+								 * @default `0`
+								 */
+								interval?: number | undefined;
+								/**
+								 * Number of visible rows of state history.
+								 *
+								 * If `bufferSize` is larger, then the value window will scroll once state history exceeds
+								 * row count.
+								 * @default `1`  \
+								 * Or `3` if value is `string` and `multiline` is `true`.
+								 */
+								rows?: number | undefined;
+							} & {
+								/**
+								 * A value to monitor.
+								 * @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 | undefined;
+										/**
+										 * 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').NumberMonitorParams | 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/GenericMonitor.svelte').GenericMonitorRef | 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('tweakpane').TpPluginBundle | undefined;
+									},
+									'object' | 'key'
+								>,
+							'ref' | 'options' | 'plugin'
+						>
 					: {
 							/**
 							 * A value to monitor.