svelte-tweakpane-ui 1.3.0 → 1.3.1

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

@@ -11,7 +11,7 @@ declare const __propDef: {
 		 * the page.
 		 * @default `undefined`
 		 */
-		begin?: (() => void) | undefined;
+		begin?: () => void;
 		/**
 		 * Function to end a single frame measurement sample.
 		 *
@@ -19,18 +19,18 @@ declare const __propDef: {
 		 * the page.
 		 * @default `undefined`
 		 */
-		end?: (() => void) | undefined;
-	} & {
+		end?: () => void;
+	} & ({
 		/**
 		 * Lower bound of the FPS graph.
 		 * @default `0`
 		 * */
-		min?: number | undefined;
+		min?: number;
 		/**
 		 * Upper bound of the FPS graph.
 		 * @default `90`
 		 * */
-		max?: number | undefined;
+		max?: number;
 		/**
 		 * Function to start a single frame measurement sample.
 		 *
@@ -38,7 +38,7 @@ declare const __propDef: {
 		 * the page.
 		 * @default `undefined`
 		 * */
-		begin?: (() => void) | undefined;
+		begin?: () => void;
 		/**
 		 * Function to end a single frame measurement sample.
 		 *
@@ -46,70 +46,70 @@ declare const __propDef: {
 		 * the page.
 		 * @default `undefined`
 		 * */
-		end?: (() => void) | undefined;
+		end?: () => void;
 		/**
 		 * Time in milliseconds between updates to the graph.
 		 * @default `1000`
 		 * */
-		interval?: number | undefined;
+		interval?: number;
 		/**
 		 * Text displayed next to the FPS graph.
 		 * @default `undefined`
 		 * */
-		label?: string | undefined;
+		label?: string;
 		/**
 		 * Height of the FPS graph, in rows.
 		 * @default `2`
 		 * */
-		rows?: number | undefined;
+		rows?: number;
 	} & Omit<
-			{
-				/**
-				 * Blade configuration exposing Tweakpane's internal
-				 * [`BladeParams`](https://tweakpane.github.io/docs/api/interfaces/BaseBladeParams.html).
-				 *
-				 */
-				options: FpsGraphOptions;
-				/**
-				 * Prevent interactivity and gray out the control.
-				 * @default `false`
-				 */
-				disabled?: boolean | 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
-				 * [`BladeApi`](https://tweakpane.github.io/docs/api/classes/BladeApi.html) for this blade.
-				 *
-				 * This property is exposed for advanced use cases only, such as when implementing convenience
-				 * components wrapping `<Blade>`'s functionality.
-				 *
-				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-				 *
-				 * @bindable
-				 * @readonly
-				 */
-				ref?: FpsGraphRef | undefined;
-				/**
-				 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
-				 * the `<Blade>`'s containing `<Pane>`.
-				 *
-				 * This property is exposed for advanced use cases only, such as when implementing convenience
-				 * 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('tweakpane').TpPluginBundle | undefined;
-			},
-			'ref' | 'options' | 'plugin'
-		>;
+		{
+			/**
+			 * Blade configuration exposing Tweakpane's internal
+			 * [`BladeParams`](https://tweakpane.github.io/docs/api/interfaces/BaseBladeParams.html).
+			 *
+			 */
+			options: FpsGraphOptions;
+			/**
+			 * Prevent interactivity and gray out the control.
+			 * @default `false`
+			 */
+			disabled?: boolean;
+			/**
+			 * 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
+			 * [`BladeApi`](https://tweakpane.github.io/docs/api/classes/BladeApi.html) for this blade.
+			 *
+			 * This property is exposed for advanced use cases only, such as when implementing convenience
+			 * components wrapping `<Blade>`'s functionality.
+			 *
+			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
+			 *
+			 * @bindable
+			 * @readonly
+			 */
+			ref?: FpsGraphRef | undefined;
+			/**
+			 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
+			 * the `<Blade>`'s containing `<Pane>`.
+			 *
+			 * This property is exposed for advanced use cases only, such as when implementing convenience
+			 * 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.js').Plugin | undefined;
+		},
+		'ref' | 'options' | 'plugin'
+	>);
 	slots: {};
 	events: {
 		/**

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

@@ -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 | undefined;
+					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 | undefined;
+					interval?: number;
 					/**
 					 * Number of visible rows of state history.
 					 *
@@ -24,7 +24,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 					 * @default `1`  \
 					 * Or `3` if value is `string` and `multiline` is `true`.
 					 */
-					rows?: number | undefined;
+					rows?: number;
 				} & {
 					/**
 					 * A value to monitor.
@@ -44,7 +44,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 * Prevent interactivity and gray out the control.
 							 * @default `false`
 							 */
-							disabled?: boolean | undefined;
+							disabled?: boolean;
 							/**
 							 * Text displayed next to control.
 							 * @default `undefined`
@@ -108,7 +108,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 *
 							 * @default `undefined`
 							 */
-							plugin?: import('tweakpane').TpPluginBundle | undefined;
+							plugin?: import('..').Plugin | undefined;
 						},
 						'object' | 'key'
 					>,
@@ -127,7 +127,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 									 * Display multiline strings.
 									 * @default `false`
 									 */
-									multiline?: boolean | undefined;
+									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 | undefined;
+										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 | undefined;
+										interval?: number;
 										/**
 										 * Number of visible rows of state history.
 										 *
@@ -151,7 +151,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 										 * @default `1`  \
 										 * Or `3` if value is `string` and `multiline` is `true`.
 										 */
-										rows?: number | undefined;
+										rows?: number;
 									} & {
 										/**
 										 * A value to monitor.
@@ -171,7 +171,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 												 * Prevent interactivity and gray out the control.
 												 * @default `false`
 												 */
-												disabled?: boolean | undefined;
+												disabled?: boolean;
 												/**
 												 * Text displayed next to control.
 												 * @default `undefined`
@@ -225,7 +225,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 												 *
 												 * @default `undefined`
 												 */
-												plugin?: import('tweakpane').TpPluginBundle | undefined;
+												plugin?: import('..').Plugin | undefined;
 											},
 											'object' | 'key'
 										>,
@@ -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 | undefined;
+											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 | undefined;
+											interval?: number;
 											/**
 											 * Number of visible rows of state history.
 											 *
@@ -261,7 +261,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 											 * @default `1`  \
 											 * Or `3` if value is `string` and `multiline` is `true`.
 											 */
-											rows?: number | undefined;
+											rows?: number;
 										} & {
 											/**
 											 * A value to monitor.
@@ -281,7 +281,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 													 * Prevent interactivity and gray out the control.
 													 * @default `false`
 													 */
-													disabled?: boolean | undefined;
+													disabled?: boolean;
 													/**
 													 * Text displayed next to control.
 													 * @default `undefined`
@@ -335,7 +335,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 													 *
 													 * @default `undefined`
 													 */
-													plugin?: import('tweakpane').TpPluginBundle | undefined;
+													plugin?: import('..').Plugin | undefined;
 												},
 												'object' | 'key'
 											>,
@@ -352,23 +352,23 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 											 * Minimum bound when `graph` is true.
 											 * @default `0`
 											 */
-											min?: number | undefined;
+											min?: number;
 											/**
 											 * Maximum bound when `graph` is true.
 											 * @default `100`
 											 */
-											max?: number | undefined;
+											max?: number;
 											/**
 											 * A function to customize the number's string representation (e.g. rounding, etc.).
 											 * @default `undefined`  \
 											 * Normal `.toString()` formatting.
 											 */
-											format?: ((value: number) => string) | undefined;
+											format?: (value: number) => string;
 											/**
 											 * Display a graph of the value's changes over time.
 											 * @default `false`
 											 */
-											graph?: boolean | undefined;
+											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 | undefined;
+												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 | undefined;
+												interval?: number;
 												/**
 												 * Number of visible rows of state history.
 												 *
@@ -392,7 +392,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 												 * @default `1`  \
 												 * Or `3` if value is `string` and `multiline` is `true`.
 												 */
-												rows?: number | undefined;
+												rows?: number;
 											} & {
 												/**
 												 * A value to monitor.
@@ -412,7 +412,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 														 * Prevent interactivity and gray out the control.
 														 * @default `false`
 														 */
-														disabled?: boolean | undefined;
+														disabled?: boolean;
 														/**
 														 * Text displayed next to control.
 														 * @default `undefined`
@@ -466,7 +466,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 														 *
 														 * @default `undefined`
 														 */
-														plugin?: import('tweakpane').TpPluginBundle | 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: string | number | boolean;
+											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 | undefined;
+					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 | undefined;
+					interval?: number;
 					/**
 					 * Number of visible rows of state history.
 					 *
@@ -504,7 +504,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 					 * @default `1`  \
 					 * Or `3` if value is `string` and `multiline` is `true`.
 					 */
-					rows?: number | undefined;
+					rows?: number;
 				} & {
 					/**
 					 * A value to monitor.
@@ -525,7 +525,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 * Prevent interactivity and gray out the control.
 							 * @default `false`
 							 */
-							disabled?: boolean | undefined;
+							disabled?: boolean;
 							/**
 							 * Text displayed next to control.
 							 * @default `undefined`
@@ -581,7 +581,7 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
 							 *
 							 * @default `undefined`
 							 */
-							plugin?: import('tweakpane').TpPluginBundle | undefined;
+							plugin?: import('..').Plugin | undefined;
 						},
 						'object' | 'key'
 					>,

package/dist/monitor/Profiler.svelte

@@ -1,10 +1,10 @@
 <script context="module"></script>
 
 <script>
-	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-profiler';
 	import Blade from '../core/Blade.svelte';
 	import ClsPad from '../internal/ClsPad.svelte';
 	import { fillWith } from '../utils';
+	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-profiler';
 	import { BROWSER } from 'esm-env';
 	import { createEventDispatcher, onDestroy } from 'svelte';
 	function _measure(name, functionToMeasure) {

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

@@ -1,6 +1,6 @@
 import { SvelteComponent } from 'svelte';
-import type { ProfilerBladeMeasureHandler } from '@kitschpatrol/tweakpane-plugin-profiler';
 import type { Simplify } from '../utils';
+import type { ProfilerBladeMeasureHandler } from '@kitschpatrol/tweakpane-plugin-profiler';
 export type ProfilerCalcMode = 'frame' | 'mean' | 'median';
 export type ProfilerMeasure = (name: string, functionToMeasure: () => void) => void;
 export type ProfilerMeasureAsync = (
@@ -36,13 +36,13 @@ declare const __propDef: {
 		 * @default `undefined`
 		 */
 		measureAsync?: ProfilerMeasureAsync | undefined;
-	} & {
+	} & ({
 		/**
 		 * Number of duration samples from which to calculate the delta value when `calcMode` is
 		 * `'mean'` or `'median'`.
 		 * @default `30`
 		 */
-		bufferSize?: number | undefined;
+		bufferSize?: number;
 		/**
 		 * How to calculate the delta value.
 		 *
@@ -50,7 +50,7 @@ declare const __propDef: {
 		 * calculated from the samples in the buffer.
 		 * @default `'mean'`
 		 */
-		calcMode?: ProfilerCalcMode | undefined;
+		calcMode?: ProfilerCalcMode;
 		/**
 		 * Label suffix for the delta values shown in the control.
 		 *
@@ -58,12 +58,12 @@ declare const __propDef: {
 		 * measuring something other than time.
 		 * @default `'ms'`
 		 * */
-		deltaUnit?: string | undefined;
+		deltaUnit?: string;
 		/**
 		 * Precision of the delta values shown in the control.
 		 * @default `2`
 		 */
-		fractionDigits?: number | undefined;
+		fractionDigits?: number;
 		/**
 		 * Milliseconds between updates to the profiler visualization and delta label text.
 		 *
@@ -71,12 +71,12 @@ declare const __propDef: {
 		 * is determined by your calls to the bound `measure` function.
 		 * @default `500`
 		 */
-		interval?: number | undefined;
+		interval?: number;
 		/**
 		 * Text displayed next to the profiler visualization.
 		 * @default `undefined`
 		 * */
-		label?: string | undefined;
+		label?: string;
 		/**
 		 * Function handle that wraps another function to measure its execution duration.
 		 *
@@ -89,7 +89,7 @@ declare const __propDef: {
 		 * @readonly
 		 * @default `undefined`
 		 */
-		measure?: ProfilerMeasure | undefined;
+		measure?: ProfilerMeasure;
 		/**
 		 * Async variation of function handle that wraps another function to measure its execution
 		 * duration.
@@ -101,7 +101,7 @@ declare const __propDef: {
 		 * @readonly
 		 * @default `undefined`
 		 */
-		measureAsync?: ProfilerMeasureAsync | undefined;
+		measureAsync?: ProfilerMeasureAsync;
 		/**
 		 * Function wrapping the `measure` function.
 		 *
@@ -109,65 +109,61 @@ declare const __propDef: {
 		 * @default [`new
 		 * ProfilerBladeDefaultMeasureHandler()`](https://github.com/kitschpatrol/tweakpane-plugin-profiler/blob/dev/src/ProfilerBladeDefaultMeasureHandler.ts)
 		 */
-		measureHandler?:
-			| {
-					measureStart: () => () => number | Promise<number>;
-			  }
-			| undefined;
+		measureHandler?: ProfilerMeasureHandler;
 		/**
 		 * Determines the horizontal scale and color mapping of the profiler visualization bars.
 		 * @default `16.67`  \
 		 * 60fps.
 		 */
-		targetDelta?: number | undefined;
+		targetDelta?: number;
 	} & Omit<
-			{
-				/**
-				 * Blade configuration exposing Tweakpane's internal
-				 * [`BladeParams`](https://tweakpane.github.io/docs/api/interfaces/BaseBladeParams.html).
-				 *
-				 */
-				options: ProfilerOptions;
-				/**
-				 * Prevent interactivity and gray out the control.
-				 * @default `false`
-				 */
-				disabled?: boolean | 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
-				 * [`BladeApi`](https://tweakpane.github.io/docs/api/classes/BladeApi.html) for this blade.
-				 *
-				 * This property is exposed for advanced use cases only, such as when implementing convenience
-				 * components wrapping `<Blade>`'s functionality.
-				 *
-				 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
-				 *
-				 * @bindable
-				 * @readonly
-				 */
-				ref?: ProfilerRef | undefined;
-				/**
-				 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
-				 * the `<Blade>`'s containing `<Pane>`.
-				 *
-				 * This property is exposed for advanced use cases only, such as when implementing convenience
-				 * 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('tweakpane').TpPluginBundle | undefined;
-			},
-			'ref' | 'options' | 'plugin'
-		>;
+		{
+			/**
+			 * Blade configuration exposing Tweakpane's internal
+			 * [`BladeParams`](https://tweakpane.github.io/docs/api/interfaces/BaseBladeParams.html).
+			 *
+			 */
+			options: ProfilerOptions;
+			/**
+			 * Prevent interactivity and gray out the control.
+			 * @default `false`
+			 */
+			disabled?: boolean;
+			/**
+			 * 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
+			 * [`BladeApi`](https://tweakpane.github.io/docs/api/classes/BladeApi.html) for this blade.
+			 *
+			 * This property is exposed for advanced use cases only, such as when implementing convenience
+			 * components wrapping `<Blade>`'s functionality.
+			 *
+			 * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
+			 *
+			 * @bindable
+			 * @readonly
+			 */
+			ref?: ProfilerRef | undefined;
+			/**
+			 * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
+			 * the `<Blade>`'s containing `<Pane>`.
+			 *
+			 * This property is exposed for advanced use cases only, such as when implementing convenience
+			 * 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;
+		},
+		'ref' | 'options' | 'plugin'
+	>);
 	slots: {};
 	events: {
 		/**
@@ -189,8 +185,8 @@ export type ProfilerSlots = typeof __propDef.slots;
  * Configured to measure a function's execution duration by default, but can be customized to measure
  * anything.
  *
- * Integrates [kitschpatrol's](https://kitschpatrol.com)
- * [tweakpane-plugin-profiler](https://github.com/kitschpatrol/tweakpane-plugin-profiler).
+ * Integrates [0b5vr's](https://0b5vr.com)
+ * [tweakpane-plugin-profiler](https://github.com/0b5vr/tweakpane-plugin-profiler).
  *
  * See `<FpsGraph>` for a simpler alternative optimized for framerate visualization.
  *

package/dist/monitor/WaveformMonitor.svelte

@@ -1,10 +1,10 @@
 <script context="module"></script>
 
 <script>
-	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-waveform';
 	import ClsPad from '../internal/ClsPad.svelte';
 	import GenericMonitor from '../internal/GenericMonitor.svelte';
 	import { fillWith } from '../utils';
+	import * as pluginModule from '@kitschpatrol/tweakpane-plugin-waveform';
 	import { BROWSER } from 'esm-env';
 	export let value;
 	export let max = void 0;