svelte-tweakpane-ui 1.5.3 → 1.5.4

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

@@ -1,4 +1,4 @@
-import { SvelteComponent } from 'svelte';
+import { SvelteComponent } from 'svelte'
 declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 	props(): W extends string | number | boolean
 		? Omit<
@@ -8,14 +8,14 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 					 * @default `1`  \
 					 * Or `64` if value is `number` and `graph` is `true`.
 					 */
-					bufferSize?: number;
+					bufferSize?: number
 					/**
 					 * Time between value samples in milliseconds.
 					 *
 					 * Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
 					 * @default `0`
 					 */
-					interval?: number;
+					interval?: number
 					/**
 					 * Number of visible rows of state history.
 					 *
@@ -24,32 +24,32 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 					 * @default `1`  \
 					 * Or `3` if value is `string` and `multiline` is `true`.
 					 */
-					rows?: number;
+					rows?: number
 				} & {
 					/**
 					 * A value to monitor.
 					 * @bindable
 					 */
-					value: W;
+					value: W
 				} & Omit<
 						{
 							/**
 							 * The binding's target object with values to manipulate.
 							 * @bindable
 							 */
-							object: import('@tweakpane/core').Bindable & Record<string, W>;
+							object: import('@tweakpane/core').Bindable & Record<string, W>
 							/** The key for the value in the target `object` that the control should manipulate. */
-							key: string;
+							key: string
 							/**
 							 * Prevent interactivity and gray out the control.
 							 * @default `false`
 							 */
-							disabled?: boolean;
+							disabled?: boolean
 							/**
 							 * Text displayed next to control.
 							 * @default `undefined`
 							 */
-							label?: string | undefined;
+							label?: string | undefined
 							/**
 							 * Tweakpane's internal options object.
 							 *
@@ -74,7 +74,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 														: import('@tweakpane/core').BaseMonitorParams
 											: never
 										: never)
-								| undefined;
+								| undefined
 							/**
 							 * Custom color scheme.
 							 *
@@ -82,7 +82,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
 							 * set with `setGlobalDefaultTheme()`.
 							 */
-							theme?: import('..').Theme | undefined;
+							theme?: import('..').Theme | undefined
 							/**
 							 * Reference to internal Tweakpane
 							 * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
@@ -96,7 +96,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 * @bindable
 							 * @readonly
 							 */
-							ref?: import('../internal/GenericMonitor.svelte').GenericMonitorRef | undefined;
+							ref?: import('../internal/GenericMonitor.svelte').GenericMonitorRef | undefined
 							/**
 							 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
 							 * the `<Binding>`'s containing `<Pane>`.
@@ -108,7 +108,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 *
 							 * @default `undefined`
 							 */
-							plugin?: import('..').Plugin | undefined;
+							plugin?: import('..').Plugin | undefined
 						},
 						'object' | 'key'
 					>,
@@ -122,12 +122,12 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 									 * A value to monitor.
 									 * @bindable
 									 */
-									value: string;
+									value: string
 									/**
 									 * Display multiline strings.
 									 * @default `false`
 									 */
-									multiline?: boolean;
+									multiline?: boolean
 								} & Omit<
 									{
 										/**
@@ -135,14 +135,14 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 										 * @default `1`  \
 										 * Or `64` if value is `number` and `graph` is `true`.
 										 */
-										bufferSize?: number;
+										bufferSize?: number
 										/**
 										 * Time between value samples in milliseconds.
 										 *
 										 * Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
 										 * @default `0`
 										 */
-										interval?: number;
+										interval?: number
 										/**
 										 * Number of visible rows of state history.
 										 *
@@ -151,32 +151,32 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 										 * @default `1`  \
 										 * Or `3` if value is `string` and `multiline` is `true`.
 										 */
-										rows?: number;
+										rows?: number
 									} & {
 										/**
 										 * A value to monitor.
 										 * @bindable
 										 */
-										value: string;
+										value: string
 									} & Omit<
 											{
 												/**
 												 * The binding's target object with values to manipulate.
 												 * @bindable
 												 */
-												object: import('@tweakpane/core').Bindable & Record<string, string>;
+												object: import('@tweakpane/core').Bindable & Record<string, string>
 												/** The key for the value in the target `object` that the control should manipulate. */
-												key: string;
+												key: string
 												/**
 												 * Prevent interactivity and gray out the control.
 												 * @default `false`
 												 */
-												disabled?: boolean;
+												disabled?: boolean
 												/**
 												 * Text displayed next to control.
 												 * @default `undefined`
 												 */
-												label?: string | undefined;
+												label?: string | undefined
 												/**
 												 * Tweakpane's internal options object.
 												 *
@@ -189,7 +189,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 												 * Tweakpane UI_.
 												 * @default `undefined`
 												 */
-												options?: import('tweakpane').StringMonitorParams | undefined;
+												options?: import('tweakpane').StringMonitorParams | undefined
 												/**
 												 * Custom color scheme.
 												 *
@@ -197,7 +197,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 												 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
 												 * set with `setGlobalDefaultTheme()`.
 												 */
-												theme?: import('..').Theme | undefined;
+												theme?: import('..').Theme | undefined
 												/**
 												 * Reference to internal Tweakpane
 												 * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
@@ -213,7 +213,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 												 */
 												ref?:
 													| import('../internal/GenericMonitor.svelte').GenericMonitorRef
-													| undefined;
+													| undefined
 												/**
 												 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
 												 * the `<Binding>`'s containing `<Pane>`.
@@ -225,7 +225,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 												 *
 												 * @default `undefined`
 												 */
-												plugin?: import('..').Plugin | undefined;
+												plugin?: import('..').Plugin | undefined
 											},
 											'object' | 'key'
 										>,
@@ -237,7 +237,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 										 * A value to monitor.
 										 * @bindable
 										 */
-										value: boolean;
+										value: boolean
 									} & Omit<
 										{
 											/**
@@ -245,14 +245,14 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 											 * @default `1`  \
 											 * Or `64` if value is `number` and `graph` is `true`.
 											 */
-											bufferSize?: number;
+											bufferSize?: number
 											/**
 											 * Time between value samples in milliseconds.
 											 *
 											 * Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
 											 * @default `0`
 											 */
-											interval?: number;
+											interval?: number
 											/**
 											 * Number of visible rows of state history.
 											 *
@@ -261,32 +261,32 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 											 * @default `1`  \
 											 * Or `3` if value is `string` and `multiline` is `true`.
 											 */
-											rows?: number;
+											rows?: number
 										} & {
 											/**
 											 * A value to monitor.
 											 * @bindable
 											 */
-											value: boolean;
+											value: boolean
 										} & 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, boolean>
 													/** The key for the value in the target `object` that the control should manipulate. */
-													key: string;
+													key: string
 													/**
 													 * Prevent interactivity and gray out the control.
 													 * @default `false`
 													 */
-													disabled?: boolean;
+													disabled?: boolean
 													/**
 													 * Text displayed next to control.
 													 * @default `undefined`
 													 */
-													label?: string | undefined;
+													label?: string | undefined
 													/**
 													 * Tweakpane's internal options object.
 													 *
@@ -299,7 +299,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 													 * Tweakpane UI_.
 													 * @default `undefined`
 													 */
-													options?: import('tweakpane').BooleanMonitorParams | undefined;
+													options?: import('tweakpane').BooleanMonitorParams | undefined
 													/**
 													 * Custom color scheme.
 													 *
@@ -307,7 +307,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 													 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
 													 * set with `setGlobalDefaultTheme()`.
 													 */
-													theme?: import('..').Theme | undefined;
+													theme?: import('..').Theme | undefined
 													/**
 													 * Reference to internal Tweakpane
 													 * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
@@ -323,7 +323,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 													 */
 													ref?:
 														| import('../internal/GenericMonitor.svelte').GenericMonitorRef
-														| undefined;
+														| undefined
 													/**
 													 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
 													 * the `<Binding>`'s containing `<Pane>`.
@@ -335,7 +335,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 													 *
 													 * @default `undefined`
 													 */
-													plugin?: import('..').Plugin | undefined;
+													plugin?: import('..').Plugin | undefined
 												},
 												'object' | 'key'
 											>,
@@ -347,28 +347,28 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 											 * A value to monitor.
 											 * @bindable
 											 */
-											value: number;
+											value: number
 											/**
 											 * Minimum bound when `graph` is true.
 											 * @default `0`
 											 */
-											min?: number;
+											min?: number
 											/**
 											 * Maximum bound when `graph` is true.
 											 * @default `100`
 											 */
-											max?: number;
+											max?: number
 											/**
 											 * A function to customize the number's string representation (e.g. rounding, etc.).
 											 * @default `undefined`  \
 											 * Normal `.toString()` formatting.
 											 */
-											format?: (value: number) => string;
+											format?: (value: number) => string
 											/**
 											 * Display a graph of the value's changes over time.
 											 * @default `false`
 											 */
-											graph?: boolean;
+											graph?: boolean
 										} & Omit<
 											{
 												/**
@@ -376,14 +376,14 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 												 * @default `1`  \
 												 * Or `64` if value is `number` and `graph` is `true`.
 												 */
-												bufferSize?: number;
+												bufferSize?: number
 												/**
 												 * Time between value samples in milliseconds.
 												 *
 												 * Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
 												 * @default `0`
 												 */
-												interval?: number;
+												interval?: number
 												/**
 												 * Number of visible rows of state history.
 												 *
@@ -392,32 +392,32 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 												 * @default `1`  \
 												 * Or `3` if value is `string` and `multiline` is `true`.
 												 */
-												rows?: number;
+												rows?: number
 											} & {
 												/**
 												 * A value to monitor.
 												 * @bindable
 												 */
-												value: number;
+												value: number
 											} & 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, number>
 														/** The key for the value in the target `object` that the control should manipulate. */
-														key: string;
+														key: string
 														/**
 														 * Prevent interactivity and gray out the control.
 														 * @default `false`
 														 */
-														disabled?: boolean;
+														disabled?: boolean
 														/**
 														 * Text displayed next to control.
 														 * @default `undefined`
 														 */
-														label?: string | undefined;
+														label?: string | undefined
 														/**
 														 * Tweakpane's internal options object.
 														 *
@@ -430,7 +430,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 														 * Tweakpane UI_.
 														 * @default `undefined`
 														 */
-														options?: import('tweakpane').NumberMonitorParams | undefined;
+														options?: import('tweakpane').NumberMonitorParams | undefined
 														/**
 														 * Custom color scheme.
 														 *
@@ -438,7 +438,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 														 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
 														 * set with `setGlobalDefaultTheme()`.
 														 */
-														theme?: import('..').Theme | undefined;
+														theme?: import('..').Theme | undefined
 														/**
 														 * Reference to internal Tweakpane
 														 * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
@@ -454,7 +454,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 														 */
 														ref?:
 															| import('../internal/GenericMonitor.svelte').GenericMonitorRef
-															| undefined;
+															| undefined
 														/**
 														 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
 														 * the `<Binding>`'s containing `<Pane>`.
@@ -466,7 +466,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 														 *
 														 * @default `undefined`
 														 */
-														plugin?: import('..').Plugin | undefined;
+														plugin?: import('..').Plugin | undefined
 													},
 													'object' | 'key'
 												>,
@@ -477,7 +477,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 											 * A value to monitor.
 											 * @bindable
 											 * */
-											value: boolean | number | string;
+											value: boolean | number | string
 										}
 						: never
 					: never)
@@ -488,14 +488,14 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 					 * @default `1`  \
 					 * Or `64` if value is `number` and `graph` is `true`.
 					 */
-					bufferSize?: number;
+					bufferSize?: number
 					/**
 					 * Time between value samples in milliseconds.
 					 *
 					 * Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
 					 * @default `0`
 					 */
-					interval?: number;
+					interval?: number
 					/**
 					 * Number of visible rows of state history.
 					 *
@@ -504,33 +504,32 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 					 * @default `1`  \
 					 * Or `3` if value is `string` and `multiline` is `true`.
 					 */
-					rows?: number;
+					rows?: number
 				} & {
 					/**
 					 * A value to monitor.
 					 * @bindable
 					 */
-					value: string | number | boolean;
+					value: string | number | boolean
 				} & Omit<
 						{
 							/**
 							 * The binding's target object with values to manipulate.
 							 * @bindable
 							 */
-							object: import('@tweakpane/core').Bindable &
-								Record<string, string | number | boolean>;
+							object: import('@tweakpane/core').Bindable & Record<string, string | number | boolean>
 							/** The key for the value in the target `object` that the control should manipulate. */
-							key: string;
+							key: string
 							/**
 							 * Prevent interactivity and gray out the control.
 							 * @default `false`
 							 */
-							disabled?: boolean;
+							disabled?: boolean
 							/**
 							 * Text displayed next to control.
 							 * @default `undefined`
 							 */
-							label?: string | undefined;
+							label?: string | undefined
 							/**
 							 * Tweakpane's internal options object.
 							 *
@@ -547,7 +546,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 								| import('tweakpane').BooleanMonitorParams
 								| import('tweakpane').NumberMonitorParams
 								| import('tweakpane').StringMonitorParams
-								| undefined;
+								| undefined
 							/**
 							 * Custom color scheme.
 							 *
@@ -555,7 +554,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
 							 * set with `setGlobalDefaultTheme()`.
 							 */
-							theme?: import('..').Theme | undefined;
+							theme?: import('..').Theme | undefined
 							/**
 							 * Reference to internal Tweakpane
 							 * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
@@ -569,7 +568,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 * @bindable
 							 * @readonly
 							 */
-							ref?: import('../internal/GenericMonitor.svelte').GenericMonitorRef | undefined;
+							ref?: import('../internal/GenericMonitor.svelte').GenericMonitorRef | undefined
 							/**
 							 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
 							 * the `<Binding>`'s containing `<Pane>`.
@@ -581,26 +580,26 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 *
 							 * @default `undefined`
 							 */
-							plugin?: import('..').Plugin | undefined;
+							plugin?: import('..').Plugin | undefined
 						},
 						'object' | 'key'
 					>,
 				'ref' | 'options' | 'plugin'
-			>;
+			>
 	events(): {} & {
-		[evt: string]: CustomEvent<any>;
-	};
-	slots(): {};
+		[evt: string]: CustomEvent<any>
+	}
+	slots(): {}
 }
 export type MonitorProps<W extends number | string | boolean | unknown> = ReturnType<
 	__sveltets_Render<W>['props']
->;
+>
 export type MonitorEvents<W extends number | string | boolean | unknown> = ReturnType<
 	__sveltets_Render<W>['events']
->;
+>
 export type MonitorSlots<W extends number | string | boolean | unknown> = ReturnType<
 	__sveltets_Render<W>['slots']
->;
+>
 /**
  * Wraps the Tweakpane [monitor binding](https://tweakpane.github.io/docs/monitor-bindings/)
  * functionality for `boolean`, `number`, and `string` values.
@@ -626,20 +625,20 @@ export type MonitorSlots<W extends number | string | boolean | unknown> = Return
  * @example
  * ```svelte
  * <script lang="ts">
- * import { Monitor } from 'svelte-tweakpane-ui';
+ * import { Monitor } from 'svelte-tweakpane-ui'
  *
- * let booleanToMonitor = false;
- * let stringToMonitor = 'Reticulating';
- * let numberToMonitor = 85;
+ * let booleanToMonitor = false
+ * let stringToMonitor = 'Reticulating'
+ * let numberToMonitor = 85
  *
  * setInterval(() => {
- *   numberToMonitor = Math.random() * 100;
- * }, 100);
+ *   numberToMonitor = Math.random() * 100
+ * }, 100)
  *
  * setInterval(() => {
- *   booleanToMonitor = !booleanToMonitor;
- *   stringToMonitor = [...stringToMonitor].reverse().join('');
- * }, 1000);
+ *   booleanToMonitor = !booleanToMonitor
+ *   stringToMonitor = [...stringToMonitor].reverse().join('')
+ * }, 1000)
  * </script>
  *
  * <Monitor value={numberToMonitor} graph={true} />
@@ -660,4 +659,4 @@ export default class Monitor<W extends number | string | boolean | unknown> exte
 	MonitorEvents<W>,
 	MonitorSlots<W>
 > {}
-export {};
+export {}