@octans/ui 1.5.0 → 1.6.1

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 (41) hide show
  1. package/dist/components/CalendarHeatmap/CalendarHeatmap.vue.d.ts +13 -1
  2. package/dist/components/CalendarHeatmap/types.d.ts +7 -0
  3. package/dist/components/Checkbox/Checkbox.vue.d.ts +22 -0
  4. package/dist/components/Choice/Choice.vue.d.ts +27 -0
  5. package/dist/components/ChoiceList/ChoiceList.vue.d.ts +28 -0
  6. package/dist/components/ChoiceList/types.d.ts +7 -0
  7. package/dist/components/ColorSelector/ColorSelector.vue.d.ts +14 -2
  8. package/dist/components/ColorSelector/types.d.ts +7 -0
  9. package/dist/components/DatePicker/DatePicker.vue.d.ts +13 -1
  10. package/dist/components/DatePicker/types.d.ts +7 -0
  11. package/dist/components/FileInput/FileInput.vue.d.ts +39 -0
  12. package/dist/components/Filters/FilterItem.vue.d.ts +83 -5
  13. package/dist/components/Filters/Filters.vue.d.ts +87 -5
  14. package/dist/components/Labelled/Labelled.vue.d.ts +45 -0
  15. package/dist/components/NavField/NavField.vue.d.ts +39 -0
  16. package/dist/components/OtpInput/OtpInput.vue.d.ts +13 -1
  17. package/dist/components/OtpInput/types.d.ts +7 -0
  18. package/dist/components/Popover/Popover.vue.d.ts +5 -4
  19. package/dist/components/Popover/index.d.ts +3 -0
  20. package/dist/components/Popover/types.d.ts +13 -0
  21. package/dist/components/RadioButton/RadioButton.vue.d.ts +22 -0
  22. package/dist/components/RangeSlider/RangeSlider.vue.d.ts +43 -0
  23. package/dist/components/Rating/Rating.vue.d.ts +13 -1
  24. package/dist/components/Rating/types.d.ts +7 -0
  25. package/dist/components/ScrollPane/ScrollPane.vue.d.ts +14 -1
  26. package/dist/components/ScrollPane/index.d.ts +1 -1
  27. package/dist/components/ScrollPane/types.d.ts +22 -0
  28. package/dist/components/SegmentedControl/SegmentedControl.vue.d.ts +6 -2
  29. package/dist/components/SegmentedControl/types.d.ts +7 -0
  30. package/dist/components/Select/Select.vue.d.ts +42 -0
  31. package/dist/components/TextField/TextField.vue.d.ts +9 -5
  32. package/dist/components/TextField/types.d.ts +21 -0
  33. package/dist/components/TimePicker/TimePicker.vue.d.ts +13 -1
  34. package/dist/components/TimePicker/types.d.ts +7 -0
  35. package/dist/components/TimezonePicker/types.d.ts +7 -0
  36. package/dist/components/ToggleSwitch/ToggleSwitch.vue.d.ts +6 -2
  37. package/dist/components/ToggleSwitch/types.d.ts +7 -0
  38. package/dist/style.css +1 -1
  39. package/dist/ui.js +2327 -2062
  40. package/dist/ui.umd.js +3 -3
  41. package/package.json +1 -1
@@ -784,11 +784,47 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
784
784
  invert: boolean;
785
785
  pressed: boolean;
786
786
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
787
- DatePicker: import('vue').DefineComponent<import('../DatePicker').DatePickerProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
788
- "update:modelValue": (v: string | null) => any;
789
- }, string, import('vue').PublicProps, Readonly<import('../DatePicker').DatePickerProps> & Readonly<{
787
+ DatePicker: {
788
+ new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../DatePicker').DatePickerProps> & Readonly<{
789
+ "onUpdate:modelValue"?: ((v: string | null) => any) | undefined;
790
+ }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
791
+ "update:modelValue": (v: string | null) => any;
792
+ }, import('vue').PublicProps, {
793
+ disabled: boolean;
794
+ type: "datetime" | "date" | "month" | "year";
795
+ autoOpen: boolean;
796
+ readonly: boolean;
797
+ modelFormat: string;
798
+ minTime: string;
799
+ maxTime: string;
800
+ clearable: boolean;
801
+ }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
802
+ P: {};
803
+ B: {};
804
+ D: {};
805
+ C: {};
806
+ M: {};
807
+ Defaults: {};
808
+ }, Readonly<import('../DatePicker').DatePickerProps> & Readonly<{
809
+ "onUpdate:modelValue"?: ((v: string | null) => any) | undefined;
810
+ }>, {}, {}, {}, {}, {
811
+ disabled: boolean;
812
+ type: "datetime" | "date" | "month" | "year";
813
+ autoOpen: boolean;
814
+ readonly: boolean;
815
+ modelFormat: string;
816
+ minTime: string;
817
+ maxTime: string;
818
+ clearable: boolean;
819
+ }>;
820
+ __isFragment?: never;
821
+ __isTeleport?: never;
822
+ __isSuspense?: never;
823
+ } & import('vue').ComponentOptionsBase<Readonly<import('../DatePicker').DatePickerProps> & Readonly<{
790
824
  "onUpdate:modelValue"?: ((v: string | null) => any) | undefined;
791
- }>, {
825
+ }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
826
+ "update:modelValue": (v: string | null) => any;
827
+ }, string, {
792
828
  disabled: boolean;
793
829
  type: "datetime" | "date" | "month" | "year";
794
830
  autoOpen: boolean;
@@ -797,7 +833,13 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
797
833
  minTime: string;
798
834
  maxTime: string;
799
835
  clearable: boolean;
800
- }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
836
+ }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
837
+ $slots: {
838
+ label?: (props: any) => any;
839
+ } & {
840
+ helpText?: (props: {}) => any;
841
+ };
842
+ });
801
843
  TextField: {
802
844
  new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../TextField').TextFieldProps> & Readonly<{
803
845
  onClick?: ((event: MouseEvent) => any) | undefined;
@@ -857,6 +899,10 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
857
899
  emptyValue: string | number | null;
858
900
  }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
859
901
  $slots: {
902
+ label?: (props: any) => any;
903
+ } & {
904
+ helpText?: (props: {}) => any;
905
+ } & {
860
906
  left?: (props: {}) => any;
861
907
  } & {
862
908
  prefix?: (props: {}) => any;
@@ -883,6 +929,12 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
883
929
  helpLink: {
884
930
  type: PropType<string | false | null>;
885
931
  };
932
+ helpLinkIcon: {
933
+ type: StringConstructor;
934
+ };
935
+ helpLinkTooltip: {
936
+ type: StringConstructor;
937
+ };
886
938
  required: {
887
939
  type: BooleanConstructor;
888
940
  default: boolean;
@@ -1058,6 +1110,12 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1058
1110
  helpLink: {
1059
1111
  type: PropType<string | false | null>;
1060
1112
  };
1113
+ helpLinkIcon: {
1114
+ type: StringConstructor;
1115
+ };
1116
+ helpLinkTooltip: {
1117
+ type: StringConstructor;
1118
+ };
1061
1119
  required: {
1062
1120
  type: BooleanConstructor;
1063
1121
  default: boolean;
@@ -1215,6 +1273,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1215
1273
  ScrollPane: {
1216
1274
  new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../ScrollPane').ScrollPaneProps> & Readonly<{}>, {
1217
1275
  scrollTo: (x: number, y: number) => void;
1276
+ scrollIntoView: (target: Element | string | null | undefined, options?: import('../ScrollPane').ScrollPaneScrollIntoViewOptions) => void;
1218
1277
  update: () => void;
1219
1278
  }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
1220
1279
  disabled: boolean;
@@ -1230,6 +1289,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1230
1289
  Defaults: {};
1231
1290
  }, Readonly<import('../ScrollPane').ScrollPaneProps> & Readonly<{}>, {
1232
1291
  scrollTo: (x: number, y: number) => void;
1292
+ scrollIntoView: (target: Element | string | null | undefined, options?: import('../ScrollPane').ScrollPaneScrollIntoViewOptions) => void;
1233
1293
  update: () => void;
1234
1294
  }, {}, {}, {}, {
1235
1295
  disabled: boolean;
@@ -1242,6 +1302,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1242
1302
  __isSuspense?: never;
1243
1303
  } & import('vue').ComponentOptionsBase<Readonly<import('../ScrollPane').ScrollPaneProps> & Readonly<{}>, {
1244
1304
  scrollTo: (x: number, y: number) => void;
1305
+ scrollIntoView: (target: Element | string | null | undefined, options?: import('../ScrollPane').ScrollPaneScrollIntoViewOptions) => void;
1245
1306
  update: () => void;
1246
1307
  }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, {
1247
1308
  disabled: boolean;
@@ -1274,6 +1335,14 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1274
1335
  type: PropType<string | false | null>;
1275
1336
  required: false;
1276
1337
  };
1338
+ helpLinkIcon: {
1339
+ type: StringConstructor;
1340
+ default: string;
1341
+ };
1342
+ helpLinkTooltip: {
1343
+ type: StringConstructor;
1344
+ required: false;
1345
+ };
1277
1346
  required: {
1278
1347
  type: BooleanConstructor;
1279
1348
  required: false;
@@ -1301,12 +1370,21 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1301
1370
  type: PropType<string | false | null>;
1302
1371
  required: false;
1303
1372
  };
1373
+ helpLinkIcon: {
1374
+ type: StringConstructor;
1375
+ default: string;
1376
+ };
1377
+ helpLinkTooltip: {
1378
+ type: StringConstructor;
1379
+ required: false;
1380
+ };
1304
1381
  required: {
1305
1382
  type: BooleanConstructor;
1306
1383
  required: false;
1307
1384
  };
1308
1385
  }>> & Readonly<{}>, {
1309
1386
  required: boolean;
1387
+ helpLinkIcon: string;
1310
1388
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
1311
1389
  Tag: {
1312
1390
  new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../Tag/Tag.vue').TagProps> & Readonly<{
@@ -1596,6 +1674,10 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
1596
1674
  emptyValue: string | number | null;
1597
1675
  }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
1598
1676
  $slots: {
1677
+ label?: (props: any) => any;
1678
+ } & {
1679
+ helpText?: (props: {}) => any;
1680
+ } & {
1599
1681
  left?: (props: {}) => any;
1600
1682
  } & {
1601
1683
  prefix?: (props: {}) => any;
@@ -45,6 +45,28 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
45
45
  type: PropType<string | false | null>;
46
46
  required: false;
47
47
  };
48
+ /**
49
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
50
+ *
51
+ * Defaults to an information symbol. Change it where the link means
52
+ * something narrower than "help": `mdi:language-markdown` beside a field
53
+ * that accepts markdown says what the link is about before it is clicked.
54
+ */
55
+ helpLinkIcon: {
56
+ type: StringConstructor;
57
+ default: string;
58
+ };
59
+ /**
60
+ * Text shown on hovering the `helpLink` icon.
61
+ *
62
+ * Worth setting whenever the icon is not self-evident. The link opens in a
63
+ * new tab, so this is the reader's only chance to find out where it goes
64
+ * before they lose their place in the form.
65
+ */
66
+ helpLinkTooltip: {
67
+ type: StringConstructor;
68
+ required: false;
69
+ };
48
70
  /**
49
71
  * Marks the field as required, drawing an asterisk after the label.
50
72
  *
@@ -106,6 +128,28 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
106
128
  type: PropType<string | false | null>;
107
129
  required: false;
108
130
  };
131
+ /**
132
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
133
+ *
134
+ * Defaults to an information symbol. Change it where the link means
135
+ * something narrower than "help": `mdi:language-markdown` beside a field
136
+ * that accepts markdown says what the link is about before it is clicked.
137
+ */
138
+ helpLinkIcon: {
139
+ type: StringConstructor;
140
+ default: string;
141
+ };
142
+ /**
143
+ * Text shown on hovering the `helpLink` icon.
144
+ *
145
+ * Worth setting whenever the icon is not self-evident. The link opens in a
146
+ * new tab, so this is the reader's only chance to find out where it goes
147
+ * before they lose their place in the form.
148
+ */
149
+ helpLinkTooltip: {
150
+ type: StringConstructor;
151
+ required: false;
152
+ };
109
153
  /**
110
154
  * Marks the field as required, drawing an asterisk after the label.
111
155
  *
@@ -123,4 +167,5 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
123
167
  };
124
168
  }>> & Readonly<{}>, {
125
169
  required: boolean;
170
+ helpLinkIcon: string;
126
171
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
@@ -26,6 +26,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
26
26
  helpLink: {
27
27
  type: PropType<string | false | null>;
28
28
  };
29
+ /**
30
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
31
+ * Defaults to an information symbol.
32
+ */
33
+ helpLinkIcon: {
34
+ type: StringConstructor;
35
+ };
36
+ /** Text shown on hovering the `helpLink` icon. */
37
+ helpLinkTooltip: {
38
+ type: StringConstructor;
39
+ };
29
40
  placeholder: {
30
41
  type: StringConstructor;
31
42
  };
@@ -74,6 +85,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
74
85
  helpLink: {
75
86
  type: PropType<string | false | null>;
76
87
  };
88
+ /**
89
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
90
+ * Defaults to an information symbol.
91
+ */
92
+ helpLinkIcon: {
93
+ type: StringConstructor;
94
+ };
95
+ /** Text shown on hovering the `helpLink` icon. */
96
+ helpLinkTooltip: {
97
+ type: StringConstructor;
98
+ };
77
99
  placeholder: {
78
100
  type: StringConstructor;
79
101
  };
@@ -164,6 +186,14 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
164
186
  type: PropType<string | false | null>;
165
187
  required: false;
166
188
  };
189
+ helpLinkIcon: {
190
+ type: StringConstructor;
191
+ default: string;
192
+ };
193
+ helpLinkTooltip: {
194
+ type: StringConstructor;
195
+ required: false;
196
+ };
167
197
  required: {
168
198
  type: BooleanConstructor;
169
199
  required: false;
@@ -191,12 +221,21 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
191
221
  type: PropType<string | false | null>;
192
222
  required: false;
193
223
  };
224
+ helpLinkIcon: {
225
+ type: StringConstructor;
226
+ default: string;
227
+ };
228
+ helpLinkTooltip: {
229
+ type: StringConstructor;
230
+ required: false;
231
+ };
194
232
  required: {
195
233
  type: BooleanConstructor;
196
234
  required: false;
197
235
  };
198
236
  }>> & Readonly<{}>, {
199
237
  required: boolean;
238
+ helpLinkIcon: string;
200
239
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
201
240
  Spinner: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
202
241
  color: {
@@ -1,6 +1,12 @@
1
1
  import { OtpInputProps } from './types';
2
2
  declare function focus(): void;
3
- declare const __VLS_export: import('vue').DefineComponent<OtpInputProps, {
3
+ declare var __VLS_9: any, __VLS_12: {};
4
+ type __VLS_Slots = {} & {
5
+ label?: (props: typeof __VLS_9) => any;
6
+ } & {
7
+ helpText?: (props: typeof __VLS_12) => any;
8
+ };
9
+ declare const __VLS_base: import('vue').DefineComponent<OtpInputProps, {
4
10
  focus: typeof focus;
5
11
  }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
6
12
  complete: (value: string) => any;
@@ -17,5 +23,11 @@ declare const __VLS_export: import('vue').DefineComponent<OtpInputProps, {
17
23
  modelValue: string | null;
18
24
  separator: string;
19
25
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
26
+ declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
20
27
  declare const _default: typeof __VLS_export;
21
28
  export default _default;
29
+ type __VLS_WithSlots<T, S> = T & {
30
+ new (): {
31
+ $slots: S;
32
+ };
33
+ };
@@ -19,6 +19,13 @@ export interface OtpInputProps {
19
19
  * Renders a help icon next to the label which links to an external page.
20
20
  */
21
21
  helpLink?: string | false;
22
+ /**
23
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
24
+ * Defaults to an information symbol.
25
+ */
26
+ helpLinkIcon?: string;
27
+ /** Text shown on hovering the `helpLink` icon. */
28
+ helpLinkTooltip?: string;
22
29
  /**
23
30
  * The current value — the characters across all cells joined into a string.
24
31
  */
@@ -2,21 +2,21 @@ import { PopoverProps } from './types';
2
2
  declare function show(): void;
3
3
  declare function hide(): void;
4
4
  declare function toggle(): void;
5
- declare var __VLS_19: {
5
+ declare var __VLS_17: {
6
6
  visible: boolean;
7
7
  show: typeof show;
8
8
  hide: typeof hide;
9
9
  toggle: typeof toggle;
10
- }, __VLS_40: {
10
+ }, __VLS_38: {
11
11
  visible: boolean;
12
12
  show: typeof show;
13
13
  hide: typeof hide;
14
14
  toggle: typeof toggle;
15
15
  };
16
16
  type __VLS_Slots = {} & {
17
- trigger?: (props: typeof __VLS_19) => any;
17
+ trigger?: (props: typeof __VLS_17) => any;
18
18
  } & {
19
- default?: (props: typeof __VLS_40) => any;
19
+ default?: (props: typeof __VLS_38) => any;
20
20
  };
21
21
  declare const __VLS_base: import('vue').DefineComponent<PopoverProps, {
22
22
  show: typeof show;
@@ -33,6 +33,7 @@ declare const __VLS_base: import('vue').DefineComponent<PopoverProps, {
33
33
  autoTriggerToggle: boolean;
34
34
  autoHide: boolean;
35
35
  hover: boolean;
36
+ surface: boolean;
36
37
  zIndex: number;
37
38
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
38
39
  declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
@@ -25,6 +25,7 @@ export declare const Popper: {
25
25
  autoTriggerToggle: boolean;
26
26
  autoHide: boolean;
27
27
  hover: boolean;
28
+ surface: boolean;
28
29
  zIndex: number;
29
30
  }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
30
31
  P: {};
@@ -46,6 +47,7 @@ export declare const Popper: {
46
47
  autoTriggerToggle: boolean;
47
48
  autoHide: boolean;
48
49
  hover: boolean;
50
+ surface: boolean;
49
51
  zIndex: number;
50
52
  }>;
51
53
  __isFragment?: never;
@@ -66,6 +68,7 @@ export declare const Popper: {
66
68
  autoTriggerToggle: boolean;
67
69
  autoHide: boolean;
68
70
  hover: boolean;
71
+ surface: boolean;
69
72
  zIndex: number;
70
73
  }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
71
74
  $slots: {
@@ -25,5 +25,18 @@ export interface PopoverProps {
25
25
  * cascading sub-menus, so hovering a descendant keeps its ancestors open.
26
26
  */
27
27
  hover?: boolean;
28
+ /**
29
+ * Paints the content: surface colour, border, corner radius and a shadow.
30
+ *
31
+ * Off by default, and deliberately so — a popover hands the content slot
32
+ * straight through, so anything that already dresses itself (an
33
+ * `ActionListMenu`, a date picker, a card) would end up with two borders and
34
+ * two shadows. Turn it on for bring-your-own-content overlays, which would
35
+ * otherwise render transparent over the page.
36
+ *
37
+ * The styles land on the content's own root element and are defined with
38
+ * `:where()`, so any rule of your own still wins.
39
+ */
40
+ surface?: boolean;
28
41
  zIndex?: number;
29
42
  }
@@ -26,6 +26,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
26
26
  helpLink: {
27
27
  type: PropType<string | false | null>;
28
28
  };
29
+ /**
30
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
31
+ * Defaults to an information symbol.
32
+ */
33
+ helpLinkIcon: {
34
+ type: StringConstructor;
35
+ };
36
+ /** Text shown on hovering the `helpLink` icon. */
37
+ helpLinkTooltip: {
38
+ type: StringConstructor;
39
+ };
29
40
  /**
30
41
  * Radio buttons with the same name will form a group.
31
42
  */
@@ -93,6 +104,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
93
104
  helpLink: {
94
105
  type: PropType<string | false | null>;
95
106
  };
107
+ /**
108
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
109
+ * Defaults to an information symbol.
110
+ */
111
+ helpLinkIcon: {
112
+ type: StringConstructor;
113
+ };
114
+ /** Text shown on hovering the `helpLink` icon. */
115
+ helpLinkTooltip: {
116
+ type: StringConstructor;
117
+ };
96
118
  /**
97
119
  * Radio buttons with the same name will form a group.
98
120
  */
@@ -45,6 +45,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
45
45
  helpLink: {
46
46
  type: PropType<string | false | null>;
47
47
  };
48
+ /**
49
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
50
+ * Defaults to an information symbol.
51
+ */
52
+ helpLinkIcon: {
53
+ type: StringConstructor;
54
+ };
55
+ /** Text shown on hovering the `helpLink` icon. */
56
+ helpLinkTooltip: {
57
+ type: StringConstructor;
58
+ };
48
59
  /**
49
60
  * Disables the control and prevents all interaction.
50
61
  */
@@ -149,6 +160,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
149
160
  helpLink: {
150
161
  type: PropType<string | false | null>;
151
162
  };
163
+ /**
164
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
165
+ * Defaults to an information symbol.
166
+ */
167
+ helpLinkIcon: {
168
+ type: StringConstructor;
169
+ };
170
+ /** Text shown on hovering the `helpLink` icon. */
171
+ helpLinkTooltip: {
172
+ type: StringConstructor;
173
+ };
152
174
  /**
153
175
  * Disables the control and prevents all interaction.
154
176
  */
@@ -225,6 +247,14 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
225
247
  type: PropType<string | false | null>;
226
248
  required: false;
227
249
  };
250
+ helpLinkIcon: {
251
+ type: StringConstructor;
252
+ default: string;
253
+ };
254
+ helpLinkTooltip: {
255
+ type: StringConstructor;
256
+ required: false;
257
+ };
228
258
  required: {
229
259
  type: BooleanConstructor;
230
260
  required: false;
@@ -252,12 +282,21 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
252
282
  type: PropType<string | false | null>;
253
283
  required: false;
254
284
  };
285
+ helpLinkIcon: {
286
+ type: StringConstructor;
287
+ default: string;
288
+ };
289
+ helpLinkTooltip: {
290
+ type: StringConstructor;
291
+ required: false;
292
+ };
255
293
  required: {
256
294
  type: BooleanConstructor;
257
295
  required: false;
258
296
  };
259
297
  }>> & Readonly<{}>, {
260
298
  required: boolean;
299
+ helpLinkIcon: string;
261
300
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
262
301
  TextField: {
263
302
  new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../TextField').TextFieldProps> & Readonly<{
@@ -318,6 +357,10 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
318
357
  emptyValue: string | number | null;
319
358
  }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
320
359
  $slots: {
360
+ label?: (props: any) => any;
361
+ } & {
362
+ helpText?: (props: {}) => any;
363
+ } & {
321
364
  left?: (props: {}) => any;
322
365
  } & {
323
366
  prefix?: (props: {}) => any;
@@ -1,6 +1,12 @@
1
1
  import { RatingProps } from './types';
2
2
  declare function focus(): void;
3
- declare const __VLS_export: import('vue').DefineComponent<RatingProps, {
3
+ declare var __VLS_9: any, __VLS_12: {};
4
+ type __VLS_Slots = {} & {
5
+ label?: (props: typeof __VLS_9) => any;
6
+ } & {
7
+ helpText?: (props: typeof __VLS_12) => any;
8
+ };
9
+ declare const __VLS_base: import('vue').DefineComponent<RatingProps, {
4
10
  focus: typeof focus;
5
11
  }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
6
12
  change: (value: number) => any;
@@ -16,5 +22,11 @@ declare const __VLS_export: import('vue').DefineComponent<RatingProps, {
16
22
  fullIcon: string;
17
23
  fullColor: string;
18
24
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
25
+ declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
19
26
  declare const _default: typeof __VLS_export;
20
27
  export default _default;
28
+ type __VLS_WithSlots<T, S> = T & {
29
+ new (): {
30
+ $slots: S;
31
+ };
32
+ };
@@ -19,6 +19,13 @@ export interface RatingProps {
19
19
  * Renders a help icon next to the label which links to an external page.
20
20
  */
21
21
  helpLink?: string | false;
22
+ /**
23
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
24
+ * Defaults to an information symbol.
25
+ */
26
+ helpLinkIcon?: string;
27
+ /** Text shown on hovering the `helpLink` icon. */
28
+ helpLinkTooltip?: string;
22
29
  /**
23
30
  * The current rating value. `null` or `0` means unrated.
24
31
  */
@@ -1,12 +1,25 @@
1
- import { ScrollPaneProps } from './types';
1
+ import { ScrollPaneProps, ScrollPaneScrollIntoViewOptions } from './types';
2
2
  declare function updateImmediate(): void;
3
3
  declare function scrollTo(x: number, y: number): void;
4
+ /**
5
+ * Scrolls THIS pane so `target` is visible, and touches nothing else.
6
+ *
7
+ * `Element.scrollIntoView` walks every scrollable ancestor, so calling it on
8
+ * an item inside a pane that lives in a dropdown or a sheet is as likely to
9
+ * scroll the page out from under the overlay as it is to move the list. This
10
+ * knows which container it owns, so it scrolls that one.
11
+ *
12
+ * `target` may be an element or a selector resolved within the pane. Anything
13
+ * that is not inside the pane is ignored rather than guessed at.
14
+ */
15
+ declare function scrollIntoView(target: Element | string | null | undefined, options?: ScrollPaneScrollIntoViewOptions): void;
4
16
  declare var __VLS_1: {};
5
17
  type __VLS_Slots = {} & {
6
18
  default?: (props: typeof __VLS_1) => any;
7
19
  };
8
20
  declare const __VLS_base: import('vue').DefineComponent<ScrollPaneProps, {
9
21
  scrollTo: typeof scrollTo;
22
+ scrollIntoView: typeof scrollIntoView;
10
23
  update: typeof updateImmediate;
11
24
  }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<ScrollPaneProps> & Readonly<{}>, {
12
25
  disabled: boolean;
@@ -1,2 +1,2 @@
1
1
  export { default as ScrollPane } from './ScrollPane.vue';
2
- export type { ScrollPaneProps, ScrollPaneDirectionType } from './types';
2
+ export type { ScrollPaneProps, ScrollPaneDirectionType, ScrollPaneAlignType, ScrollPaneScrollIntoViewOptions } from './types';
@@ -1,4 +1,26 @@
1
1
  export type ScrollPaneDirectionType = 'vertical' | 'horizontal' | 'both';
2
+ /** Where in the pane `scrollIntoView` should leave the target. */
3
+ export type ScrollPaneAlignType = 'nearest' | 'start' | 'center' | 'end';
4
+ export interface ScrollPaneScrollIntoViewOptions {
5
+ /**
6
+ * Vertical placement. `"nearest"` (the default) scrolls only as far as it
7
+ * takes to make the target visible, and does nothing at all if it already
8
+ * is — the right behaviour for keyboard navigation through a list.
9
+ */
10
+ block?: ScrollPaneAlignType;
11
+ /**
12
+ * Horizontal placement. Same values as `block`, and ignored unless the
13
+ * pane's `direction` scrolls horizontally.
14
+ */
15
+ inline?: ScrollPaneAlignType;
16
+ /**
17
+ * Breathing room to leave between the target and the edge it is scrolled
18
+ * to, in pixels. Applies to `"nearest"`, `"start"` and `"end"`.
19
+ */
20
+ offset?: number;
21
+ /** Passed straight to `Element.scrollTo`. */
22
+ behavior?: ScrollBehavior;
23
+ }
2
24
  export interface ScrollPaneProps {
3
25
  /**
4
26
  * Which way the content scrolls.
@@ -1,11 +1,15 @@
1
1
  import { SegmentedControlProps, SegmentedOptionType } from './types';
2
- declare var __VLS_8: {
2
+ declare var __VLS_9: any, __VLS_12: {}, __VLS_14: {
3
3
  option: SegmentedOptionType;
4
4
  index: number;
5
5
  selected: boolean;
6
6
  };
7
7
  type __VLS_Slots = {} & {
8
- option?: (props: typeof __VLS_8) => any;
8
+ label?: (props: typeof __VLS_9) => any;
9
+ } & {
10
+ helpText?: (props: typeof __VLS_12) => any;
11
+ } & {
12
+ option?: (props: typeof __VLS_14) => any;
9
13
  };
10
14
  declare const __VLS_base: import('vue').DefineComponent<SegmentedControlProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
11
15
  change: (value: any, option: SegmentedOptionType) => any;