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.
- 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 +30 -30
- 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/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/GenericPane.svelte +1 -1
- 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.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 +233 -233
- 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 +15 -15
- package/readme.md +2 -2
|
@@ -3,81 +3,7 @@ import type { IntervalSliderValue } from '../control/IntervalSlider.svelte';
|
|
|
3
3
|
import type { NumberInputParams as GenericSliderOptions } from 'tweakpane';
|
|
4
4
|
import type { SliderInputBindingApi as GenericSliderRef } from 'tweakpane';
|
|
5
5
|
declare class __sveltets_Render<T extends number | IntervalSliderValue> {
|
|
6
|
-
props():
|
|
7
|
-
{
|
|
8
|
-
/**
|
|
9
|
-
* The binding's target object with values to manipulate.
|
|
10
|
-
* @bindable
|
|
11
|
-
*/
|
|
12
|
-
object: import('@tweakpane/core').Bindable & Record<string, T>;
|
|
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?: GenericSliderOptions | 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?: GenericSliderRef | 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
|
-
* The value to control.
|
|
77
|
-
* @bindable
|
|
78
|
-
*/
|
|
79
|
-
value: T;
|
|
80
|
-
} & {
|
|
6
|
+
props(): {
|
|
81
7
|
/**
|
|
82
8
|
* Minimum value.
|
|
83
9
|
*
|
|
@@ -117,7 +43,81 @@ declare class __sveltets_Render<T extends number | IntervalSliderValue> {
|
|
|
117
43
|
* No step constraint.
|
|
118
44
|
* */
|
|
119
45
|
step?: number | undefined;
|
|
120
|
-
}
|
|
46
|
+
} & {
|
|
47
|
+
/**
|
|
48
|
+
* The value to control.
|
|
49
|
+
* @bindable
|
|
50
|
+
*/
|
|
51
|
+
value: T;
|
|
52
|
+
} & Omit<
|
|
53
|
+
{
|
|
54
|
+
/**
|
|
55
|
+
* The binding's target object with values to manipulate.
|
|
56
|
+
* @bindable
|
|
57
|
+
*/
|
|
58
|
+
object: import('@tweakpane/core').Bindable & Record<string, T>;
|
|
59
|
+
/** The key for the value in the target `object` that the control should manipulate. */
|
|
60
|
+
key: string;
|
|
61
|
+
/**
|
|
62
|
+
* Prevent interactivity and gray out the control.
|
|
63
|
+
* @default `false`
|
|
64
|
+
*/
|
|
65
|
+
disabled?: boolean | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* Text displayed next to control.
|
|
68
|
+
* @default `undefined`
|
|
69
|
+
*/
|
|
70
|
+
label?: string | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* Tweakpane's internal options object.
|
|
73
|
+
*
|
|
74
|
+
* See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
|
|
75
|
+
*
|
|
76
|
+
* Valid types are contingent on the type of the value `key` points to in `object`.
|
|
77
|
+
*
|
|
78
|
+
* This is intended internal use, when implementing convenience components wrapping Binding's
|
|
79
|
+
* functionality. Options of interest are instead exposed as top-level props in _Svelte
|
|
80
|
+
* Tweakpane UI_.
|
|
81
|
+
* @default `undefined`
|
|
82
|
+
*/
|
|
83
|
+
options?: GenericSliderOptions | undefined;
|
|
84
|
+
/**
|
|
85
|
+
* Custom color scheme.
|
|
86
|
+
*
|
|
87
|
+
* @default `undefined` \
|
|
88
|
+
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
|
|
89
|
+
* set with `setGlobalDefaultTheme()`.
|
|
90
|
+
*/
|
|
91
|
+
theme?: import('..').Theme | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* Reference to internal Tweakpane
|
|
94
|
+
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
|
|
95
|
+
* this control.
|
|
96
|
+
*
|
|
97
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
98
|
+
* components wrapping `<Binding>`'s functionality.
|
|
99
|
+
*
|
|
100
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
101
|
+
*
|
|
102
|
+
* @bindable
|
|
103
|
+
* @readonly
|
|
104
|
+
*/
|
|
105
|
+
ref?: GenericSliderRef | undefined;
|
|
106
|
+
/**
|
|
107
|
+
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
|
|
108
|
+
* the `<Binding>`'s containing `<Pane>`.
|
|
109
|
+
*
|
|
110
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
111
|
+
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
|
|
112
|
+
*
|
|
113
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
114
|
+
*
|
|
115
|
+
* @default `undefined`
|
|
116
|
+
*/
|
|
117
|
+
plugin?: import('tweakpane').TpPluginBundle | undefined;
|
|
118
|
+
},
|
|
119
|
+
'object' | 'key'
|
|
120
|
+
>;
|
|
121
121
|
events(): {
|
|
122
122
|
change: import('..').BindingChangeEvent;
|
|
123
123
|
} & {
|
|
@@ -2,81 +2,13 @@ import { SvelteComponent } from 'svelte';
|
|
|
2
2
|
import type { BooleanMonitorParams } from '@tweakpane/core';
|
|
3
3
|
export type InternalMonitorBooleanOptions = BooleanMonitorParams;
|
|
4
4
|
declare const __propDef: {
|
|
5
|
-
props:
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
object: import('@tweakpane/core').Bindable & Record<string, boolean>;
|
|
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?: BooleanMonitorParams | 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('./GenericMonitor.svelte').GenericMonitorRef | 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/core').TpPluginBundle | undefined;
|
|
72
|
-
},
|
|
73
|
-
'object' | 'key'
|
|
74
|
-
> & {
|
|
75
|
-
/**
|
|
76
|
-
* A `boolean` value to monitor.
|
|
77
|
-
*/
|
|
78
|
-
value: boolean;
|
|
79
|
-
} & {
|
|
5
|
+
props: {
|
|
6
|
+
/**
|
|
7
|
+
* A `boolean` value to monitor.
|
|
8
|
+
* */
|
|
9
|
+
value: boolean;
|
|
10
|
+
} & Omit<
|
|
11
|
+
{
|
|
80
12
|
/**
|
|
81
13
|
* Number of past states to retain.
|
|
82
14
|
* @default `1` \
|
|
@@ -99,14 +31,82 @@ declare const __propDef: {
|
|
|
99
31
|
* Or `3` if value is `string` and `multiline` is `true`.
|
|
100
32
|
*/
|
|
101
33
|
rows?: number | undefined;
|
|
102
|
-
}
|
|
34
|
+
} & {
|
|
35
|
+
/**
|
|
36
|
+
* A `boolean` value to monitor.
|
|
37
|
+
*/
|
|
38
|
+
value: boolean;
|
|
39
|
+
} & Omit<
|
|
40
|
+
{
|
|
41
|
+
/**
|
|
42
|
+
* The binding's target object with values to manipulate.
|
|
43
|
+
* @bindable
|
|
44
|
+
*/
|
|
45
|
+
object: import('@tweakpane/core').Bindable & Record<string, boolean>;
|
|
46
|
+
/** The key for the value in the target `object` that the control should manipulate. */
|
|
47
|
+
key: string;
|
|
48
|
+
/**
|
|
49
|
+
* Prevent interactivity and gray out the control.
|
|
50
|
+
* @default `false`
|
|
51
|
+
*/
|
|
52
|
+
disabled?: boolean | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* Text displayed next to control.
|
|
55
|
+
* @default `undefined`
|
|
56
|
+
*/
|
|
57
|
+
label?: string | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* Tweakpane's internal options object.
|
|
60
|
+
*
|
|
61
|
+
* See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
|
|
62
|
+
*
|
|
63
|
+
* Valid types are contingent on the type of the value `key` points to in `object`.
|
|
64
|
+
*
|
|
65
|
+
* This is intended internal use, when implementing convenience components wrapping Binding's
|
|
66
|
+
* functionality. Options of interest are instead exposed as top-level props in _Svelte
|
|
67
|
+
* Tweakpane UI_.
|
|
68
|
+
* @default `undefined`
|
|
69
|
+
*/
|
|
70
|
+
options?: BooleanMonitorParams | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* Custom color scheme.
|
|
73
|
+
*
|
|
74
|
+
* @default `undefined` \
|
|
75
|
+
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
|
|
76
|
+
* set with `setGlobalDefaultTheme()`.
|
|
77
|
+
*/
|
|
78
|
+
theme?: import('..').Theme | undefined;
|
|
79
|
+
/**
|
|
80
|
+
* Reference to internal Tweakpane
|
|
81
|
+
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
|
|
82
|
+
* this control.
|
|
83
|
+
*
|
|
84
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
85
|
+
* components wrapping `<Binding>`'s functionality.
|
|
86
|
+
*
|
|
87
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
88
|
+
*
|
|
89
|
+
* @bindable
|
|
90
|
+
* @readonly
|
|
91
|
+
*/
|
|
92
|
+
ref?: import('./GenericMonitor.svelte').GenericMonitorRef | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
|
|
95
|
+
* the `<Binding>`'s containing `<Pane>`.
|
|
96
|
+
*
|
|
97
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
98
|
+
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
|
|
99
|
+
*
|
|
100
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
101
|
+
*
|
|
102
|
+
* @default `undefined`
|
|
103
|
+
*/
|
|
104
|
+
plugin?: import('@tweakpane/core').TpPluginBundle | undefined;
|
|
105
|
+
},
|
|
106
|
+
'object' | 'key'
|
|
107
|
+
>,
|
|
103
108
|
'ref' | 'options' | 'plugin' | 'interval'
|
|
104
|
-
|
|
105
|
-
/**
|
|
106
|
-
* A `boolean` value to monitor.
|
|
107
|
-
* */
|
|
108
|
-
value: boolean;
|
|
109
|
-
};
|
|
109
|
+
>;
|
|
110
110
|
events: {
|
|
111
111
|
[evt: string]: CustomEvent<any>;
|
|
112
112
|
};
|
|
@@ -2,106 +2,7 @@ import { SvelteComponent } from 'svelte';
|
|
|
2
2
|
import type { NumberMonitorParams } from '@tweakpane/core';
|
|
3
3
|
export type InternalMonitorNumberOptions = NumberMonitorParams;
|
|
4
4
|
declare const __propDef: {
|
|
5
|
-
props:
|
|
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?: NumberMonitorParams | 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('./GenericMonitor.svelte').GenericMonitorRef | 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/core').TpPluginBundle | undefined;
|
|
72
|
-
},
|
|
73
|
-
'object' | 'key'
|
|
74
|
-
> & {
|
|
75
|
-
/**
|
|
76
|
-
* A `number` value to monitor.
|
|
77
|
-
*/
|
|
78
|
-
value: number;
|
|
79
|
-
} & {
|
|
80
|
-
/**
|
|
81
|
-
* Number of past states to retain.
|
|
82
|
-
* @default `1` \
|
|
83
|
-
* Or `64` if value is `number` and `graph` is `true`.
|
|
84
|
-
*/
|
|
85
|
-
bufferSize?: number | undefined;
|
|
86
|
-
/**
|
|
87
|
-
* Time between value samples in milliseconds.
|
|
88
|
-
*
|
|
89
|
-
* Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
|
|
90
|
-
* @default `0`
|
|
91
|
-
*/
|
|
92
|
-
interval?: number | undefined;
|
|
93
|
-
/**
|
|
94
|
-
* Number of visible rows of state history.
|
|
95
|
-
*
|
|
96
|
-
* If `bufferSize` is larger, then the value window will scroll once state history exceeds
|
|
97
|
-
* row count.
|
|
98
|
-
* @default `1` \
|
|
99
|
-
* Or `3` if value is `string` and `multiline` is `true`.
|
|
100
|
-
*/
|
|
101
|
-
rows?: number | undefined;
|
|
102
|
-
},
|
|
103
|
-
'ref' | 'options' | 'plugin'
|
|
104
|
-
> & {
|
|
5
|
+
props: {
|
|
105
6
|
/**
|
|
106
7
|
* A `number` value to monitor.
|
|
107
8
|
* */
|
|
@@ -127,7 +28,106 @@ declare const __propDef: {
|
|
|
127
28
|
* @default `false`
|
|
128
29
|
* */
|
|
129
30
|
graph?: boolean | undefined;
|
|
130
|
-
}
|
|
31
|
+
} & Omit<
|
|
32
|
+
{
|
|
33
|
+
/**
|
|
34
|
+
* Number of past states to retain.
|
|
35
|
+
* @default `1` \
|
|
36
|
+
* Or `64` if value is `number` and `graph` is `true`.
|
|
37
|
+
*/
|
|
38
|
+
bufferSize?: number | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* Time between value samples in milliseconds.
|
|
41
|
+
*
|
|
42
|
+
* Useful when `graph` is true. Defaults to reactive value updates only (`interval={0}`).
|
|
43
|
+
* @default `0`
|
|
44
|
+
*/
|
|
45
|
+
interval?: number | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* Number of visible rows of state history.
|
|
48
|
+
*
|
|
49
|
+
* If `bufferSize` is larger, then the value window will scroll once state history exceeds
|
|
50
|
+
* row count.
|
|
51
|
+
* @default `1` \
|
|
52
|
+
* Or `3` if value is `string` and `multiline` is `true`.
|
|
53
|
+
*/
|
|
54
|
+
rows?: number | undefined;
|
|
55
|
+
} & {
|
|
56
|
+
/**
|
|
57
|
+
* A `number` value to monitor.
|
|
58
|
+
*/
|
|
59
|
+
value: number;
|
|
60
|
+
} & Omit<
|
|
61
|
+
{
|
|
62
|
+
/**
|
|
63
|
+
* The binding's target object with values to manipulate.
|
|
64
|
+
* @bindable
|
|
65
|
+
*/
|
|
66
|
+
object: import('@tweakpane/core').Bindable & Record<string, number>;
|
|
67
|
+
/** The key for the value in the target `object` that the control should manipulate. */
|
|
68
|
+
key: string;
|
|
69
|
+
/**
|
|
70
|
+
* Prevent interactivity and gray out the control.
|
|
71
|
+
* @default `false`
|
|
72
|
+
*/
|
|
73
|
+
disabled?: boolean | undefined;
|
|
74
|
+
/**
|
|
75
|
+
* Text displayed next to control.
|
|
76
|
+
* @default `undefined`
|
|
77
|
+
*/
|
|
78
|
+
label?: string | undefined;
|
|
79
|
+
/**
|
|
80
|
+
* Tweakpane's internal options object.
|
|
81
|
+
*
|
|
82
|
+
* See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
|
|
83
|
+
*
|
|
84
|
+
* Valid types are contingent on the type of the value `key` points to in `object`.
|
|
85
|
+
*
|
|
86
|
+
* This is intended internal use, when implementing convenience components wrapping Binding's
|
|
87
|
+
* functionality. Options of interest are instead exposed as top-level props in _Svelte
|
|
88
|
+
* Tweakpane UI_.
|
|
89
|
+
* @default `undefined`
|
|
90
|
+
*/
|
|
91
|
+
options?: NumberMonitorParams | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* Custom color scheme.
|
|
94
|
+
*
|
|
95
|
+
* @default `undefined` \
|
|
96
|
+
* Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
|
|
97
|
+
* set with `setGlobalDefaultTheme()`.
|
|
98
|
+
*/
|
|
99
|
+
theme?: import('..').Theme | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* Reference to internal Tweakpane
|
|
102
|
+
* [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
|
|
103
|
+
* this control.
|
|
104
|
+
*
|
|
105
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
106
|
+
* components wrapping `<Binding>`'s functionality.
|
|
107
|
+
*
|
|
108
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
109
|
+
*
|
|
110
|
+
* @bindable
|
|
111
|
+
* @readonly
|
|
112
|
+
*/
|
|
113
|
+
ref?: import('./GenericMonitor.svelte').GenericMonitorRef | undefined;
|
|
114
|
+
/**
|
|
115
|
+
* Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
|
|
116
|
+
* the `<Binding>`'s containing `<Pane>`.
|
|
117
|
+
*
|
|
118
|
+
* This property is exposed for advanced use cases only, such as when implementing convenience
|
|
119
|
+
* components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
|
|
120
|
+
*
|
|
121
|
+
* Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
|
|
122
|
+
*
|
|
123
|
+
* @default `undefined`
|
|
124
|
+
*/
|
|
125
|
+
plugin?: import('@tweakpane/core').TpPluginBundle | undefined;
|
|
126
|
+
},
|
|
127
|
+
'object' | 'key'
|
|
128
|
+
>,
|
|
129
|
+
'ref' | 'options' | 'plugin'
|
|
130
|
+
>;
|
|
131
131
|
events: {
|
|
132
132
|
[evt: string]: CustomEvent<any>;
|
|
133
133
|
};
|