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.
Files changed (49) hide show
  1. package/dist/control/Button.svelte +1 -1
  2. package/dist/control/ButtonGrid.svelte.d.ts +30 -30
  3. package/dist/control/Checkbox.svelte.d.ts +8 -8
  4. package/dist/control/Color.svelte.d.ts +96 -96
  5. package/dist/control/CubicBezier.svelte.d.ts +41 -41
  6. package/dist/control/Image.svelte.d.ts +40 -34
  7. package/dist/control/IntervalSlider.svelte.d.ts +105 -95
  8. package/dist/control/List.svelte.d.ts +20 -20
  9. package/dist/control/Point.svelte +1 -1
  10. package/dist/control/Point.svelte.d.ts +115 -114
  11. package/dist/control/RadioGrid.svelte +1 -1
  12. package/dist/control/RadioGrid.svelte.d.ts +59 -59
  13. package/dist/control/Ring.svelte.d.ts +102 -107
  14. package/dist/control/RotationEuler.svelte +1 -1
  15. package/dist/control/RotationEuler.svelte.d.ts +106 -106
  16. package/dist/control/RotationQuaternion.svelte +1 -1
  17. package/dist/control/RotationQuaternion.svelte.d.ts +104 -104
  18. package/dist/control/Slider.svelte.d.ts +84 -84
  19. package/dist/control/Text.svelte.d.ts +24 -24
  20. package/dist/control/Textarea.svelte +1 -1
  21. package/dist/control/Textarea.svelte.d.ts +33 -33
  22. package/dist/control/Wheel.svelte.d.ts +97 -97
  23. package/dist/core/Binding.svelte +1 -1
  24. package/dist/core/Blade.svelte +1 -1
  25. package/dist/core/Folder.svelte.d.ts +4 -1
  26. package/dist/core/Pane.svelte.d.ts +295 -275
  27. package/dist/extra/AutoValue.svelte.d.ts +8 -8
  28. package/dist/extra/Element.svelte.d.ts +23 -23
  29. package/dist/internal/ClsPad.svelte +1 -1
  30. package/dist/internal/GenericBinding.svelte.d.ts +8 -8
  31. package/dist/internal/GenericBladeFolding.svelte.d.ts +24 -24
  32. package/dist/internal/GenericInput.svelte.d.ts +8 -8
  33. package/dist/internal/GenericInputFolding.svelte.d.ts +78 -78
  34. package/dist/internal/GenericMonitor.svelte.d.ts +76 -76
  35. package/dist/internal/GenericSlider.svelte.d.ts +76 -76
  36. package/dist/internal/InternalMonitorBoolean.svelte.d.ts +82 -82
  37. package/dist/internal/InternalMonitorNumber.svelte.d.ts +101 -101
  38. package/dist/internal/InternalMonitorString.svelte.d.ts +87 -87
  39. package/dist/internal/InternalPaneDraggable.svelte +79 -42
  40. package/dist/internal/InternalPaneDraggable.svelte.d.ts +76 -76
  41. package/dist/internal/InternalPaneFixed.svelte.d.ts +26 -26
  42. package/dist/internal/InternalPaneInline.svelte.d.ts +13 -13
  43. package/dist/monitor/FpsGraph.svelte.d.ts +90 -90
  44. package/dist/monitor/Monitor.svelte.d.ts +502 -381
  45. package/dist/monitor/Profiler.svelte.d.ts +131 -131
  46. package/dist/monitor/WaveformMonitor.svelte.d.ts +104 -107
  47. package/dist/theme.d.ts +1 -1
  48. package/package.json +21 -22
  49. package/readme.md +2 -2
@@ -1,7 +1,28 @@
1
1
  import { SvelteComponent } from 'svelte';
2
2
  import type { BladeRef } from '../core/Blade.svelte';
3
3
  declare const __propDef: {
4
- props: Omit<
4
+ props: {
5
+ /**
6
+ * Maximum height of the element block, in pixels. By default, the element
7
+ * block will expand vertically to fit its contents, but clip any horizontal
8
+ * excess.
9
+ *
10
+ * If a max height is set, it is used as the component height during SSR. If
11
+ * the actual element content is less than the max, you will see CLS. If it
12
+ * is not set, the contents are rendered... but keep in mind that style and
13
+ * other contextual changes during the client render could result in CLS.
14
+ * @default `undefined` \
15
+ * No max height.
16
+ */
17
+ maxHeight?: number | undefined;
18
+ /**
19
+ * Whether to reset the CSS of the element block to its default values.
20
+ * Avoids inheritance of Tweakpane's CSS styles. Note that this uses a
21
+ * simple `all: initial;` rule.
22
+ * @default `true`
23
+ */
24
+ resetStyle?: boolean | undefined;
25
+ } & Omit<
5
26
  {
6
27
  /**
7
28
  * Blade configuration exposing Tweakpane's internal
@@ -48,28 +69,7 @@ declare const __propDef: {
48
69
  plugin?: import('tweakpane').TpPluginBundle | undefined;
49
70
  },
50
71
  'ref' | 'disabled' | 'options' | 'plugin'
51
- > & {
52
- /**
53
- * Maximum height of the element block, in pixels. By default, the element
54
- * block will expand vertically to fit its contents, but clip any horizontal
55
- * excess.
56
- *
57
- * If a max height is set, it is used as the component height during SSR. If
58
- * the actual element content is less than the max, you will see CLS. If it
59
- * is not set, the contents are rendered... but keep in mind that style and
60
- * other contextual changes during the client render could result in CLS.
61
- * @default `undefined` \
62
- * No max height.
63
- */
64
- maxHeight?: number | undefined;
65
- /**
66
- * Whether to reset the CSS of the element block to its default values.
67
- * Avoids inheritance of Tweakpane's CSS styles. Note that this uses a
68
- * simple `all: initial;` rule.
69
- * @default `true`
70
- */
71
- resetStyle?: boolean | undefined;
72
- };
72
+ >;
73
73
  events: {
74
74
  [evt: string]: CustomEvent<any>;
75
75
  };
@@ -26,5 +26,5 @@
26
26
  <div
27
27
  style:background={DEV && showDebugBlocks ? getRandomCssColor() : null}
28
28
  style:height="{total}px"
29
- />
29
+ ></div>
30
30
  {/if}
@@ -5,7 +5,13 @@ declare class __sveltets_Render<
5
5
  U extends BindingOptions = BindingOptions,
6
6
  V extends BindingRef = BindingRef
7
7
  > {
8
- props(): Omit<
8
+ props(): {
9
+ /**
10
+ * The value to control.
11
+ * @bindable
12
+ * */
13
+ value: T;
14
+ } & Omit<
9
15
  {
10
16
  /**
11
17
  * The binding's target object with values to manipulate.
@@ -73,13 +79,7 @@ declare class __sveltets_Render<
73
79
  plugin?: import('tweakpane').TpPluginBundle | undefined;
74
80
  },
75
81
  'object' | 'key'
76
- > & {
77
- /**
78
- * The value to control.
79
- * @bindable
80
- * */
81
- value: T;
82
- };
82
+ >;
83
83
  events(): {
84
84
  change: import('../core/Binding.svelte').BindingChangeEvent;
85
85
  } & {
@@ -2,6 +2,30 @@ import { SvelteComponent } from 'svelte';
2
2
  import type { BladeOptions, BladeRef } from '../core/Blade.svelte';
3
3
  declare class __sveltets_Render<T extends BladeOptions, U extends BladeRef> {
4
4
  props(): {
5
+ /**
6
+ * DOM class name of the button used to expand and collapse the blade's picker.
7
+ * @default `undefined`
8
+ * */
9
+ buttonClass?: string | undefined;
10
+ /**
11
+ * Expand or collapse the blade's picker.
12
+ * @default `true`
13
+ * @bindable
14
+ * */
15
+ expanded?: boolean | undefined;
16
+ /**
17
+ * The style of value "picker" to use in the blade.
18
+ * @default `'popup'`
19
+ */
20
+ picker?: 'inline' | 'popup' | undefined;
21
+ /**
22
+ * Allow users to interactively expand / contract the value picker by clicking its icon.
23
+ *
24
+ * Most useful when `picker` is `inline`.
25
+ * @default `true`
26
+ * */
27
+ userExpandable?: boolean | undefined;
28
+ } & {
5
29
  /**
6
30
  * Blade configuration exposing Tweakpane's internal
7
31
  * [`BladeParams`](https://tweakpane.github.io/docs/api/interfaces/BaseBladeParams.html).
@@ -45,30 +69,6 @@ declare class __sveltets_Render<T extends BladeOptions, U extends BladeRef> {
45
69
  * @default `undefined`
46
70
  */
47
71
  plugin?: import('tweakpane').TpPluginBundle | undefined;
48
- } & {
49
- /**
50
- * DOM class name of the button used to expand and collapse the blade's picker.
51
- * @default `undefined`
52
- * */
53
- buttonClass?: string | undefined;
54
- /**
55
- * Expand or collapse the blade's picker.
56
- * @default `true`
57
- * @bindable
58
- * */
59
- expanded?: boolean | undefined;
60
- /**
61
- * The style of value "picker" to use in the blade.
62
- * @default `'popup'`
63
- */
64
- picker?: 'inline' | 'popup' | undefined;
65
- /**
66
- * Allow users to interactively expand / contract the value picker by clicking its icon.
67
- *
68
- * Most useful when `picker` is `inline`.
69
- * @default `true`
70
- * */
71
- userExpandable?: boolean | undefined;
72
72
  };
73
73
  events(): {} & {
74
74
  [evt: string]: CustomEvent<any>;
@@ -7,7 +7,13 @@ declare class __sveltets_Render<
7
7
  U extends GenericInputOptions = GenericInputOptions,
8
8
  V extends GenericInputRef = GenericInputRef
9
9
  > {
10
- props(): Omit<
10
+ props(): {
11
+ /**
12
+ * The value to control.
13
+ * @bindable
14
+ */
15
+ value: T;
16
+ } & Omit<
11
17
  {
12
18
  /**
13
19
  * The binding's target object with values to manipulate.
@@ -75,13 +81,7 @@ declare class __sveltets_Render<
75
81
  plugin?: import('@tweakpane/core').TpPluginBundle | undefined;
76
82
  },
77
83
  'object' | 'key'
78
- > & {
79
- /**
80
- * The value to control.
81
- * @bindable
82
- */
83
- value: T;
84
- };
84
+ >;
85
85
  events(): {
86
86
  change: import('..').BindingChangeEvent;
87
87
  } & {
@@ -1,89 +1,15 @@
1
1
  import { SvelteComponent } from 'svelte';
2
2
  import type { GenericInputOptions, GenericInputRef } from './GenericInput.svelte';
3
- export type GenericInputFoldingOptions = GenericInputOptions & {
3
+ export type GenericInputFoldingOptions = {
4
4
  expanded?: boolean;
5
- };
5
+ } & GenericInputOptions;
6
6
  export type GenericInputFoldingRef = GenericInputRef;
7
7
  declare class __sveltets_Render<
8
8
  T extends any,
9
9
  U extends GenericInputFoldingOptions = GenericInputFoldingOptions,
10
10
  V extends GenericInputFoldingRef = GenericInputFoldingRef
11
11
  > {
12
- props(): Omit<
13
- {
14
- /**
15
- * The binding's target object with values to manipulate.
16
- * @bindable
17
- */
18
- object: import('@tweakpane/core').Bindable & Record<string, T>;
19
- /** The key for the value in the target `object` that the control should manipulate. */
20
- key: string;
21
- /**
22
- * Prevent interactivity and gray out the control.
23
- * @default `false`
24
- */
25
- disabled?: boolean | undefined;
26
- /**
27
- * Text displayed next to control.
28
- * @default `undefined`
29
- */
30
- label?: string | undefined;
31
- /**
32
- * Tweakpane's internal options object.
33
- *
34
- * See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
35
- *
36
- * Valid types are contingent on the type of the value `key` points to in `object`.
37
- *
38
- * This is intended internal use, when implementing convenience components wrapping Binding's
39
- * functionality. Options of interest are instead exposed as top-level props in _Svelte
40
- * Tweakpane UI_.
41
- * @default `undefined`
42
- */
43
- options?: U | 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?: V | 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
- * The value to control.
83
- * @bindable
84
- */
85
- value: T;
86
- } & {
12
+ props(): {
87
13
  /**
88
14
  * DOM class name of the button used to expand and collapse the input's picker.
89
15
  * @default `undefined`
@@ -105,7 +31,81 @@ declare class __sveltets_Render<
105
31
  * @default `true`
106
32
  * */
107
33
  userExpandable?: boolean | undefined;
108
- };
34
+ } & {
35
+ /**
36
+ * The value to control.
37
+ * @bindable
38
+ */
39
+ value: T;
40
+ } & Omit<
41
+ {
42
+ /**
43
+ * The binding's target object with values to manipulate.
44
+ * @bindable
45
+ */
46
+ object: import('@tweakpane/core').Bindable & Record<string, T>;
47
+ /** The key for the value in the target `object` that the control should manipulate. */
48
+ key: string;
49
+ /**
50
+ * Prevent interactivity and gray out the control.
51
+ * @default `false`
52
+ */
53
+ disabled?: boolean | undefined;
54
+ /**
55
+ * Text displayed next to control.
56
+ * @default `undefined`
57
+ */
58
+ label?: string | undefined;
59
+ /**
60
+ * Tweakpane's internal options object.
61
+ *
62
+ * See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
63
+ *
64
+ * Valid types are contingent on the type of the value `key` points to in `object`.
65
+ *
66
+ * This is intended internal use, when implementing convenience components wrapping Binding's
67
+ * functionality. Options of interest are instead exposed as top-level props in _Svelte
68
+ * Tweakpane UI_.
69
+ * @default `undefined`
70
+ */
71
+ options?: U | undefined;
72
+ /**
73
+ * Custom color scheme.
74
+ *
75
+ * @default `undefined` \
76
+ * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
77
+ * set with `setGlobalDefaultTheme()`.
78
+ */
79
+ theme?: import('..').Theme | undefined;
80
+ /**
81
+ * Reference to internal Tweakpane
82
+ * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
83
+ * this control.
84
+ *
85
+ * This property is exposed for advanced use cases only, such as when implementing convenience
86
+ * components wrapping `<Binding>`'s functionality.
87
+ *
88
+ * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
89
+ *
90
+ * @bindable
91
+ * @readonly
92
+ */
93
+ ref?: V | undefined;
94
+ /**
95
+ * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
96
+ * the `<Binding>`'s containing `<Pane>`.
97
+ *
98
+ * This property is exposed for advanced use cases only, such as when implementing convenience
99
+ * components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
100
+ *
101
+ * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
102
+ *
103
+ * @default `undefined`
104
+ */
105
+ plugin?: import('tweakpane').TpPluginBundle | undefined;
106
+ },
107
+ 'object' | 'key'
108
+ >;
109
109
  events(): {
110
110
  change: import('..').BindingChangeEvent;
111
111
  } & {
@@ -7,81 +7,7 @@ declare class __sveltets_Render<
7
7
  U extends GenericMonitorOptions,
8
8
  V extends GenericMonitorRef = GenericMonitorRef
9
9
  > {
10
- props(): Omit<
11
- {
12
- /**
13
- * The binding's target object with values to manipulate.
14
- * @bindable
15
- */
16
- object: import('@tweakpane/core').Bindable & Record<string, T>;
17
- /** The key for the value in the target `object` that the control should manipulate. */
18
- key: string;
19
- /**
20
- * Prevent interactivity and gray out the control.
21
- * @default `false`
22
- */
23
- disabled?: boolean | undefined;
24
- /**
25
- * Text displayed next to control.
26
- * @default `undefined`
27
- */
28
- label?: string | undefined;
29
- /**
30
- * Tweakpane's internal options object.
31
- *
32
- * See [`BindingParams`](https://tweakpane.github.io/docs/api/types/BindingParams.html).
33
- *
34
- * Valid types are contingent on the type of the value `key` points to in `object`.
35
- *
36
- * This is intended internal use, when implementing convenience components wrapping Binding's
37
- * functionality. Options of interest are instead exposed as top-level props in _Svelte
38
- * Tweakpane UI_.
39
- * @default `undefined`
40
- */
41
- options?: U | undefined;
42
- /**
43
- * Custom color scheme.
44
- *
45
- * @default `undefined` \
46
- * Inherits default Tweakpane theme equivalent to `ThemeUtils.presets.standard`, or the theme
47
- * set with `setGlobalDefaultTheme()`.
48
- */
49
- theme?: import('..').Theme | undefined;
50
- /**
51
- * Reference to internal Tweakpane
52
- * [`BindingApi`](https://tweakpane.github.io/docs/api/classes/_internal_.BindingApi.html) for
53
- * this control.
54
- *
55
- * This property is exposed for advanced use cases only, such as when implementing convenience
56
- * components wrapping `<Binding>`'s functionality.
57
- *
58
- * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
59
- *
60
- * @bindable
61
- * @readonly
62
- */
63
- ref?: V | undefined;
64
- /**
65
- * Imported Tweakpane `TpPluginBundle` (aliased as `Plugin`) module to automatically register in
66
- * the `<Binding>`'s containing `<Pane>`.
67
- *
68
- * This property is exposed for advanced use cases only, such as when implementing convenience
69
- * components wrapping `<Binding>`'s functionality in combination with a Tweakpane plugin.
70
- *
71
- * Direct manipulation of Tweakpane's internals can break _Svelte Tweakpane UI_ abstractions.
72
- *
73
- * @default `undefined`
74
- */
75
- plugin?: import('@tweakpane/core').TpPluginBundle | undefined;
76
- },
77
- 'object' | 'key'
78
- > & {
79
- /**
80
- * The value to control.
81
- * @bindable
82
- */
83
- value: T;
84
- } & {
10
+ props(): {
85
11
  /**
86
12
  * Number of past states to retain.
87
13
  * @default `1` \
@@ -104,7 +30,81 @@ declare class __sveltets_Render<
104
30
  * Or `3` if value is `string` and `multiline` is `true`.
105
31
  * */
106
32
  rows?: number | undefined;
107
- };
33
+ } & {
34
+ /**
35
+ * The value to control.
36
+ * @bindable
37
+ */
38
+ value: T;
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, T>;
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?: U | 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?: V | 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
+ >;
108
108
  events(): {} & {
109
109
  [evt: string]: CustomEvent<any>;
110
110
  };
@@ -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(): Omit<
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
  } & {