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