@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
@@ -116,4 +116,11 @@ export interface SegmentedControlProps {
116
116
  * Renders a help icon next to the label which links to an external page.
117
117
  */
118
118
  helpLink?: string;
119
+ /**
120
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
121
+ * Defaults to an information symbol.
122
+ */
123
+ helpLinkIcon?: string;
124
+ /** Text shown on hovering the `helpLink` icon. */
125
+ helpLinkTooltip?: string;
119
126
  }
@@ -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
  * Marks the field as required: an asterisk after the label, and
50
61
  * `aria-required` on the control.
@@ -394,6 +405,17 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
394
405
  helpLink: {
395
406
  type: PropType<string | false | null>;
396
407
  };
408
+ /**
409
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
410
+ * Defaults to an information symbol.
411
+ */
412
+ helpLinkIcon: {
413
+ type: StringConstructor;
414
+ };
415
+ /** Text shown on hovering the `helpLink` icon. */
416
+ helpLinkTooltip: {
417
+ type: StringConstructor;
418
+ };
397
419
  /**
398
420
  * Marks the field as required: an asterisk after the label, and
399
421
  * `aria-required` on the control.
@@ -689,6 +711,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
689
711
  ScrollPane: {
690
712
  new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../ScrollPane').ScrollPaneProps> & Readonly<{}>, {
691
713
  scrollTo: (x: number, y: number) => void;
714
+ scrollIntoView: (target: Element | string | null | undefined, options?: import('../ScrollPane').ScrollPaneScrollIntoViewOptions) => void;
692
715
  update: () => void;
693
716
  }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
694
717
  disabled: boolean;
@@ -704,6 +727,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
704
727
  Defaults: {};
705
728
  }, Readonly<import('../ScrollPane').ScrollPaneProps> & Readonly<{}>, {
706
729
  scrollTo: (x: number, y: number) => void;
730
+ scrollIntoView: (target: Element | string | null | undefined, options?: import('../ScrollPane').ScrollPaneScrollIntoViewOptions) => void;
707
731
  update: () => void;
708
732
  }, {}, {}, {}, {
709
733
  disabled: boolean;
@@ -716,6 +740,7 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
716
740
  __isSuspense?: never;
717
741
  } & import('vue').ComponentOptionsBase<Readonly<import('../ScrollPane').ScrollPaneProps> & Readonly<{}>, {
718
742
  scrollTo: (x: number, y: number) => void;
743
+ scrollIntoView: (target: Element | string | null | undefined, options?: import('../ScrollPane').ScrollPaneScrollIntoViewOptions) => void;
719
744
  update: () => void;
720
745
  }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, {
721
746
  disabled: boolean;
@@ -748,6 +773,14 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
748
773
  type: PropType<string | false | null>;
749
774
  required: false;
750
775
  };
776
+ helpLinkIcon: {
777
+ type: StringConstructor;
778
+ default: string;
779
+ };
780
+ helpLinkTooltip: {
781
+ type: StringConstructor;
782
+ required: false;
783
+ };
751
784
  required: {
752
785
  type: BooleanConstructor;
753
786
  required: false;
@@ -775,12 +808,21 @@ declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractP
775
808
  type: PropType<string | false | null>;
776
809
  required: false;
777
810
  };
811
+ helpLinkIcon: {
812
+ type: StringConstructor;
813
+ default: string;
814
+ };
815
+ helpLinkTooltip: {
816
+ type: StringConstructor;
817
+ required: false;
818
+ };
778
819
  required: {
779
820
  type: BooleanConstructor;
780
821
  required: false;
781
822
  };
782
823
  }>> & Readonly<{}>, {
783
824
  required: boolean;
825
+ helpLinkIcon: string;
784
826
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
785
827
  Tag: {
786
828
  new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../Tag/Tag.vue').TagProps> & Readonly<{
@@ -1,14 +1,18 @@
1
1
  import { TextFieldProps } from './types';
2
2
  declare function focus(): void;
3
- declare var __VLS_14: {}, __VLS_16: {}, __VLS_31: {}, __VLS_33: {};
3
+ declare var __VLS_9: any, __VLS_12: {}, __VLS_20: {}, __VLS_22: {}, __VLS_37: {}, __VLS_39: {};
4
4
  type __VLS_Slots = {} & {
5
- left?: (props: typeof __VLS_14) => any;
5
+ label?: (props: typeof __VLS_9) => any;
6
6
  } & {
7
- prefix?: (props: typeof __VLS_16) => any;
7
+ helpText?: (props: typeof __VLS_12) => any;
8
8
  } & {
9
- suffix?: (props: typeof __VLS_31) => any;
9
+ left?: (props: typeof __VLS_20) => any;
10
10
  } & {
11
- right?: (props: typeof __VLS_33) => any;
11
+ prefix?: (props: typeof __VLS_22) => any;
12
+ } & {
13
+ suffix?: (props: typeof __VLS_37) => any;
14
+ } & {
15
+ right?: (props: typeof __VLS_39) => any;
12
16
  };
13
17
  declare const __VLS_base: import('vue').DefineComponent<TextFieldProps, {
14
18
  focus: typeof focus;
@@ -21,6 +21,13 @@ export interface TextFieldProps {
21
21
  * Renders a help icon next to the label which links to an external page.
22
22
  */
23
23
  helpLink?: string | false;
24
+ /**
25
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
26
+ * Defaults to an information symbol.
27
+ */
28
+ helpLinkIcon?: string;
29
+ /** Text shown on hovering the `helpLink` icon. */
30
+ helpLinkTooltip?: string;
24
31
  /**
25
32
  * The control value.
26
33
  */
@@ -33,6 +40,20 @@ export interface TextFieldProps {
33
40
  * Allow multiple lines of input.
34
41
  */
35
42
  multiline?: boolean | string | number;
43
+ /**
44
+ * How tall a `multiline` field may grow before it starts to scroll. Any CSS
45
+ * length, or `"none"` for no ceiling at all. A number is read as pixels.
46
+ *
47
+ * A multiline field already grows to fit what is typed into it; this is only
48
+ * the ceiling on that growth, and it defaults to `200px`. Reach for `"50vh"`
49
+ * more readily than `"none"` — a field that grows past the viewport inside a
50
+ * sheet or modal takes its buttons with it.
51
+ *
52
+ * The same thing is settable in CSS as `--octans-textfield-max-height`, on
53
+ * the field or any ancestor, for when the ceiling belongs to the layout
54
+ * rather than to the call site.
55
+ */
56
+ maxHeight?: string | number;
36
57
  /**
37
58
  * Maximum character length for the input.
38
59
  */
@@ -1,5 +1,11 @@
1
1
  import { TimePickerProps } from './types';
2
- declare const __VLS_export: import('vue').DefineComponent<TimePickerProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
2
+ declare var __VLS_9: any, __VLS_12: {};
3
+ type __VLS_Slots = {} & {
4
+ label?: (props: typeof __VLS_9) => any;
5
+ } & {
6
+ helpText?: (props: typeof __VLS_12) => any;
7
+ };
8
+ declare const __VLS_base: import('vue').DefineComponent<TimePickerProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
3
9
  "update:modelValue": (value: string | null) => any;
4
10
  }, string, import('vue').PublicProps, Readonly<TimePickerProps> & Readonly<{
5
11
  "onUpdate:modelValue"?: ((value: string | null) => any) | undefined;
@@ -21,5 +27,11 @@ declare const __VLS_export: import('vue').DefineComponent<TimePickerProps, {}, {
21
27
  minuteStep: number;
22
28
  minuteStepStrict: boolean;
23
29
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
30
+ declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
24
31
  declare const _default: typeof __VLS_export;
25
32
  export default _default;
33
+ type __VLS_WithSlots<T, S> = T & {
34
+ new (): {
35
+ $slots: S;
36
+ };
37
+ };
@@ -21,6 +21,13 @@ export interface TimePickerProps {
21
21
  * Renders a help icon next to the label which links to an external page.
22
22
  */
23
23
  helpLink?: string | false;
24
+ /**
25
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
26
+ * Defaults to an information symbol.
27
+ */
28
+ helpLinkIcon?: string;
29
+ /** Text shown on hovering the `helpLink` icon. */
30
+ helpLinkTooltip?: string;
24
31
  /**
25
32
  * Hint to display in the input when it is empty. Defaults to a format mask,
26
33
  * e.g. `"--:-- --"` (12 hour) or `"--:--"` (24 hour).
@@ -9,6 +9,13 @@ export interface TimezonePickerProps {
9
9
  helpTextHtml?: string;
10
10
  /** Renders a help icon next to the label which links to an external page. */
11
11
  helpLink?: string;
12
+ /**
13
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
14
+ * Defaults to an information symbol.
15
+ */
16
+ helpLinkIcon?: string;
17
+ /** Text shown on hovering the `helpLink` icon. */
18
+ helpLinkTooltip?: string;
12
19
  disabled?: boolean;
13
20
  readonly?: boolean;
14
21
  /**
@@ -1,9 +1,13 @@
1
1
  import { ToggleSwitchProps } from './types';
2
- declare var __VLS_8: {
2
+ declare var __VLS_9: any, __VLS_12: {}, __VLS_14: {
3
3
  checked: boolean;
4
4
  };
5
5
  type __VLS_Slots = {} & {
6
- handle?: (props: typeof __VLS_8) => any;
6
+ label?: (props: typeof __VLS_9) => any;
7
+ } & {
8
+ helpText?: (props: typeof __VLS_12) => any;
9
+ } & {
10
+ handle?: (props: typeof __VLS_14) => any;
7
11
  };
8
12
  declare const __VLS_base: import('vue').DefineComponent<ToggleSwitchProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
9
13
  "update:modelValue": (v: boolean) => any;
@@ -23,6 +23,13 @@ export interface ToggleSwitchProps {
23
23
  * Renders a help icon next to the label which links to an external page.
24
24
  */
25
25
  helpLink?: string | false | null;
26
+ /**
27
+ * The icon drawn for `helpLink` — any name the `Icon` component takes.
28
+ * Defaults to an information symbol.
29
+ */
30
+ helpLinkIcon?: string;
31
+ /** Text shown on hovering the `helpLink` icon. */
32
+ helpLinkTooltip?: string;
26
33
  /**
27
34
  * Marks the field as required: an asterisk after the label, and
28
35
  * `aria-required` on the switch.