svelte-tweakpane-ui 1.2.2 → 1.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/dist/control/Button.svelte +1 -1
  2. package/dist/control/ButtonGrid.svelte.d.ts +30 -30
  3. package/dist/control/Checkbox.svelte.d.ts +8 -8
  4. package/dist/control/Color.svelte.d.ts +96 -96
  5. package/dist/control/CubicBezier.svelte.d.ts +41 -41
  6. package/dist/control/Image.svelte.d.ts +30 -30
  7. package/dist/control/IntervalSlider.svelte.d.ts +105 -95
  8. package/dist/control/List.svelte.d.ts +20 -20
  9. package/dist/control/Point.svelte +1 -1
  10. package/dist/control/Point.svelte.d.ts +115 -114
  11. package/dist/control/RadioGrid.svelte +1 -1
  12. package/dist/control/RadioGrid.svelte.d.ts +59 -59
  13. package/dist/control/Ring.svelte.d.ts +102 -107
  14. package/dist/control/RotationEuler.svelte +1 -1
  15. package/dist/control/RotationEuler.svelte.d.ts +106 -106
  16. package/dist/control/RotationQuaternion.svelte +1 -1
  17. package/dist/control/RotationQuaternion.svelte.d.ts +104 -104
  18. package/dist/control/Slider.svelte.d.ts +84 -84
  19. package/dist/control/Text.svelte.d.ts +24 -24
  20. package/dist/control/Textarea.svelte +1 -1
  21. package/dist/control/Textarea.svelte.d.ts +33 -33
  22. package/dist/control/Wheel.svelte.d.ts +97 -97
  23. package/dist/core/Binding.svelte +1 -1
  24. package/dist/core/Blade.svelte +1 -1
  25. package/dist/core/Pane.svelte.d.ts +295 -275
  26. package/dist/extra/AutoValue.svelte.d.ts +8 -8
  27. package/dist/extra/Element.svelte.d.ts +23 -23
  28. package/dist/internal/ClsPad.svelte +1 -1
  29. package/dist/internal/GenericBinding.svelte.d.ts +8 -8
  30. package/dist/internal/GenericBladeFolding.svelte.d.ts +24 -24
  31. package/dist/internal/GenericInput.svelte.d.ts +8 -8
  32. package/dist/internal/GenericInputFolding.svelte.d.ts +78 -78
  33. package/dist/internal/GenericMonitor.svelte.d.ts +76 -76
  34. package/dist/internal/GenericPane.svelte +1 -1
  35. package/dist/internal/GenericSlider.svelte.d.ts +76 -76
  36. package/dist/internal/InternalMonitorBoolean.svelte.d.ts +82 -82
  37. package/dist/internal/InternalMonitorNumber.svelte.d.ts +101 -101
  38. package/dist/internal/InternalMonitorString.svelte.d.ts +87 -87
  39. package/dist/internal/InternalPaneDraggable.svelte.d.ts +76 -76
  40. package/dist/internal/InternalPaneFixed.svelte.d.ts +26 -26
  41. package/dist/internal/InternalPaneInline.svelte.d.ts +13 -13
  42. package/dist/monitor/FpsGraph.svelte.d.ts +90 -90
  43. package/dist/monitor/Monitor.svelte.d.ts +233 -233
  44. package/dist/monitor/Profiler.svelte.d.ts +131 -131
  45. package/dist/monitor/WaveformMonitor.svelte.d.ts +104 -107
  46. package/dist/theme.d.ts +1 -1
  47. package/package.json +15 -15
  48. package/readme.md +2 -2
@@ -2,82 +2,14 @@ import { SvelteComponent } from 'svelte';
2
2
  import type { ValueChangeEvent } from '../utils.js';
3
3
  export type SliderChangeEvent = ValueChangeEvent<number>;
4
4
  declare const __propDef: {
5
- props: Omit<
6
- Omit<
7
- {
8
- /**
9
- * The binding's target object with values to manipulate.
10
- * @bindable
11
- */
12
- object: import('@tweakpane/core').Bindable & Record<string, number>;
13
- /** The key for the value in the target `object` that the control should manipulate. */
14
- key: string;
15
- /**
16
- * Prevent interactivity and gray out the control.
17
- * @default `false`
18
- */
19
- disabled?: boolean | undefined;
20
- /**
21
- * Text displayed next to control.
22
- * @default `undefined`
23
- */
24
- label?: string | undefined;
25
- /**
26
- * Tweakpane's internal options object.
27
- *
28
- * See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
29
- *
30
- * Valid types are contingent on the type of the value `key` points to in `object`.
31
- *
32
- * This is intended internal use, when implementing convenience components wrapping Binding's
33
- * functionality. Options of interest are instead exposed as top-level props in _Svelte
34
- * Tweakpane UI_.
35
- * @default `undefined`
36
- */
37
- options?: import('tweakpane').NumberInputParams | undefined;
38
- /**
39
- * Custom color scheme.
40
- *
41
- * @default `undefined` \
42
- * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
43
- * set with `setGlobalDefaultTheme()`.
44
- */
45
- theme?: import('..').Theme | undefined;
46
- /**
47
- * Reference to internal Tweakpane
48
- * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
49
- * this control.
50
- *
51
- * This property is exposed for advanced use cases only, such as when implementing convenience
52
- * components wrapping `<Binding>`'s functionality.
53
- *
54
- * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
55
- *
56
- * @bindable
57
- * @readonly
58
- */
59
- ref?: import('tweakpane').SliderInputBindingApi | undefined;
60
- /**
61
- * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
62
- * the `<Binding>`'s containing `<Pane>`.
63
- *
64
- * This property is exposed for advanced use cases only, such as when implementing convenience
65
- * components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
66
- *
67
- * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
68
- *
69
- * @default `undefined`
70
- */
71
- plugin?: import('tweakpane').TpPluginBundle | undefined;
72
- },
73
- 'object' | 'key'
74
- > & {
75
- /**
76
- * A `number` value to control.
77
- * @bindable .
78
- */
79
- value: number;
80
- } & {
5
+ props: {
6
+ /**
7
+ * A `number` value to control.
8
+ * @bindable.
9
+ * */
10
+ value: number;
11
+ } & Omit<
12
+ {
81
13
  /**
82
14
  * Minimum value.
83
15
  *
@@ -117,15 +49,83 @@ declare const __propDef: {
117
49
  * No step constraint.
118
50
  */
119
51
  step?: number | undefined;
120
- },
52
+ } & {
53
+ /**
54
+ * A `number` value to control.
55
+ * @bindable .
56
+ */
57
+ value: number;
58
+ } & Omit<
59
+ {
60
+ /**
61
+ * The binding's target object with values to manipulate.
62
+ * @bindable
63
+ */
64
+ object: import('@tweakpane/core').Bindable & Record<string, number>;
65
+ /** The key for the value in the target `object` that the control should manipulate. */
66
+ key: string;
67
+ /**
68
+ * Prevent interactivity and gray out the control.
69
+ * @default `false`
70
+ */
71
+ disabled?: boolean | undefined;
72
+ /**
73
+ * Text displayed next to control.
74
+ * @default `undefined`
75
+ */
76
+ label?: string | undefined;
77
+ /**
78
+ * Tweakpane's internal options object.
79
+ *
80
+ * See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
81
+ *
82
+ * Valid types are contingent on the type of the value `key` points to in `object`.
83
+ *
84
+ * This is intended internal use, when implementing convenience components wrapping Binding's
85
+ * functionality. Options of interest are instead exposed as top-level props in _Svelte
86
+ * Tweakpane UI_.
87
+ * @default `undefined`
88
+ */
89
+ options?: import('tweakpane').NumberInputParams | undefined;
90
+ /**
91
+ * Custom color scheme.
92
+ *
93
+ * @default `undefined` \
94
+ * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
95
+ * set with `setGlobalDefaultTheme()`.
96
+ */
97
+ theme?: import('..').Theme | undefined;
98
+ /**
99
+ * Reference to internal Tweakpane
100
+ * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
101
+ * this control.
102
+ *
103
+ * This property is exposed for advanced use cases only, such as when implementing convenience
104
+ * components wrapping `<Binding>`'s functionality.
105
+ *
106
+ * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
107
+ *
108
+ * @bindable
109
+ * @readonly
110
+ */
111
+ ref?: import('tweakpane').SliderInputBindingApi | undefined;
112
+ /**
113
+ * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
114
+ * the `<Binding>`'s containing `<Pane>`.
115
+ *
116
+ * This property is exposed for advanced use cases only, such as when implementing convenience
117
+ * components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
118
+ *
119
+ * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
120
+ *
121
+ * @default `undefined`
122
+ */
123
+ plugin?: import('tweakpane').TpPluginBundle | undefined;
124
+ },
125
+ 'object' | 'key'
126
+ >,
121
127
  'ref' | 'options' | 'plugin'
122
- > & {
123
- /**
124
- * A `number` value to control.
125
- * @bindable.
126
- * */
127
- value: number;
128
- };
128
+ >;
129
129
  slots: {};
130
130
  events: {
131
131
  /**
@@ -3,8 +3,28 @@ import type { ValueChangeEvent } from '../utils.js';
3
3
  export type TextChangeEvent = ValueChangeEvent<string>;
4
4
  import { type GenericInputRef } from '../internal/GenericInput.svelte';
5
5
  declare const __propDef: {
6
- props: Omit<
7
- Omit<
6
+ props: {
7
+ /**
8
+ * A `string` value to control.
9
+ * @bindable
10
+ * */
11
+ value: string;
12
+ /**
13
+ * Whether to provide live updates to the bound `value` on every keystroke.
14
+ *
15
+ * To match expectations around reactive components, the default here diverges from the
16
+ * vanilla JS Tweakpane behavior, which only updates on blur.
17
+ * @default `true`
18
+ * */
19
+ live?: boolean | undefined;
20
+ } & Omit<
21
+ {
22
+ /**
23
+ * A `string` value to control.
24
+ * @bindable
25
+ */
26
+ value: string;
27
+ } & Omit<
8
28
  {
9
29
  /**
10
30
  * The binding's target object with values to manipulate.
@@ -72,29 +92,9 @@ declare const __propDef: {
72
92
  plugin?: import('tweakpane').TpPluginBundle | undefined;
73
93
  },
74
94
  'object' | 'key'
75
- > & {
76
- /**
77
- * A `string` value to control.
78
- * @bindable
79
- */
80
- value: string;
81
- },
95
+ >,
82
96
  'ref' | 'options' | 'plugin'
83
- > & {
84
- /**
85
- * A `string` value to control.
86
- * @bindable
87
- * */
88
- value: string;
89
- /**
90
- * Whether to provide live updates to the bound `value` on every keystroke.
91
- *
92
- * To match expectations around reactive components, the default here diverges from the
93
- * vanilla JS Tweakpane behavior, which only updates on blur.
94
- * @default `true`
95
- * */
96
- live?: boolean | undefined;
97
- };
97
+ >;
98
98
  slots: {};
99
99
  events: {
100
100
  /**
@@ -54,6 +54,6 @@
54
54
  <GenericInput value={_value} bind:ref {options} plugin={pluginModule} {...$$restProps} />
55
55
  {#if !BROWSER}
56
56
  <!-- TODO magic numbers -->
57
- <div style:height={`calc(${16 * (rows ?? 3)}px - 14px)`} />
57
+ <div style:height={`calc(${16 * (rows ?? 3)}px - 14px)`}></div>
58
58
  <!-- <ClsPad keysAdd={fillWith('containerUnitSize', 1)} theme={$$props.theme} /> -->
59
59
  {/if}
@@ -4,8 +4,37 @@ export type TextareaChangeEvent = ValueChangeEvent<string>;
4
4
  import type { TextareaPluginInputParams } from '@pangenerator/tweakpane-textarea-plugin/dist/types/plugin.js';
5
5
  import { type GenericInputRef } from '../internal/GenericInput.svelte';
6
6
  declare const __propDef: {
7
- props: Omit<
8
- Omit<
7
+ props: {
8
+ /**
9
+ * A `string` value to control.
10
+ * @bindable
11
+ * */
12
+ value: string;
13
+ /**
14
+ * Whether to provide live updates to the bound `value` on every keystroke.
15
+ * @default `true`
16
+ * */
17
+ live?: boolean | undefined;
18
+ /**
19
+ * Placeholder text to display when the `value` is empty.
20
+ * @default `'Enter text here'`
21
+ */
22
+ placeholder?: string | undefined;
23
+ /**
24
+ * The number of lines of text to display.
25
+ *
26
+ * If lines of input exceed this value, then the text area will scroll.
27
+ * @default `3`
28
+ */
29
+ rows?: number | undefined;
30
+ } & Omit<
31
+ {
32
+ /**
33
+ * A `string` value to control.
34
+ * @bindable
35
+ */
36
+ value: string;
37
+ } & Omit<
9
38
  {
10
39
  /**
11
40
  * The binding's target object with values to manipulate.
@@ -73,38 +102,9 @@ declare const __propDef: {
73
102
  plugin?: import('tweakpane').TpPluginBundle | undefined;
74
103
  },
75
104
  'object' | 'key'
76
- > & {
77
- /**
78
- * A `string` value to control.
79
- * @bindable
80
- */
81
- value: string;
82
- },
105
+ >,
83
106
  'ref' | 'options' | 'plugin'
84
- > & {
85
- /**
86
- * A `string` value to control.
87
- * @bindable
88
- * */
89
- value: string;
90
- /**
91
- * Whether to provide live updates to the bound `value` on every keystroke.
92
- * @default `true`
93
- * */
94
- live?: boolean | undefined;
95
- /**
96
- * Placeholder text to display when the `value` is empty.
97
- * @default `'Enter text here'`
98
- */
99
- placeholder?: string | undefined;
100
- /**
101
- * The number of lines of text to display.
102
- *
103
- * If lines of input exceed this value, then the text area will scroll.
104
- * @default `3`
105
- */
106
- rows?: number | undefined;
107
- };
107
+ >;
108
108
  slots: {};
109
109
  events: {
110
110
  /**
@@ -2,82 +2,26 @@ import { SvelteComponent } from 'svelte';
2
2
  import type { ValueChangeEvent } from '../utils.js';
3
3
  export type WheelChangeEvent = ValueChangeEvent<number>;
4
4
  declare const __propDef: {
5
- props: Omit<
6
- Omit<
7
- {
8
- /**
9
- * The binding's target object with values to manipulate.
10
- * @bindable
11
- */
12
- object: import('@tweakpane/core').Bindable & Record<string, number>;
13
- /** The key for the value in the target `object` that the control should manipulate. */
14
- key: string;
15
- /**
16
- * Prevent interactivity and gray out the control.
17
- * @default `false`
18
- */
19
- disabled?: boolean | undefined;
20
- /**
21
- * Text displayed next to control.
22
- * @default `undefined`
23
- */
24
- label?: string | undefined;
25
- /**
26
- * Tweakpane's internal options object.
27
- *
28
- * See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
29
- *
30
- * Valid types are contingent on the type of the value `key` points to in `object`.
31
- *
32
- * This is intended internal use, when implementing convenience components wrapping Binding's
33
- * functionality. Options of interest are instead exposed as top-level props in _Svelte
34
- * Tweakpane UI_.
35
- * @default `undefined`
36
- */
37
- options?: import('tweakpane').NumberInputParams | undefined;
38
- /**
39
- * Custom color scheme.
40
- *
41
- * @default `undefined` \
42
- * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
43
- * set with `setGlobalDefaultTheme()`.
44
- */
45
- theme?: import('..').Theme | undefined;
46
- /**
47
- * Reference to internal Tweakpane
48
- * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
49
- * this control.
50
- *
51
- * This property is exposed for advanced use cases only, such as when implementing convenience
52
- * components wrapping `<Binding>`'s functionality.
53
- *
54
- * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
55
- *
56
- * @bindable
57
- * @readonly
58
- */
59
- ref?: import('tweakpane').SliderInputBindingApi | undefined;
60
- /**
61
- * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
62
- * the `<Binding>`'s containing `<Pane>`.
63
- *
64
- * This property is exposed for advanced use cases only, such as when implementing convenience
65
- * components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
66
- *
67
- * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
68
- *
69
- * @default `undefined`
70
- */
71
- plugin?: import('tweakpane').TpPluginBundle | undefined;
72
- },
73
- 'object' | 'key'
74
- > & {
75
- /**
76
- * A `number` value to control.
77
- * @bindable
78
- */
79
- value: number;
80
- } & {
5
+ props: {
6
+ /**
7
+ * A `number` value to control.
8
+ * @bindable
9
+ * */
10
+ value: number;
11
+ /** The amount of the value to change per pixel of movement.
12
+ * @default `undefined` \
13
+ * [Dynamic based on magnitude of
14
+ * `value`](https://github.com/cocopon/tweakpane/blob/66dfbea04bfe9b7f031673c955ceda1f92356e75/packages/core/src/common/number/util.ts#L54).
15
+ */
16
+ amount?: number | undefined;
17
+ /**
18
+ * When `true`, expand the width of the wheel control at the expense of the numeric input
19
+ * field.
20
+ * @default `false`
21
+ * */
22
+ wide?: boolean | undefined;
23
+ } & Omit<
24
+ {
81
25
  /**
82
26
  * Minimum value.
83
27
  *
@@ -117,27 +61,83 @@ declare const __propDef: {
117
61
  * No step constraint.
118
62
  */
119
63
  step?: number | undefined;
120
- },
64
+ } & {
65
+ /**
66
+ * A `number` value to control.
67
+ * @bindable
68
+ */
69
+ value: number;
70
+ } & Omit<
71
+ {
72
+ /**
73
+ * The binding's target object with values to manipulate.
74
+ * @bindable
75
+ */
76
+ object: import('@tweakpane/core').Bindable & Record<string, number>;
77
+ /** The key for the value in the target `object` that the control should manipulate. */
78
+ key: string;
79
+ /**
80
+ * Prevent interactivity and gray out the control.
81
+ * @default `false`
82
+ */
83
+ disabled?: boolean | undefined;
84
+ /**
85
+ * Text displayed next to control.
86
+ * @default `undefined`
87
+ */
88
+ label?: string | undefined;
89
+ /**
90
+ * Tweakpane's internal options object.
91
+ *
92
+ * See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
93
+ *
94
+ * Valid types are contingent on the type of the value `key` points to in `object`.
95
+ *
96
+ * This is intended internal use, when implementing convenience components wrapping Binding's
97
+ * functionality. Options of interest are instead exposed as top-level props in _Svelte
98
+ * Tweakpane UI_.
99
+ * @default `undefined`
100
+ */
101
+ options?: import('tweakpane').NumberInputParams | undefined;
102
+ /**
103
+ * Custom color scheme.
104
+ *
105
+ * @default `undefined` \
106
+ * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
107
+ * set with `setGlobalDefaultTheme()`.
108
+ */
109
+ theme?: import('..').Theme | undefined;
110
+ /**
111
+ * Reference to internal Tweakpane
112
+ * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
113
+ * this control.
114
+ *
115
+ * This property is exposed for advanced use cases only, such as when implementing convenience
116
+ * components wrapping `<Binding>`'s functionality.
117
+ *
118
+ * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
119
+ *
120
+ * @bindable
121
+ * @readonly
122
+ */
123
+ ref?: import('tweakpane').SliderInputBindingApi | undefined;
124
+ /**
125
+ * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
126
+ * the `<Binding>`'s containing `<Pane>`.
127
+ *
128
+ * This property is exposed for advanced use cases only, such as when implementing convenience
129
+ * components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
130
+ *
131
+ * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
132
+ *
133
+ * @default `undefined`
134
+ */
135
+ plugin?: import('tweakpane').TpPluginBundle | undefined;
136
+ },
137
+ 'object' | 'key'
138
+ >,
121
139
  'ref' | 'options' | 'plugin'
122
- > & {
123
- /**
124
- * A `number` value to control.
125
- * @bindable
126
- * */
127
- value: number;
128
- /** The amount of the value to change per pixel of movement.
129
- * @default `undefined` \
130
- * [Dynamic based on magnitude of
131
- * `value`](https://github.com/cocopon/tweakpane/blob/66dfbea04bfe9b7f031673c955ceda1f92356e75/packages/core/src/common/number/util.ts#L54).
132
- */
133
- amount?: number | undefined;
134
- /**
135
- * When `true`, expand the width of the wheel control at the expense of the numeric input
136
- * field.
137
- * @default `false`
138
- * */
139
- wide?: boolean | undefined;
140
- };
140
+ >;
141
141
  slots: {};
142
142
  events: {
143
143
  /**
@@ -183,7 +183,7 @@ export type WheelSlots = typeof __propDef.slots;
183
183
  * format={(v) => `${(Math.abs(v) % 360).toFixed(0)}°`}
184
184
  * />
185
185
  *
186
- * <div class="demo" style:--a="{angle}deg" />
186
+ * <div class="demo" style:--a="{angle}deg"></div>
187
187
  *
188
188
  * <style>
189
189
  * div.demo {
@@ -80,7 +80,7 @@
80
80
 
81
81
  {#if parentStore}
82
82
  {#if BROWSER}
83
- <div bind:this={indexElement} style="display: none;" />
83
+ <div bind:this={indexElement} style="display: none;"></div>
84
84
  {:else}
85
85
  <ClsPad keysAdd={['containerVerticalPadding', 'containerUnitSize']} {theme} />
86
86
  {/if}
@@ -49,7 +49,7 @@
49
49
 
50
50
  {#if parentStore}
51
51
  {#if BROWSER}
52
- <div bind:this={indexElement} style="display: none;" />
52
+ <div bind:this={indexElement} style="display: none;"></div>
53
53
  {:else}
54
54
  <ClsPad keysAdd={['containerVerticalPadding']} {theme} />
55
55
  {/if}