svelte-tweakpane-ui 1.2.3 → 1.2.5
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.
- package/dist/control/Button.svelte +1 -1
- package/dist/control/ButtonGrid.svelte.d.ts +30 -30
- package/dist/control/Checkbox.svelte.d.ts +8 -8
- package/dist/control/Color.svelte.d.ts +96 -96
- package/dist/control/CubicBezier.svelte.d.ts +41 -41
- package/dist/control/Image.svelte.d.ts +40 -34
- package/dist/control/IntervalSlider.svelte.d.ts +105 -95
- package/dist/control/List.svelte.d.ts +20 -20
- package/dist/control/Point.svelte +1 -1
- package/dist/control/Point.svelte.d.ts +115 -114
- package/dist/control/RadioGrid.svelte +1 -1
- package/dist/control/RadioGrid.svelte.d.ts +59 -59
- package/dist/control/Ring.svelte.d.ts +102 -107
- package/dist/control/RotationEuler.svelte +1 -1
- package/dist/control/RotationEuler.svelte.d.ts +106 -106
- package/dist/control/RotationQuaternion.svelte +1 -1
- package/dist/control/RotationQuaternion.svelte.d.ts +104 -104
- package/dist/control/Slider.svelte.d.ts +84 -84
- package/dist/control/Text.svelte.d.ts +24 -24
- package/dist/control/Textarea.svelte +1 -1
- package/dist/control/Textarea.svelte.d.ts +33 -33
- package/dist/control/Wheel.svelte.d.ts +97 -97
- package/dist/core/Binding.svelte +1 -1
- package/dist/core/Blade.svelte +1 -1
- package/dist/core/Folder.svelte.d.ts +4 -1
- package/dist/core/Pane.svelte.d.ts +295 -275
- package/dist/extra/AutoValue.svelte.d.ts +8 -8
- package/dist/extra/Element.svelte.d.ts +23 -23
- package/dist/internal/ClsPad.svelte +1 -1
- package/dist/internal/GenericBinding.svelte.d.ts +8 -8
- package/dist/internal/GenericBladeFolding.svelte.d.ts +24 -24
- package/dist/internal/GenericInput.svelte.d.ts +8 -8
- package/dist/internal/GenericInputFolding.svelte.d.ts +78 -78
- package/dist/internal/GenericMonitor.svelte.d.ts +76 -76
- package/dist/internal/GenericSlider.svelte.d.ts +76 -76
- package/dist/internal/InternalMonitorBoolean.svelte.d.ts +82 -82
- package/dist/internal/InternalMonitorNumber.svelte.d.ts +101 -101
- package/dist/internal/InternalMonitorString.svelte.d.ts +87 -87
- package/dist/internal/InternalPaneDraggable.svelte +79 -42
- package/dist/internal/InternalPaneDraggable.svelte.d.ts +76 -76
- package/dist/internal/InternalPaneFixed.svelte.d.ts +26 -26
- package/dist/internal/InternalPaneInline.svelte.d.ts +13 -13
- package/dist/monitor/FpsGraph.svelte.d.ts +90 -90
- package/dist/monitor/Monitor.svelte.d.ts +502 -381
- package/dist/monitor/Profiler.svelte.d.ts +131 -131
- package/dist/monitor/WaveformMonitor.svelte.d.ts +104 -107
- package/dist/theme.d.ts +1 -1
- package/package.json +21 -22
- package/readme.md +2 -2
|
@@ -1,123 +1,43 @@
|
|
|
1
1
|
import { SvelteComponent } from 'svelte';
|
|
2
2
|
declare class __sveltets_Render<W extends number | string | boolean | unknown> {
|
|
3
|
-
props():
|
|
4
|
-
Omit<
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
options?:
|
|
36
|
-
| (W extends string
|
|
37
|
-
? import('tweakpane').StringMonitorParams
|
|
38
|
-
: W extends boolean
|
|
39
|
-
? import('tweakpane').BooleanMonitorParams
|
|
40
|
-
: W extends number
|
|
41
|
-
? import('tweakpane').NumberMonitorParams
|
|
42
|
-
: import('@tweakpane/core').BaseMonitorParams)
|
|
43
|
-
| undefined;
|
|
44
|
-
/**
|
|
45
|
-
* Custom color scheme.
|
|
46
|
-
*
|
|
47
|
-
* @default `undefined` \
|
|
48
|
-
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
|
|
49
|
-
* set with `setGlobalDefaultTheme()`.
|
|
50
|
-
*/
|
|
51
|
-
theme?: import('..').Theme | undefined;
|
|
52
|
-
/**
|
|
53
|
-
* Reference to internal Tweakpane
|
|
54
|
-
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
|
|
55
|
-
* this control.
|
|
56
|
-
*
|
|
57
|
-
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
58
|
-
* components wrapping `<Binding>`'s functionality.
|
|
59
|
-
*
|
|
60
|
-
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
61
|
-
*
|
|
62
|
-
* @bindable
|
|
63
|
-
* @readonly
|
|
64
|
-
*/
|
|
65
|
-
ref?: import('../internal/GenericMonitor.svelte').GenericMonitorRef | undefined;
|
|
66
|
-
/**
|
|
67
|
-
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
|
|
68
|
-
* the `<Binding>`'s containing `<Pane>`.
|
|
69
|
-
*
|
|
70
|
-
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
71
|
-
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
|
|
72
|
-
*
|
|
73
|
-
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
74
|
-
*
|
|
75
|
-
* @default `undefined`
|
|
76
|
-
*/
|
|
77
|
-
plugin?: import('tweakpane').TpPluginBundle | undefined;
|
|
78
|
-
},
|
|
79
|
-
'object' | 'key'
|
|
80
|
-
> & {
|
|
81
|
-
/**
|
|
82
|
-
* A value to monitor.
|
|
83
|
-
* @bindable
|
|
84
|
-
*/
|
|
85
|
-
value: W;
|
|
86
|
-
} & {
|
|
87
|
-
/**
|
|
88
|
-
* Number of past states to retain.
|
|
89
|
-
* @default `1` \
|
|
90
|
-
* Or `64` if value is `number` and `graph` is `true`.
|
|
91
|
-
*/
|
|
92
|
-
bufferSize?: number | undefined;
|
|
93
|
-
/**
|
|
94
|
-
* Time between value samples in milliseconds.
|
|
95
|
-
*
|
|
96
|
-
* Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
|
|
97
|
-
* @default `0`
|
|
98
|
-
*/
|
|
99
|
-
interval?: number | undefined;
|
|
100
|
-
/**
|
|
101
|
-
* Number of visible rows of state history.
|
|
102
|
-
*
|
|
103
|
-
* If `bufferSize` is larger, then the value window will scroll once state history exceeds
|
|
104
|
-
* row count.
|
|
105
|
-
* @default `1` \
|
|
106
|
-
* Or `3` if value is `string` and `multiline` is `true`.
|
|
107
|
-
*/
|
|
108
|
-
rows?: number | undefined;
|
|
109
|
-
},
|
|
110
|
-
'ref' | 'options' | 'plugin'
|
|
111
|
-
> &
|
|
112
|
-
(W extends string
|
|
113
|
-
? Omit<
|
|
114
|
-
Omit<
|
|
3
|
+
props(): W extends string | number | boolean
|
|
4
|
+
? Omit<
|
|
5
|
+
{
|
|
6
|
+
/**
|
|
7
|
+
* Number of past states to retain.
|
|
8
|
+
* @default `1` \
|
|
9
|
+
* Or `64` if value is `number` and `graph` is `true`.
|
|
10
|
+
*/
|
|
11
|
+
bufferSize?: number | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* Time between value samples in milliseconds.
|
|
14
|
+
*
|
|
15
|
+
* Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
|
|
16
|
+
* @default `0`
|
|
17
|
+
*/
|
|
18
|
+
interval?: number | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* Number of visible rows of state history.
|
|
21
|
+
*
|
|
22
|
+
* If `bufferSize` is larger, then the value window will scroll once state history exceeds
|
|
23
|
+
* row count.
|
|
24
|
+
* @default `1` \
|
|
25
|
+
* Or `3` if value is `string` and `multiline` is `true`.
|
|
26
|
+
*/
|
|
27
|
+
rows?: number | undefined;
|
|
28
|
+
} & {
|
|
29
|
+
/**
|
|
30
|
+
* A value to monitor.
|
|
31
|
+
* @bindable
|
|
32
|
+
*/
|
|
33
|
+
value: W;
|
|
34
|
+
} & Omit<
|
|
115
35
|
{
|
|
116
36
|
/**
|
|
117
37
|
* The binding's target object with values to manipulate.
|
|
118
38
|
* @bindable
|
|
119
39
|
*/
|
|
120
|
-
object: import('@tweakpane/core').Bindable & Record<string,
|
|
40
|
+
object: import('@tweakpane/core').Bindable & Record<string, W>;
|
|
121
41
|
/** The key for the value in the target `object` that the control should manipulate. */
|
|
122
42
|
key: string;
|
|
123
43
|
/**
|
|
@@ -142,7 +62,19 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
|
|
|
142
62
|
* Tweakpane UI_.
|
|
143
63
|
* @default `undefined`
|
|
144
64
|
*/
|
|
145
|
-
options?:
|
|
65
|
+
options?:
|
|
66
|
+
| (W extends infer T
|
|
67
|
+
? T extends W
|
|
68
|
+
? T extends string
|
|
69
|
+
? import('tweakpane').StringMonitorParams
|
|
70
|
+
: T extends boolean
|
|
71
|
+
? import('tweakpane').BooleanMonitorParams
|
|
72
|
+
: T extends number
|
|
73
|
+
? import('tweakpane').NumberMonitorParams
|
|
74
|
+
: import('@tweakpane/core').BaseMonitorParams
|
|
75
|
+
: never
|
|
76
|
+
: never)
|
|
77
|
+
| undefined;
|
|
146
78
|
/**
|
|
147
79
|
* Custom color scheme.
|
|
148
80
|
*
|
|
@@ -179,293 +111,482 @@ declare class __sveltets_Render<W extends number | string | boolean | unknown> {
|
|
|
179
111
|
plugin?: import('tweakpane').TpPluginBundle | undefined;
|
|
180
112
|
},
|
|
181
113
|
'object' | 'key'
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
114
|
+
>,
|
|
115
|
+
'ref' | 'options' | 'plugin'
|
|
116
|
+
> &
|
|
117
|
+
(W extends infer T_1
|
|
118
|
+
? T_1 extends W
|
|
119
|
+
? T_1 extends string
|
|
120
|
+
? {
|
|
121
|
+
/**
|
|
122
|
+
* A value to monitor.
|
|
123
|
+
* @bindable
|
|
124
|
+
*/
|
|
125
|
+
value: string;
|
|
126
|
+
/**
|
|
127
|
+
* Display multiline strings.
|
|
128
|
+
* @default `false`
|
|
129
|
+
*/
|
|
130
|
+
multiline?: boolean | undefined;
|
|
131
|
+
} & Omit<
|
|
132
|
+
{
|
|
133
|
+
/**
|
|
134
|
+
* Number of past states to retain.
|
|
135
|
+
* @default `1` \
|
|
136
|
+
* Or `64` if value is `number` and `graph` is `true`.
|
|
137
|
+
*/
|
|
138
|
+
bufferSize?: number | undefined;
|
|
139
|
+
/**
|
|
140
|
+
* Time between value samples in milliseconds.
|
|
141
|
+
*
|
|
142
|
+
* Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
|
|
143
|
+
* @default `0`
|
|
144
|
+
*/
|
|
145
|
+
interval?: number | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* Number of visible rows of state history.
|
|
148
|
+
*
|
|
149
|
+
* If `bufferSize` is larger, then the value window will scroll once state history exceeds
|
|
150
|
+
* row count.
|
|
151
|
+
* @default `1` \
|
|
152
|
+
* Or `3` if value is `string` and `multiline` is `true`.
|
|
153
|
+
*/
|
|
154
|
+
rows?: number | undefined;
|
|
155
|
+
} & {
|
|
156
|
+
/**
|
|
157
|
+
* A value to monitor.
|
|
158
|
+
* @bindable
|
|
159
|
+
*/
|
|
160
|
+
value: string;
|
|
161
|
+
} & Omit<
|
|
162
|
+
{
|
|
163
|
+
/**
|
|
164
|
+
* The binding's target object with values to manipulate.
|
|
165
|
+
* @bindable
|
|
166
|
+
*/
|
|
167
|
+
object: import('@tweakpane/core').Bindable & Record<string, string>;
|
|
168
|
+
/** The key for the value in the target `object` that the control should manipulate. */
|
|
169
|
+
key: string;
|
|
170
|
+
/**
|
|
171
|
+
* Prevent interactivity and gray out the control.
|
|
172
|
+
* @default `false`
|
|
173
|
+
*/
|
|
174
|
+
disabled?: boolean | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* Text displayed next to control.
|
|
177
|
+
* @default `undefined`
|
|
178
|
+
*/
|
|
179
|
+
label?: string | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* Tweakpane's internal options object.
|
|
182
|
+
*
|
|
183
|
+
* See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
|
|
184
|
+
*
|
|
185
|
+
* Valid types are contingent on the type of the value `key` points to in `object`.
|
|
186
|
+
*
|
|
187
|
+
* This is intended internal use, when implementing convenience components wrapping Binding's
|
|
188
|
+
* functionality. Options of interest are instead exposed as top-level props in _Svelte
|
|
189
|
+
* Tweakpane UI_.
|
|
190
|
+
* @default `undefined`
|
|
191
|
+
*/
|
|
192
|
+
options?: import('tweakpane').StringMonitorParams | undefined;
|
|
193
|
+
/**
|
|
194
|
+
* Custom color scheme.
|
|
195
|
+
*
|
|
196
|
+
* @default `undefined` \
|
|
197
|
+
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
|
|
198
|
+
* set with `setGlobalDefaultTheme()`.
|
|
199
|
+
*/
|
|
200
|
+
theme?: import('..').Theme | undefined;
|
|
201
|
+
/**
|
|
202
|
+
* Reference to internal Tweakpane
|
|
203
|
+
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
|
|
204
|
+
* this control.
|
|
205
|
+
*
|
|
206
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
207
|
+
* components wrapping `<Binding>`'s functionality.
|
|
208
|
+
*
|
|
209
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
210
|
+
*
|
|
211
|
+
* @bindable
|
|
212
|
+
* @readonly
|
|
213
|
+
*/
|
|
214
|
+
ref?:
|
|
215
|
+
| import('../internal/GenericMonitor.svelte').GenericMonitorRef
|
|
216
|
+
| undefined;
|
|
217
|
+
/**
|
|
218
|
+
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
|
|
219
|
+
* the `<Binding>`'s containing `<Pane>`.
|
|
220
|
+
*
|
|
221
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
222
|
+
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
|
|
223
|
+
*
|
|
224
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
225
|
+
*
|
|
226
|
+
* @default `undefined`
|
|
227
|
+
*/
|
|
228
|
+
plugin?: import('tweakpane').TpPluginBundle | undefined;
|
|
229
|
+
},
|
|
230
|
+
'object' | 'key'
|
|
231
|
+
>,
|
|
232
|
+
'ref' | 'options' | 'plugin' | 'interval'
|
|
233
|
+
>
|
|
234
|
+
: T_1 extends boolean
|
|
235
|
+
? {
|
|
236
|
+
/**
|
|
237
|
+
* A value to monitor.
|
|
238
|
+
* @bindable
|
|
239
|
+
*/
|
|
240
|
+
value: boolean;
|
|
241
|
+
} & Omit<
|
|
242
|
+
{
|
|
243
|
+
/**
|
|
244
|
+
* Number of past states to retain.
|
|
245
|
+
* @default `1` \
|
|
246
|
+
* Or `64` if value is `number` and `graph` is `true`.
|
|
247
|
+
*/
|
|
248
|
+
bufferSize?: number | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* Time between value samples in milliseconds.
|
|
251
|
+
*
|
|
252
|
+
* Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
|
|
253
|
+
* @default `0`
|
|
254
|
+
*/
|
|
255
|
+
interval?: number | undefined;
|
|
256
|
+
/**
|
|
257
|
+
* Number of visible rows of state history.
|
|
258
|
+
*
|
|
259
|
+
* If `bufferSize` is larger, then the value window will scroll once state history exceeds
|
|
260
|
+
* row count.
|
|
261
|
+
* @default `1` \
|
|
262
|
+
* Or `3` if value is `string` and `multiline` is `true`.
|
|
263
|
+
*/
|
|
264
|
+
rows?: number | undefined;
|
|
265
|
+
} & {
|
|
266
|
+
/**
|
|
267
|
+
* A value to monitor.
|
|
268
|
+
* @bindable
|
|
269
|
+
*/
|
|
270
|
+
value: boolean;
|
|
271
|
+
} & Omit<
|
|
272
|
+
{
|
|
273
|
+
/**
|
|
274
|
+
* The binding's target object with values to manipulate.
|
|
275
|
+
* @bindable
|
|
276
|
+
*/
|
|
277
|
+
object: import('@tweakpane/core').Bindable & Record<string, boolean>;
|
|
278
|
+
/** The key for the value in the target `object` that the control should manipulate. */
|
|
279
|
+
key: string;
|
|
280
|
+
/**
|
|
281
|
+
* Prevent interactivity and gray out the control.
|
|
282
|
+
* @default `false`
|
|
283
|
+
*/
|
|
284
|
+
disabled?: boolean | undefined;
|
|
285
|
+
/**
|
|
286
|
+
* Text displayed next to control.
|
|
287
|
+
* @default `undefined`
|
|
288
|
+
*/
|
|
289
|
+
label?: string | undefined;
|
|
290
|
+
/**
|
|
291
|
+
* Tweakpane's internal options object.
|
|
292
|
+
*
|
|
293
|
+
* See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
|
|
294
|
+
*
|
|
295
|
+
* Valid types are contingent on the type of the value `key` points to in `object`.
|
|
296
|
+
*
|
|
297
|
+
* This is intended internal use, when implementing convenience components wrapping Binding's
|
|
298
|
+
* functionality. Options of interest are instead exposed as top-level props in _Svelte
|
|
299
|
+
* Tweakpane UI_.
|
|
300
|
+
* @default `undefined`
|
|
301
|
+
*/
|
|
302
|
+
options?: import('tweakpane').BooleanMonitorParams | undefined;
|
|
303
|
+
/**
|
|
304
|
+
* Custom color scheme.
|
|
305
|
+
*
|
|
306
|
+
* @default `undefined` \
|
|
307
|
+
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
|
|
308
|
+
* set with `setGlobalDefaultTheme()`.
|
|
309
|
+
*/
|
|
310
|
+
theme?: import('..').Theme | undefined;
|
|
311
|
+
/**
|
|
312
|
+
* Reference to internal Tweakpane
|
|
313
|
+
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
|
|
314
|
+
* this control.
|
|
315
|
+
*
|
|
316
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
317
|
+
* components wrapping `<Binding>`'s functionality.
|
|
318
|
+
*
|
|
319
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
320
|
+
*
|
|
321
|
+
* @bindable
|
|
322
|
+
* @readonly
|
|
323
|
+
*/
|
|
324
|
+
ref?:
|
|
325
|
+
| import('../internal/GenericMonitor.svelte').GenericMonitorRef
|
|
326
|
+
| undefined;
|
|
327
|
+
/**
|
|
328
|
+
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
|
|
329
|
+
* the `<Binding>`'s containing `<Pane>`.
|
|
330
|
+
*
|
|
331
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
332
|
+
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
|
|
333
|
+
*
|
|
334
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
335
|
+
*
|
|
336
|
+
* @default `undefined`
|
|
337
|
+
*/
|
|
338
|
+
plugin?: import('tweakpane').TpPluginBundle | undefined;
|
|
339
|
+
},
|
|
340
|
+
'object' | 'key'
|
|
341
|
+
>,
|
|
342
|
+
'ref' | 'options' | 'plugin' | 'interval'
|
|
343
|
+
>
|
|
344
|
+
: T_1 extends number
|
|
345
|
+
? {
|
|
346
|
+
/**
|
|
347
|
+
* A value to monitor.
|
|
348
|
+
* @bindable
|
|
349
|
+
*/
|
|
350
|
+
value: number;
|
|
351
|
+
/**
|
|
352
|
+
* Minimum bound when `graph` is true.
|
|
353
|
+
* @default `0`
|
|
354
|
+
*/
|
|
355
|
+
min?: number | undefined;
|
|
356
|
+
/**
|
|
357
|
+
* Maximum bound when `graph` is true.
|
|
358
|
+
* @default `100`
|
|
359
|
+
*/
|
|
360
|
+
max?: number | undefined;
|
|
361
|
+
/**
|
|
362
|
+
* A function to customize the number's string representation (e.g. rounding, etc.).
|
|
363
|
+
* @default `undefined` \
|
|
364
|
+
* Normal `.toString()` formatting.
|
|
365
|
+
*/
|
|
366
|
+
format?: ((value: number) => string) | undefined;
|
|
367
|
+
/**
|
|
368
|
+
* Display a graph of the value's changes over time.
|
|
369
|
+
* @default `false`
|
|
370
|
+
*/
|
|
371
|
+
graph?: boolean | undefined;
|
|
372
|
+
} & Omit<
|
|
373
|
+
{
|
|
374
|
+
/**
|
|
375
|
+
* Number of past states to retain.
|
|
376
|
+
* @default `1` \
|
|
377
|
+
* Or `64` if value is `number` and `graph` is `true`.
|
|
378
|
+
*/
|
|
379
|
+
bufferSize?: number | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* Time between value samples in milliseconds.
|
|
382
|
+
*
|
|
383
|
+
* Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
|
|
384
|
+
* @default `0`
|
|
385
|
+
*/
|
|
386
|
+
interval?: number | undefined;
|
|
387
|
+
/**
|
|
388
|
+
* Number of visible rows of state history.
|
|
389
|
+
*
|
|
390
|
+
* If `bufferSize` is larger, then the value window will scroll once state history exceeds
|
|
391
|
+
* row count.
|
|
392
|
+
* @default `1` \
|
|
393
|
+
* Or `3` if value is `string` and `multiline` is `true`.
|
|
394
|
+
*/
|
|
395
|
+
rows?: number | undefined;
|
|
396
|
+
} & {
|
|
397
|
+
/**
|
|
398
|
+
* A value to monitor.
|
|
399
|
+
* @bindable
|
|
400
|
+
*/
|
|
401
|
+
value: number;
|
|
402
|
+
} & Omit<
|
|
403
|
+
{
|
|
404
|
+
/**
|
|
405
|
+
* The binding's target object with values to manipulate.
|
|
406
|
+
* @bindable
|
|
407
|
+
*/
|
|
408
|
+
object: import('@tweakpane/core').Bindable & Record<string, number>;
|
|
409
|
+
/** The key for the value in the target `object` that the control should manipulate. */
|
|
410
|
+
key: string;
|
|
411
|
+
/**
|
|
412
|
+
* Prevent interactivity and gray out the control.
|
|
413
|
+
* @default `false`
|
|
414
|
+
*/
|
|
415
|
+
disabled?: boolean | undefined;
|
|
416
|
+
/**
|
|
417
|
+
* Text displayed next to control.
|
|
418
|
+
* @default `undefined`
|
|
419
|
+
*/
|
|
420
|
+
label?: string | undefined;
|
|
421
|
+
/**
|
|
422
|
+
* Tweakpane's internal options object.
|
|
423
|
+
*
|
|
424
|
+
* See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
|
|
425
|
+
*
|
|
426
|
+
* Valid types are contingent on the type of the value `key` points to in `object`.
|
|
427
|
+
*
|
|
428
|
+
* This is intended internal use, when implementing convenience components wrapping Binding's
|
|
429
|
+
* functionality. Options of interest are instead exposed as top-level props in _Svelte
|
|
430
|
+
* Tweakpane UI_.
|
|
431
|
+
* @default `undefined`
|
|
432
|
+
*/
|
|
433
|
+
options?: import('tweakpane').NumberMonitorParams | undefined;
|
|
434
|
+
/**
|
|
435
|
+
* Custom color scheme.
|
|
436
|
+
*
|
|
437
|
+
* @default `undefined` \
|
|
438
|
+
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
|
|
439
|
+
* set with `setGlobalDefaultTheme()`.
|
|
440
|
+
*/
|
|
441
|
+
theme?: import('..').Theme | undefined;
|
|
442
|
+
/**
|
|
443
|
+
* Reference to internal Tweakpane
|
|
444
|
+
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
|
|
445
|
+
* this control.
|
|
446
|
+
*
|
|
447
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
448
|
+
* components wrapping `<Binding>`'s functionality.
|
|
449
|
+
*
|
|
450
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
451
|
+
*
|
|
452
|
+
* @bindable
|
|
453
|
+
* @readonly
|
|
454
|
+
*/
|
|
455
|
+
ref?:
|
|
456
|
+
| import('../internal/GenericMonitor.svelte').GenericMonitorRef
|
|
457
|
+
| undefined;
|
|
458
|
+
/**
|
|
459
|
+
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
|
|
460
|
+
* the `<Binding>`'s containing `<Pane>`.
|
|
461
|
+
*
|
|
462
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
463
|
+
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
|
|
464
|
+
*
|
|
465
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
466
|
+
*
|
|
467
|
+
* @default `undefined`
|
|
468
|
+
*/
|
|
469
|
+
plugin?: import('tweakpane').TpPluginBundle | undefined;
|
|
470
|
+
},
|
|
471
|
+
'object' | 'key'
|
|
472
|
+
>,
|
|
473
|
+
'ref' | 'options' | 'plugin'
|
|
474
|
+
>
|
|
475
|
+
: {
|
|
476
|
+
/**
|
|
477
|
+
* A value to monitor.
|
|
478
|
+
* @bindable
|
|
479
|
+
* */
|
|
480
|
+
value: string | number | boolean;
|
|
481
|
+
}
|
|
482
|
+
: never
|
|
483
|
+
: never)
|
|
484
|
+
: Omit<
|
|
485
|
+
{
|
|
214
486
|
/**
|
|
215
|
-
*
|
|
216
|
-
* @
|
|
487
|
+
* Number of past states to retain.
|
|
488
|
+
* @default `1` \
|
|
489
|
+
* Or `64` if value is `number` and `graph` is `true`.
|
|
490
|
+
*/
|
|
491
|
+
bufferSize?: number | undefined;
|
|
492
|
+
/**
|
|
493
|
+
* Time between value samples in milliseconds.
|
|
494
|
+
*
|
|
495
|
+
* Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
|
|
496
|
+
* @default `0`
|
|
217
497
|
*/
|
|
218
|
-
|
|
498
|
+
interval?: number | undefined;
|
|
219
499
|
/**
|
|
220
|
-
*
|
|
221
|
-
*
|
|
500
|
+
* Number of visible rows of state history.
|
|
501
|
+
*
|
|
502
|
+
* If `bufferSize` is larger, then the value window will scroll once state history exceeds
|
|
503
|
+
* row count.
|
|
504
|
+
* @default `1` \
|
|
505
|
+
* Or `3` if value is `string` and `multiline` is `true`.
|
|
222
506
|
*/
|
|
223
|
-
|
|
224
|
-
}
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
*/
|
|
233
|
-
object: import('@tweakpane/core').Bindable & Record<string, boolean>;
|
|
234
|
-
/** The key for the value in the target `object` that the control should manipulate. */
|
|
235
|
-
key: string;
|
|
236
|
-
/**
|
|
237
|
-
* Prevent interactivity and gray out the control.
|
|
238
|
-
* @default `false`
|
|
239
|
-
*/
|
|
240
|
-
disabled?: boolean | undefined;
|
|
241
|
-
/**
|
|
242
|
-
* Text displayed next to control.
|
|
243
|
-
* @default `undefined`
|
|
244
|
-
*/
|
|
245
|
-
label?: string | undefined;
|
|
246
|
-
/**
|
|
247
|
-
* Tweakpane's internal options object.
|
|
248
|
-
*
|
|
249
|
-
* See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
|
|
250
|
-
*
|
|
251
|
-
* Valid types are contingent on the type of the value `key` points to in `object`.
|
|
252
|
-
*
|
|
253
|
-
* This is intended internal use, when implementing convenience components wrapping Binding's
|
|
254
|
-
* functionality. Options of interest are instead exposed as top-level props in _Svelte
|
|
255
|
-
* Tweakpane UI_.
|
|
256
|
-
* @default `undefined`
|
|
257
|
-
*/
|
|
258
|
-
options?: import('tweakpane').BooleanMonitorParams | undefined;
|
|
259
|
-
/**
|
|
260
|
-
* Custom color scheme.
|
|
261
|
-
*
|
|
262
|
-
* @default `undefined` \
|
|
263
|
-
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
|
|
264
|
-
* set with `setGlobalDefaultTheme()`.
|
|
265
|
-
*/
|
|
266
|
-
theme?: import('..').Theme | undefined;
|
|
267
|
-
/**
|
|
268
|
-
* Reference to internal Tweakpane
|
|
269
|
-
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
|
|
270
|
-
* this control.
|
|
271
|
-
*
|
|
272
|
-
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
273
|
-
* components wrapping `<Binding>`'s functionality.
|
|
274
|
-
*
|
|
275
|
-
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
276
|
-
*
|
|
277
|
-
* @bindable
|
|
278
|
-
* @readonly
|
|
279
|
-
*/
|
|
280
|
-
ref?: import('../internal/GenericMonitor.svelte').GenericMonitorRef | undefined;
|
|
281
|
-
/**
|
|
282
|
-
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
|
|
283
|
-
* the `<Binding>`'s containing `<Pane>`.
|
|
284
|
-
*
|
|
285
|
-
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
286
|
-
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
|
|
287
|
-
*
|
|
288
|
-
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
289
|
-
*
|
|
290
|
-
* @default `undefined`
|
|
291
|
-
*/
|
|
292
|
-
plugin?: import('tweakpane').TpPluginBundle | undefined;
|
|
293
|
-
},
|
|
294
|
-
'object' | 'key'
|
|
295
|
-
> & {
|
|
507
|
+
rows?: number | undefined;
|
|
508
|
+
} & {
|
|
509
|
+
/**
|
|
510
|
+
* A value to monitor.
|
|
511
|
+
* @bindable
|
|
512
|
+
*/
|
|
513
|
+
value: string | number | boolean;
|
|
514
|
+
} & Omit<
|
|
515
|
+
{
|
|
296
516
|
/**
|
|
297
|
-
*
|
|
517
|
+
* The binding's target object with values to manipulate.
|
|
298
518
|
* @bindable
|
|
299
519
|
*/
|
|
300
|
-
|
|
301
|
-
|
|
520
|
+
object: import('@tweakpane/core').Bindable &
|
|
521
|
+
Record<string, string | number | boolean>;
|
|
522
|
+
/** The key for the value in the target `object` that the control should manipulate. */
|
|
523
|
+
key: string;
|
|
302
524
|
/**
|
|
303
|
-
*
|
|
304
|
-
* @default `
|
|
305
|
-
* Or `64` if value is `number` and `graph` is `true`.
|
|
525
|
+
* Prevent interactivity and gray out the control.
|
|
526
|
+
* @default `false`
|
|
306
527
|
*/
|
|
307
|
-
|
|
528
|
+
disabled?: boolean | undefined;
|
|
308
529
|
/**
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
* Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
|
|
312
|
-
* @default `0`
|
|
530
|
+
* Text displayed next to control.
|
|
531
|
+
* @default `undefined`
|
|
313
532
|
*/
|
|
314
|
-
|
|
533
|
+
label?: string | undefined;
|
|
315
534
|
/**
|
|
316
|
-
*
|
|
535
|
+
* Tweakpane's internal options object.
|
|
317
536
|
*
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
> & {
|
|
327
|
-
/**
|
|
328
|
-
* A value to monitor.
|
|
329
|
-
* @bindable
|
|
330
|
-
*/
|
|
331
|
-
value: boolean;
|
|
332
|
-
}
|
|
333
|
-
: W extends number
|
|
334
|
-
? Omit<
|
|
335
|
-
Omit<
|
|
336
|
-
{
|
|
337
|
-
/**
|
|
338
|
-
* The binding's target object with values to manipulate.
|
|
339
|
-
* @bindable
|
|
340
|
-
*/
|
|
341
|
-
object: import('@tweakpane/core').Bindable & Record<string, number>;
|
|
342
|
-
/** The key for the value in the target `object` that the control should manipulate. */
|
|
343
|
-
key: string;
|
|
344
|
-
/**
|
|
345
|
-
* Prevent interactivity and gray out the control.
|
|
346
|
-
* @default `false`
|
|
347
|
-
*/
|
|
348
|
-
disabled?: boolean | undefined;
|
|
349
|
-
/**
|
|
350
|
-
* Text displayed next to control.
|
|
351
|
-
* @default `undefined`
|
|
352
|
-
*/
|
|
353
|
-
label?: string | undefined;
|
|
354
|
-
/**
|
|
355
|
-
* Tweakpane's internal options object.
|
|
356
|
-
*
|
|
357
|
-
* See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
|
|
358
|
-
*
|
|
359
|
-
* Valid types are contingent on the type of the value `key` points to in `object`.
|
|
360
|
-
*
|
|
361
|
-
* This is intended internal use, when implementing convenience components wrapping Binding's
|
|
362
|
-
* functionality. Options of interest are instead exposed as top-level props in _Svelte
|
|
363
|
-
* Tweakpane UI_.
|
|
364
|
-
* @default `undefined`
|
|
365
|
-
*/
|
|
366
|
-
options?: import('tweakpane').NumberMonitorParams | undefined;
|
|
367
|
-
/**
|
|
368
|
-
* Custom color scheme.
|
|
369
|
-
*
|
|
370
|
-
* @default `undefined` \
|
|
371
|
-
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
|
|
372
|
-
* set with `setGlobalDefaultTheme()`.
|
|
373
|
-
*/
|
|
374
|
-
theme?: import('..').Theme | undefined;
|
|
375
|
-
/**
|
|
376
|
-
* Reference to internal Tweakpane
|
|
377
|
-
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
|
|
378
|
-
* this control.
|
|
379
|
-
*
|
|
380
|
-
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
381
|
-
* components wrapping `<Binding>`'s functionality.
|
|
382
|
-
*
|
|
383
|
-
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
384
|
-
*
|
|
385
|
-
* @bindable
|
|
386
|
-
* @readonly
|
|
387
|
-
*/
|
|
388
|
-
ref?: import('../internal/GenericMonitor.svelte').GenericMonitorRef | undefined;
|
|
389
|
-
/**
|
|
390
|
-
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
|
|
391
|
-
* the `<Binding>`'s containing `<Pane>`.
|
|
392
|
-
*
|
|
393
|
-
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
394
|
-
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
|
|
395
|
-
*
|
|
396
|
-
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
397
|
-
*
|
|
398
|
-
* @default `undefined`
|
|
399
|
-
*/
|
|
400
|
-
plugin?: import('tweakpane').TpPluginBundle | undefined;
|
|
401
|
-
},
|
|
402
|
-
'object' | 'key'
|
|
403
|
-
> & {
|
|
404
|
-
/**
|
|
405
|
-
* A value to monitor.
|
|
406
|
-
* @bindable
|
|
407
|
-
*/
|
|
408
|
-
value: number;
|
|
409
|
-
} & {
|
|
410
|
-
/**
|
|
411
|
-
* Number of past states to retain.
|
|
412
|
-
* @default `1` \
|
|
413
|
-
* Or `64` if value is `number` and `graph` is `true`.
|
|
414
|
-
*/
|
|
415
|
-
bufferSize?: number | undefined;
|
|
416
|
-
/**
|
|
417
|
-
* Time between value samples in milliseconds.
|
|
418
|
-
*
|
|
419
|
-
* Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
|
|
420
|
-
* @default `0`
|
|
421
|
-
*/
|
|
422
|
-
interval?: number | undefined;
|
|
423
|
-
/**
|
|
424
|
-
* Number of visible rows of state history.
|
|
425
|
-
*
|
|
426
|
-
* If `bufferSize` is larger, then the value window will scroll once state history exceeds
|
|
427
|
-
* row count.
|
|
428
|
-
* @default `1` \
|
|
429
|
-
* Or `3` if value is `string` and `multiline` is `true`.
|
|
430
|
-
*/
|
|
431
|
-
rows?: number | undefined;
|
|
432
|
-
},
|
|
433
|
-
'ref' | 'options' | 'plugin'
|
|
434
|
-
> & {
|
|
435
|
-
/**
|
|
436
|
-
* A value to monitor.
|
|
437
|
-
* @bindable
|
|
438
|
-
*/
|
|
439
|
-
value: number;
|
|
440
|
-
/**
|
|
441
|
-
* Minimum bound when `graph` is true.
|
|
442
|
-
* @default `0`
|
|
443
|
-
*/
|
|
444
|
-
min?: number | undefined;
|
|
445
|
-
/**
|
|
446
|
-
* Maximum bound when `graph` is true.
|
|
447
|
-
* @default `100`
|
|
537
|
+
* See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
|
|
538
|
+
*
|
|
539
|
+
* Valid types are contingent on the type of the value `key` points to in `object`.
|
|
540
|
+
*
|
|
541
|
+
* This is intended internal use, when implementing convenience components wrapping Binding's
|
|
542
|
+
* functionality. Options of interest are instead exposed as top-level props in _Svelte
|
|
543
|
+
* Tweakpane UI_.
|
|
544
|
+
* @default `undefined`
|
|
448
545
|
*/
|
|
449
|
-
|
|
546
|
+
options?:
|
|
547
|
+
| import('tweakpane').BooleanMonitorParams
|
|
548
|
+
| import('tweakpane').NumberMonitorParams
|
|
549
|
+
| import('tweakpane').StringMonitorParams
|
|
550
|
+
| undefined;
|
|
450
551
|
/**
|
|
451
|
-
*
|
|
552
|
+
* Custom color scheme.
|
|
553
|
+
*
|
|
452
554
|
* @default `undefined` \
|
|
453
|
-
*
|
|
555
|
+
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
|
|
556
|
+
* set with `setGlobalDefaultTheme()`.
|
|
454
557
|
*/
|
|
455
|
-
|
|
558
|
+
theme?: import('..').Theme | undefined;
|
|
456
559
|
/**
|
|
457
|
-
*
|
|
458
|
-
*
|
|
560
|
+
* Reference to internal Tweakpane
|
|
561
|
+
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
|
|
562
|
+
* this control.
|
|
563
|
+
*
|
|
564
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
565
|
+
* components wrapping `<Binding>`'s functionality.
|
|
566
|
+
*
|
|
567
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
568
|
+
*
|
|
569
|
+
* @bindable
|
|
570
|
+
* @readonly
|
|
459
571
|
*/
|
|
460
|
-
|
|
461
|
-
}
|
|
462
|
-
: {
|
|
572
|
+
ref?: import('../internal/GenericMonitor.svelte').GenericMonitorRef | undefined;
|
|
463
573
|
/**
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
|
|
468
|
-
|
|
574
|
+
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
|
|
575
|
+
* the `<Binding>`'s containing `<Pane>`.
|
|
576
|
+
*
|
|
577
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
578
|
+
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
|
|
579
|
+
*
|
|
580
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
581
|
+
*
|
|
582
|
+
* @default `undefined`
|
|
583
|
+
*/
|
|
584
|
+
plugin?: import('tweakpane').TpPluginBundle | undefined;
|
|
585
|
+
},
|
|
586
|
+
'object' | 'key'
|
|
587
|
+
>,
|
|
588
|
+
'ref' | 'options' | 'plugin'
|
|
589
|
+
>;
|
|
469
590
|
events(): {} & {
|
|
470
591
|
[evt: string]: CustomEvent<any>;
|
|
471
592
|
};
|