svelte-tweakpane-ui 1.2.2 → 1.2.4

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

@@ -36,138 +36,138 @@ 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;
+		/**
+		 * How to calculate the delta value.
+		 *
+		 * `'frame'` takes only the latest sample into account, while `'mean'` and `'median'` are
+		 * calculated from the samples in the buffer.
+		 * @default `'mean'`
+		 */
+		calcMode?: ProfilerCalcMode | undefined;
+		/**
+		 * Label suffix for the delta values shown in the control.
+		 *
+		 * Possibly useful if you're using a custom `ProfilerBladeDefaultMeasureHandler` and are
+		 * measuring something other than time.
+		 * @default `'ms'`
+		 * */
+		deltaUnit?: string | undefined;
+		/**
+		 * Precision of the delta values shown in the control.
+		 * @default `2`
+		 */
+		fractionDigits?: number | undefined;
+		/**
+		 * Milliseconds between updates to the profiler visualization and delta label text.
+		 *
+		 * Note that this does not affect the internal sampling rate of the profiler itself, which
+		 * is determined by your calls to the bound `measure` function.
+		 * @default `500`
+		 */
+		interval?: number | undefined;
+		/**
+		 * Text displayed next to the profiler visualization.
+		 * @default `undefined`
+		 * */
+		label?: string | undefined;
+		/**
+		 * Function handle that wraps another function to measure its execution duration.
+		 *
+		 *  If you want to measure something other than execution duration, customize
+		 * `ProfilerBladeDefaultMeasureHandler`.
+		 *
+		 * @example `measure('Hard Work', () => { ... })`;
+		 *
+		 * @bindable
+		 * @readonly
+		 * @default `undefined`
+		 */
+		measure?: ProfilerMeasure | undefined;
+		/**
+		 * Async variation of function handle that wraps another function to measure its execution
+		 * duration.
+		 *
+		 * @example `measureAsync('Hard Work', async () => { ... })`;
+		 *
+		 * @bindable
+		 * @async
+		 * @readonly
+		 * @default `undefined`
+		 */
+		measureAsync?: ProfilerMeasureAsync | undefined;
+		/**
+		 * Function wrapping the `measure` function.
+		 *
+		 * The default is fine for most cases when you want to measure a temporal duration.
+		 * @default [`new
+		 * ProfilerBladeDefaultMeasureHandler()`](https://github.com/0b5vr/tweakpane-plugin-profiler/blob/dev/src/ProfilerBladeDefaultMeasureHandler.ts)
+		 */
+		measureHandler?:
+			| {
+					measureStart: () => () => number | Promise<number>;
+			  }
+			| undefined;
+		/**
+		 * Determines the horizontal scale and color mapping of the profiler visualization bars.
+		 * @default `16.67`  \
+		 * 60fps.
+		 */
+		targetDelta?: number | undefined;
 	} & 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'
-	> & {
-			/**
-			 * Number of duration samples from which to calculate the delta value when `calcMode` is
-			 * `'mean'` or `'median'`.
-			 * @default `30`
-			 */
-			bufferSize?: number | undefined;
-			/**
-			 * How to calculate the delta value.
-			 *
-			 * `'frame'` takes only the latest sample into account, while `'mean'` and `'median'` are
-			 * calculated from the samples in the buffer.
-			 * @default `'mean'`
-			 */
-			calcMode?: ProfilerCalcMode | undefined;
-			/**
-			 * Label suffix for the delta values shown in the control.
-			 *
-			 * Possibly useful if you're using a custom `ProfilerBladeDefaultMeasureHandler` and are
-			 * measuring something other than time.
-			 * @default `'ms'`
-			 * */
-			deltaUnit?: string | undefined;
-			/**
-			 * Precision of the delta values shown in the control.
-			 * @default `2`
-			 */
-			fractionDigits?: number | undefined;
-			/**
-			 * Milliseconds between updates to the profiler visualization and delta label text.
-			 *
-			 * Note that this does not affect the internal sampling rate of the profiler itself, which
-			 * is determined by your calls to the bound `measure` function.
-			 * @default `500`
-			 */
-			interval?: number | undefined;
-			/**
-			 * Text displayed next to the profiler visualization.
-			 * @default `undefined`
-			 * */
-			label?: string | undefined;
-			/**
-			 * Function handle that wraps another function to measure its execution duration.
-			 *
-			 *  If you want to measure something other than execution duration, customize
-			 * `ProfilerBladeDefaultMeasureHandler`.
-			 *
-			 * @example `measure('Hard Work', () => { ... })`;
-			 *
-			 * @bindable
-			 * @readonly
-			 * @default `undefined`
-			 */
-			measure?: ProfilerMeasure | undefined;
-			/**
-			 * Async variation of function handle that wraps another function to measure its execution
-			 * duration.
-			 *
-			 * @example `measureAsync('Hard Work', async () => { ... })`;
-			 *
-			 * @bindable
-			 * @async
-			 * @readonly
-			 * @default `undefined`
-			 */
-			measureAsync?: ProfilerMeasureAsync | undefined;
-			/**
-			 * Function wrapping the `measure` function.
-			 *
-			 * The default is fine for most cases when you want to measure a temporal duration.
-			 * @default [`new
-			 * ProfilerBladeDefaultMeasureHandler()`](https://github.com/0b5vr/tweakpane-plugin-profiler/blob/dev/src/ProfilerBladeDefaultMeasureHandler.ts)
-			 */
-			measureHandler?:
-				| {
-						measureStart: () => () => number | Promise<number>;
-				  }
-				| undefined;
-			/**
-			 * Determines the horizontal scale and color mapping of the profiler visualization bars.
-			 * @default `16.67`  \
-			 * 60fps.
-			 */
-			targetDelta?: number | undefined;
-		};
+			{
+				/**
+				 * 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'
+		>;
 	slots: {};
 	events: {
 		/**

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

@@ -2,88 +2,29 @@ import { SvelteComponent } from 'svelte';
 export type WaveformMonitorValue = Uint8Array | Uint16Array | Uint32Array | number[];
 import type { WaveformStyles as WaveformMonitorLineStyle } from 'tweakpane-plugin-waveform/dist/types/view/waveform.js';
 declare const __propDef: {
-	props: Omit<
-		Omit<
-			{
-				/**
-				 * The binding's target object with values to manipulate.
-				 * @bindable
-				 */
-				object: import('@tweakpane/core').Bindable & Record<string, WaveformMonitorValue>;
-				/** 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/core').BaseMonitorParams & {
-							min?: number | undefined;
-							max?: number | undefined;
-							lineStyle?: WaveformMonitorLineStyle | undefined;
-					  })
-					| 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'
-		> & {
-			/**
-			 * Waveform values.
-			 * @bindable
-			 */
-			value: WaveformMonitorValue;
-		} & {
+	props: {
+		/**
+		 * Waveform values.
+		 * @bindable
+		 * */
+		value: WaveformMonitorValue;
+		/**
+		 * Minimum graph bound.
+		 * @default `0`
+		 * */
+		min?: number | undefined;
+		/**
+		 * Maximum graph bound.
+		 * @default `100`
+		 * */
+		max?: number | undefined;
+		/**
+		 * Line style.
+		 * @default `'linear''`
+		 * */
+		lineStyle?: 'linear' | 'bezier' | undefined;
+	} & Omit<
+		{
 			/**
 			 * Number of past states to retain.
 			 * @default `1`  \
@@ -105,34 +46,90 @@ declare const __propDef: {
 			 * @default `1`  \
 			 * Or `3` if value is `string` and `multiline` is `true`.
 			 */
-			rows?: number | undefined /**
+			rows?: number | undefined;
+		} & {
+			/**
 			 * Waveform values.
 			 * @bindable
-			 * */;
-		},
+			 */
+			value: WaveformMonitorValue;
+		} & Omit<
+				{
+					/**
+					 * The binding's target object with values to manipulate.
+					 * @bindable
+					 */
+					object: import('@tweakpane/core').Bindable & Record<string, WaveformMonitorValue>;
+					/** 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?:
+						| ({
+								min?: number | undefined;
+								max?: number | undefined;
+								lineStyle?: WaveformMonitorLineStyle | undefined;
+						  } & 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'
-	> & {
-		/**
-		 * Waveform values.
-		 * @bindable
-		 * */
-		value: WaveformMonitorValue;
-		/**
-		 * Minimum graph bound.
-		 * @default `0`
-		 * */
-		min?: number | undefined;
-		/**
-		 * Maximum graph bound.
-		 * @default `100`
-		 * */
-		max?: number | undefined;
-		/**
-		 * Line style.
-		 * @default `'linear''`
-		 * */
-		lineStyle?: 'linear' | 'bezier' | undefined;
-	};
+	>;
 	events: {
 		[evt: string]: CustomEvent<any>;
 	};

package/dist/theme.d.ts

@@ -1,7 +1,7 @@
 import { type RgbColorObject, type RgbaColorObject } from '@tweakpane/core';
 import type { Simplify } from './utils';
 export type ThemeColorValue = Simplify<RgbColorObject | RgbaColorObject | string>;
-export type Theme = ThemeKeys & CustomThemeKeys;
+export type Theme = CustomThemeKeys & ThemeKeys;
 type ThemeKeys = {
 	baseBackgroundColor?: ThemeColorValue;
 	baseBorderRadius?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-tweakpane-ui",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "type": "module",
   "description": "A Svelte component library wrapping UI elements from Tweakpane, plus some additional functionality for convenience and flexibility.",
   "repository": {
@@ -200,34 +200,34 @@
     "tweakpane-plugin-waveform": "1.0.0"
   },
   "devDependencies": {
-    "@kitschpatrol/shared-config": "^4.5.0",
+    "@kitschpatrol/shared-config": "^4.6.3",
     "@phenomnomnominal/tsquery": "^6.1.3",
-    "@playwright/test": "^1.42.1",
+    "@playwright/test": "^1.43.1",
     "@stkb/rewrap": "^0.1.0",
     "@sveltejs/adapter-static": "^3.0.1",
-    "@sveltejs/kit": "^2.5.2",
-    "@sveltejs/package": "^2.2.7",
-    "@sveltejs/vite-plugin-svelte": "^3.0.2",
-    "@types/eslint": "^8.56.5",
+    "@sveltejs/kit": "^2.5.6",
+    "@sveltejs/package": "^2.3.1",
+    "@sveltejs/vite-plugin-svelte": "^3.1.0",
+    "@types/eslint": "^8.56.10",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.11.25",
+    "@types/node": "^20.12.7",
     "bumpp": "^9.4.0",
     "eslint": "^8.57.0",
     "fs-extra": "^11.2.0",
-    "glob": "^10.3.10",
+    "glob": "^10.3.12",
     "npm-run-all": "^4.1.5",
     "postcss-html": "^1.6.0",
     "publint": "^0.2.7",
     "read-package-up": "^11.0.0",
-    "svelte": "^4.2.12",
-    "svelte-check": "^3.6.6",
-    "svelte-language-server": "^0.16.5",
-    "svelte2tsx": "^0.7.3",
+    "svelte": "^4.2.15",
+    "svelte-check": "^3.6.9",
+    "svelte-language-server": "^0.16.7",
+    "svelte2tsx": "^0.7.6",
     "ts-morph": "^21.0.1",
     "tslib": "^2.6.2",
-    "tsx": "^4.7.1",
+    "tsx": "^4.7.2",
     "typescript": "~5.3.3",
-    "vite": "^5.1.5",
+    "vite": "^5.2.9",
     "yaml": "^2.4.1"
   },
   "scripts": {

package/readme.md

@@ -29,7 +29,7 @@
 [![NPM Package svelte-tweakpane-ui](https://img.shields.io/npm/v/svelte-tweakpane-ui.svg)](https://npmjs.com/package/svelte-tweakpane-ui)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![MadeWithSvelte](https://madewithsvelte.com/storage/repo-shields/4860-shield.svg)](https://madewithsvelte.com/p/svelte-tweakpane-ui/shield-link)
-[![Documentation](https://img.shields.io/badge/-Documentation-ffdd00?logo=readthedocs\&logoColor=222222)](https://kitschpatrol.com/svelte-tweakpane-ui)
+[![Documentation](https://img.shields.io/badge/-Documentation-ffdd00?logo=readthedocs&logoColor=222222)](https://kitschpatrol.com/svelte-tweakpane-ui)
 
 <!-- /badges -->
 
@@ -84,6 +84,6 @@ npm install svelte-tweakpane-ui
 
 <!-- /footer -->
 
-***
+---
 
 _Note: This library is not to be confused with Karl Moore's [`svelte-tweakpane`](https://github.com/pierogis/svelte-tweakpane)._