vueless 1.4.12-beta.8 → 1.5.0

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 (98) hide show
  1. package/README.md +1 -1
  2. package/index.d.ts +128 -0
  3. package/index.ts +128 -0
  4. package/package.json +10 -9
  5. package/ui.button/config.ts +1 -1
  6. package/ui.button-link/config.ts +1 -1
  7. package/ui.button-toggle/UToggle.vue +6 -4
  8. package/ui.button-toggle/storybook/stories.ts +4 -1
  9. package/ui.button-toggle/tests/UToggle.test-d.ts +48 -0
  10. package/ui.button-toggle/tests/UToggleTypes.vue +55 -0
  11. package/ui.button-toggle/types.ts +18 -6
  12. package/ui.container-accordion/types.ts +5 -2
  13. package/ui.container-collapsible/config.ts +1 -1
  14. package/ui.data-list/UDataList.vue +48 -17
  15. package/ui.data-list/storybook/stories.ts +4 -1
  16. package/ui.data-list/tests/UDataList.test-d.ts +76 -0
  17. package/ui.data-list/tests/UDataList.test.ts +50 -1
  18. package/ui.data-list/tests/UDataListTypes.vue +110 -0
  19. package/ui.data-list/types.ts +37 -5
  20. package/ui.data-table/UTable.vue +68 -10
  21. package/ui.data-table/UTableRow.vue +4 -3
  22. package/ui.data-table/config.ts +1 -1
  23. package/ui.data-table/storybook/stories.ts +4 -1
  24. package/ui.data-table/tests/UTable.test-d.ts +179 -0
  25. package/ui.data-table/tests/UTable.test.ts +1 -1
  26. package/ui.data-table/tests/UTableEmptyColumnsTypes.vue +27 -0
  27. package/ui.data-table/tests/UTableTypes.vue +193 -0
  28. package/ui.data-table/types.ts +91 -8
  29. package/ui.data-table/utilTable.ts +1 -1
  30. package/ui.dropdown/UDropdown.vue +19 -8
  31. package/ui.dropdown/storybook/stories.ts +4 -1
  32. package/ui.dropdown/tests/UDropdown.test-d.ts +61 -0
  33. package/ui.dropdown/tests/UDropdown.test.ts +8 -1
  34. package/ui.dropdown/tests/UDropdownTypes.vue +111 -0
  35. package/ui.dropdown/types.ts +27 -3
  36. package/ui.dropdown-badge/UDropdownBadge.vue +9 -4
  37. package/ui.dropdown-badge/storybook/stories.ts +6 -1
  38. package/ui.dropdown-badge/tests/UDropdownBadge.test-d.ts +55 -0
  39. package/ui.dropdown-badge/tests/UDropdownBadge.test.ts +8 -1
  40. package/ui.dropdown-badge/tests/UDropdownBadgeTypes.vue +107 -0
  41. package/ui.dropdown-badge/types.ts +17 -3
  42. package/ui.dropdown-button/UDropdownButton.vue +9 -4
  43. package/ui.dropdown-button/storybook/stories.ts +6 -1
  44. package/ui.dropdown-button/tests/UDropdownButton.test-d.ts +57 -0
  45. package/ui.dropdown-button/tests/UDropdownButton.test.ts +8 -1
  46. package/ui.dropdown-button/tests/UDropdownButtonTypes.vue +107 -0
  47. package/ui.dropdown-button/types.ts +17 -3
  48. package/ui.dropdown-link/UDropdownLink.vue +9 -4
  49. package/ui.dropdown-link/config.ts +1 -1
  50. package/ui.dropdown-link/storybook/stories.ts +4 -1
  51. package/ui.dropdown-link/tests/UDropdownLink.test-d.ts +55 -0
  52. package/ui.dropdown-link/tests/UDropdownLink.test.ts +8 -1
  53. package/ui.dropdown-link/tests/UDropdownLinkTypes.vue +107 -0
  54. package/ui.dropdown-link/types.ts +17 -3
  55. package/ui.form-calendar/config.ts +1 -1
  56. package/ui.form-checkbox/config.ts +1 -1
  57. package/ui.form-checkbox/tests/UCheckbox.test.ts +4 -4
  58. package/ui.form-checkbox/types.ts +4 -2
  59. package/ui.form-checkbox-group/UCheckboxGroup.vue +8 -2
  60. package/ui.form-date-picker/UDatePicker.vue +11 -1
  61. package/ui.form-date-picker/tests/UDatePicker.test.ts +47 -0
  62. package/ui.form-input/config.ts +1 -1
  63. package/ui.form-input-file/config.ts +1 -1
  64. package/ui.form-listbox/UListbox.vue +29 -12
  65. package/ui.form-listbox/config.ts +1 -1
  66. package/ui.form-listbox/storybook/stories.ts +4 -1
  67. package/ui.form-listbox/tests/UListbox.test-d.ts +63 -0
  68. package/ui.form-listbox/tests/UListboxTypes.vue +107 -0
  69. package/ui.form-listbox/types.ts +34 -2
  70. package/ui.form-radio/config.ts +1 -1
  71. package/ui.form-radio-group/URadioGroup.vue +15 -3
  72. package/ui.form-radio-group/config.ts +8 -3
  73. package/ui.form-radio-group/types.ts +2 -3
  74. package/ui.form-select/USelect.vue +49 -17
  75. package/ui.form-select/config.ts +4 -4
  76. package/ui.form-select/storybook/stories.ts +4 -1
  77. package/ui.form-select/tests/USelect.test-d.ts +76 -0
  78. package/ui.form-select/tests/USelect.test.ts +65 -1
  79. package/ui.form-select/tests/USelectTypes.vue +113 -0
  80. package/ui.form-select/types.ts +55 -4
  81. package/ui.form-switch/USwitch.vue +13 -12
  82. package/ui.form-switch/config.ts +2 -1
  83. package/ui.form-switch/tests/USwitch.test.ts +151 -0
  84. package/ui.form-textarea/config.ts +1 -1
  85. package/ui.image-avatar/types.ts +5 -2
  86. package/ui.image-avatar-group/types.ts +5 -2
  87. package/ui.image-icon/UIcon.vue +3 -2
  88. package/ui.image-icon/types.ts +2 -2
  89. package/ui.navigation-breadcrumbs/types.ts +5 -2
  90. package/ui.navigation-tabs/UTabs.vue +6 -4
  91. package/ui.navigation-tabs/storybook/stories.ts +4 -1
  92. package/ui.navigation-tabs/tests/UTabs.test-d.ts +50 -0
  93. package/ui.navigation-tabs/tests/UTabsTypes.vue +65 -0
  94. package/ui.navigation-tabs/types.ts +25 -3
  95. package/ui.skeleton-text/constants.ts +1 -1
  96. package/ui.text-badge/config.ts +1 -1
  97. package/utils/node/loaderIcon.js +1 -1
  98. package/v.tooltip/vTooltip.ts +1 -1
@@ -0,0 +1,61 @@
1
+ import { describe, it, expectTypeOf } from "vitest";
2
+
3
+ import type { Props, UDropdownSlots } from "../types";
4
+ import type { ListboxOption, SlotOption } from "../../ui.form-listbox/types";
5
+
6
+ interface UserOption {
7
+ label: string;
8
+ value: string;
9
+ qty: number;
10
+ }
11
+
12
+ type OptionProps = Parameters<NonNullable<UDropdownSlots<UserOption>["option"]>>[0];
13
+ type DefaultProps = Parameters<NonNullable<UDropdownSlots<UserOption>["default"]>>[0];
14
+
15
+ describe("UDropdown types", () => {
16
+ it("infers the caller's option shape in a forwarded option slot", () => {
17
+ expectTypeOf<OptionProps["option"]["label"]>().toEqualTypeOf<string | undefined>();
18
+ expectTypeOf<OptionProps["option"]["qty"]>().toEqualTypeOf<number | undefined>();
19
+ expectTypeOf<OptionProps["index"]>().toEqualTypeOf<number>();
20
+ });
21
+
22
+ it("does not expose undeclared option properties to a slot", () => {
23
+ type HasIndexSignature = string extends keyof OptionProps["option"] ? true : false;
24
+
25
+ expectTypeOf<HasIndexSignature>().toEqualTypeOf<false>();
26
+ });
27
+
28
+ it("reuses UListbox's SlotOption rather than a second dialect", () => {
29
+ expectTypeOf<OptionProps["option"]>().toEqualTypeOf<SlotOption<UserOption>>();
30
+ });
31
+
32
+ it("does not promise the caller's members on any option slot", () => {
33
+ /* The option slots are forwarded to `UListbox`, whose `filterGroups` concats nested group
34
+ * members into the flat list — a member need not carry the parent's members. */
35
+ type BeforeProps = Parameters<NonNullable<UDropdownSlots<UserOption>["before-option"]>>[0];
36
+ type AfterProps = Parameters<NonNullable<UDropdownSlots<UserOption>["after-option"]>>[0];
37
+
38
+ type GroupMember = { value: string; title: string };
39
+
40
+ expectTypeOf<GroupMember>().toExtend<BeforeProps["option"]>();
41
+ expectTypeOf<GroupMember>().toExtend<OptionProps["option"]>();
42
+ expectTypeOf<GroupMember>().toExtend<AfterProps["option"]>();
43
+ });
44
+
45
+ it("keeps the full guarantee on selectedOptions, which is a plain subset", () => {
46
+ /* `selectedOptions` filters `props.options` and injects nothing (`UDropdown.vue:93`), so
47
+ * unlike the option slots it is NOT Partial. */
48
+ expectTypeOf<DefaultProps["selectedOptions"]>().toEqualTypeOf<UserOption[]>();
49
+ expectTypeOf<DefaultProps["selectedOptions"][number]["label"]>().toEqualTypeOf<string>();
50
+ });
51
+
52
+ it("types displayLabel as possibly undefined", () => {
53
+ /* It joins `option[labelKey]` lookups, which are `undefined` for an option without that key. */
54
+ expectTypeOf<DefaultProps["displayLabel"]>().toEqualTypeOf<string | undefined>();
55
+ });
56
+
57
+ it("resolves Props with no type argument", () => {
58
+ expectTypeOf<Props>().toEqualTypeOf<Props<ListboxOption>>();
59
+ expectTypeOf<Props<UserOption>["options"]>().toEqualTypeOf<UserOption[] | undefined>();
60
+ });
61
+ });
@@ -3,7 +3,14 @@ import { describe, it, expect } from "vitest";
3
3
  import { nextTick } from "vue";
4
4
 
5
5
  import UDropdown from "../UDropdown.vue";
6
- import UListbox from "../../ui.form-listbox/UListbox.vue";
6
+ import UListboxComponent from "../../ui.form-listbox/UListbox.vue";
7
+
8
+ import type { ComponentProps } from "../../types";
9
+
10
+ /* Generic SFCs are typed as a function, which `findComponent` does not accept. */
11
+ const UListbox = UListboxComponent as unknown as new () => {
12
+ $props: ComponentProps<typeof UListboxComponent>;
13
+ };
7
14
 
8
15
  describe("UDropdown.vue", () => {
9
16
  const defaultOptions = [
@@ -0,0 +1,111 @@
1
+ <!-- Type-level fixture: checked by `npm run ts:check`, never mounted.
2
+ Proves slot props infer from the `options` prop at a real call site. -->
3
+ <template>
4
+ <UDropdown :options="options">
5
+ <!-- Forwarded verbatim to `UListbox`, so they inherit its group flattening — a flattened
6
+ member need not carry the parent's members, hence the optional types. -->
7
+ <template #before-option="{ option, index }">
8
+ {{ expectOptionalString(option.label) }}
9
+ {{ expectOptionalNumber(option.qty) }}
10
+ {{ expectNumber(index) }}
11
+ </template>
12
+
13
+ <template #option="{ option, index }">
14
+ {{ expectOptionalString(option.label) }}
15
+ {{ expectNumber(index) }}
16
+ </template>
17
+
18
+ <template #after-option="{ option, index }">
19
+ {{ expectOptionalString(option.label) }}
20
+ {{ expectNumber(index) }}
21
+ </template>
22
+
23
+ <!-- `selectedOptions` is a `filter`ed subset of `props.options` with nothing injected, so it
24
+ keeps the full (non-Partial) guarantee — unlike the option slots above. -->
25
+ <template #default="{ selectedOptions, opened }">
26
+ {{ expectString(selectedOptions[0].label) }}
27
+ {{ expectNumber(selectedOptions[0].qty) }}
28
+ {{ expectBoolean(opened) }}
29
+ </template>
30
+
31
+ <template #empty>empty</template>
32
+ </UDropdown>
33
+
34
+ <!-- Options from a non-literal source still expose the declared option shape. -->
35
+ <UDropdown :options="typedOptions">
36
+ <template #option="{ option }">{{ expectOptionalString(option.label) }}</template>
37
+ </UDropdown>
38
+
39
+ <UDropdown :options="options">
40
+ <template #option="{ option }">
41
+ <!-- @vue-expect-error `nonExistent` is not a key of the inferred option. -->
42
+ {{ option.nonExistent }}
43
+ </template>
44
+ </UDropdown>
45
+
46
+ <!-- Regression guard: an option slot must never promise the caller's members as present. -->
47
+ <UDropdown
48
+ :options="groupedOptions"
49
+ group-label-key="groupName"
50
+ group-value-key="children"
51
+ label-key="label"
52
+ >
53
+ <template #option="{ option }">
54
+ <!-- @vue-expect-error a flattened group member need not carry `label`. -->
55
+ {{ expectString(option.label) }}
56
+ </template>
57
+ <template #before-option="{ option }">
58
+ <!-- @vue-expect-error a flattened group member need not carry `qty`. -->
59
+ {{ expectNumber(option.qty) }}
60
+ </template>
61
+ <template #after-option="{ option }">
62
+ <!-- @vue-expect-error a flattened group member need not carry `groupName`. -->
63
+ {{ expectString(option.groupName) }}
64
+ </template>
65
+ </UDropdown>
66
+ </template>
67
+
68
+ <script setup lang="ts">
69
+ import { ref } from "vue";
70
+
71
+ import UDropdown from "../UDropdown.vue";
72
+
73
+ interface UserOption {
74
+ label: string;
75
+ value: string;
76
+ qty: number;
77
+ }
78
+
79
+ const options = [{ label: "a", value: "a", qty: 1 }];
80
+ const typedOptions = ref<UserOption[]>([]);
81
+
82
+ /* A group whose members lack the parent's members — exactly what `filterGroups` flattens. */
83
+ const groupedOptions = [
84
+ {
85
+ groupName: "Group A",
86
+ label: "Group A",
87
+ qty: 1,
88
+ children: [{ value: "c1", title: "Child" }],
89
+ },
90
+ ];
91
+
92
+ function expectString(value: string) {
93
+ return value;
94
+ }
95
+
96
+ function expectNumber(value: number) {
97
+ return value;
98
+ }
99
+
100
+ function expectBoolean(value: boolean) {
101
+ return value;
102
+ }
103
+
104
+ function expectOptionalString(value: string | undefined) {
105
+ return value;
106
+ }
107
+
108
+ function expectOptionalNumber(value: number | undefined) {
109
+ return value;
110
+ }
111
+ </script>
@@ -1,11 +1,35 @@
1
1
  import defaultConfig from "./config";
2
2
 
3
- import type { Option } from "../ui.form-listbox/types";
3
+ import type { ListboxOption, SlotOption } from "../ui.form-listbox/types";
4
4
  import type { ComponentConfig, UnknownObject } from "../types";
5
5
 
6
6
  export type Config = typeof defaultConfig;
7
7
 
8
- export interface Props {
8
+ /**
9
+ * The option slots are forwarded verbatim to `UListbox`, so they inherit its flattening: with
10
+ * `groupValueKey` set, `filterGroups` concats nested group members into the list the slots iterate
11
+ * and those members need not carry the parent's members. Hence `SlotOption`, which is `Partial`.
12
+ *
13
+ * `selectedOptions` is different — it is a `filter`ed subset of `props.options` (`UDropdown.vue:91`)
14
+ * with no synthetic entry, so it keeps the full `TOption` guarantee.
15
+ */
16
+ export interface UDropdownSlots<TOption extends ListboxOption = ListboxOption> {
17
+ default?: (props: {
18
+ /* `displayLabel` joins `option[labelKey]` lookups, which yield `undefined` for an option
19
+ without that key — so it is only `string` when the label is resolvable. */
20
+ opened: boolean;
21
+ displayLabel: string | undefined;
22
+ fullLabel: string;
23
+ selectedOptions: TOption[];
24
+ }) => unknown;
25
+ dropdown?: (props: { opened: boolean; contentClasses: string | undefined }) => unknown;
26
+ "before-option"?: (props: { option: SlotOption<TOption>; index: number }) => unknown;
27
+ option?: (props: { option: SlotOption<TOption>; index: number }) => unknown;
28
+ "after-option"?: (props: { option: SlotOption<TOption>; index: number }) => unknown;
29
+ empty?: () => unknown;
30
+ }
31
+
32
+ export interface Props<TOption extends ListboxOption = ListboxOption> {
9
33
  /**
10
34
  * Selected dropdown value.
11
35
  */
@@ -24,7 +48,7 @@ export interface Props {
24
48
  /**
25
49
  * Options list.
26
50
  */
27
- options?: Option[];
51
+ options?: TOption[];
28
52
 
29
53
  /**
30
54
  * Label key in the item object of options.
@@ -1,4 +1,4 @@
1
- <script setup lang="ts">
1
+ <script setup lang="ts" generic="TOption extends ListboxOption">
2
2
  import { computed, useTemplateRef } from "vue";
3
3
 
4
4
  import { useUI } from "../composables/useUI";
@@ -11,11 +11,13 @@ import UDropdown from "../ui.dropdown/UDropdown.vue";
11
11
  import defaultConfig from "./config";
12
12
  import { COMPONENT_NAME } from "./constants";
13
13
 
14
- import type { Props, Config } from "./types";
14
+ import type { Props, Config, UDropdownBadgeSlots } from "./types";
15
+ import type { ListboxOption } from "../ui.form-listbox/types";
16
+ import type { ComponentExposed } from "../types";
15
17
 
16
18
  defineOptions({ inheritAttrs: false });
17
19
 
18
- const props = withDefaults(defineProps<Props>(), {
20
+ const props = withDefaults(defineProps<Props<TOption>>(), {
19
21
  ...getDefaults<Props, Config>(defaultConfig, COMPONENT_NAME),
20
22
  options: () => [],
21
23
  modelValue: "",
@@ -59,7 +61,10 @@ const emit = defineEmits([
59
61
  "update:search",
60
62
  ]);
61
63
 
62
- type UDropdownRef = InstanceType<typeof UDropdown>;
64
+ defineSlots<UDropdownBadgeSlots<TOption>>();
65
+
66
+ /* `UDropdown` is generic, so its type is a function — `InstanceType` does not apply. */
67
+ type UDropdownRef = ComponentExposed<typeof UDropdown>;
63
68
 
64
69
  const dropdownRef = useTemplateRef<UDropdownRef>("dropdown");
65
70
 
@@ -6,7 +6,7 @@ import {
6
6
  getDocsDescription,
7
7
  } from "../../utils/storybook";
8
8
 
9
- import UDropdownBadge from "../../ui.dropdown-badge/UDropdownBadge.vue";
9
+ import UDropdownBadgeComponent from "../../ui.dropdown-badge/UDropdownBadge.vue";
10
10
  import URow from "../../ui.container-row/URow.vue";
11
11
  import UCol from "../../ui.container-col/UCol.vue";
12
12
  import UIcon from "../../ui.image-icon/UIcon.vue";
@@ -24,6 +24,11 @@ import emilyDavis from "../../ui.form-select/storybook/assets/images/emily-davis
24
24
  import alexJohnson from "../../ui.form-select/storybook/assets/images/alex-johnson.png";
25
25
  import patMorgan from "../../ui.form-select/storybook/assets/images/pat-morgan.png";
26
26
 
27
+ /* Generic SFCs are typed as a function, which drops the compiler-generated `__name`. */
28
+ const UDropdownBadge = UDropdownBadgeComponent as typeof UDropdownBadgeComponent & {
29
+ __name: string;
30
+ };
31
+
27
32
  interface DefaultUDropdownBadgeArgs extends Props {
28
33
  slotTemplate?: string;
29
34
  }
@@ -0,0 +1,55 @@
1
+ import { describe, it, expectTypeOf } from "vitest";
2
+
3
+ import type { Props, UDropdownBadgeSlots } from "../types";
4
+ import type { ListboxOption, SlotOption } from "../../ui.form-listbox/types";
5
+
6
+ interface UserOption {
7
+ label: string;
8
+ value: string;
9
+ qty: number;
10
+ }
11
+
12
+ type OptionProps = Parameters<NonNullable<UDropdownBadgeSlots<UserOption>["option"]>>[0];
13
+
14
+ describe("UDropdownBadge types", () => {
15
+ it("infers the caller's option shape in a forwarded option slot", () => {
16
+ expectTypeOf<OptionProps["option"]["label"]>().toEqualTypeOf<string | undefined>();
17
+ expectTypeOf<OptionProps["option"]["qty"]>().toEqualTypeOf<number | undefined>();
18
+ expectTypeOf<OptionProps["index"]>().toEqualTypeOf<number>();
19
+ });
20
+
21
+ it("does not expose undeclared option properties to a slot", () => {
22
+ type HasIndexSignature = string extends keyof OptionProps["option"] ? true : false;
23
+
24
+ expectTypeOf<HasIndexSignature>().toEqualTypeOf<false>();
25
+ });
26
+
27
+ it("reuses UListbox's SlotOption rather than a second dialect", () => {
28
+ expectTypeOf<OptionProps["option"]>().toEqualTypeOf<SlotOption<UserOption>>();
29
+ });
30
+
31
+ it("does not promise the caller's members on any option slot", () => {
32
+ /* Forwarded through `UDropdown` to `UListbox`, whose `filterGroups` concats nested group
33
+ * members into the flat list — a member need not carry the parent's members. */
34
+ type BeforeProps = Parameters<NonNullable<UDropdownBadgeSlots<UserOption>["before-option"]>>[0];
35
+ type AfterProps = Parameters<NonNullable<UDropdownBadgeSlots<UserOption>["after-option"]>>[0];
36
+
37
+ type GroupMember = { value: string; title: string };
38
+
39
+ expectTypeOf<GroupMember>().toExtend<BeforeProps["option"]>();
40
+ expectTypeOf<GroupMember>().toExtend<OptionProps["option"]>();
41
+ expectTypeOf<GroupMember>().toExtend<AfterProps["option"]>();
42
+ });
43
+
44
+ it("types the default slot label as possibly undefined", () => {
45
+ /* It is `UDropdown`'s `displayLabel`, a join of `option[labelKey]` lookups. */
46
+ type DefaultProps = Parameters<NonNullable<UDropdownBadgeSlots<UserOption>["default"]>>[0];
47
+
48
+ expectTypeOf<DefaultProps["label"]>().toEqualTypeOf<string | undefined>();
49
+ });
50
+
51
+ it("resolves Props with no type argument", () => {
52
+ expectTypeOf<Props>().toEqualTypeOf<Props<ListboxOption>>();
53
+ expectTypeOf<Props<UserOption>["options"]>().toEqualTypeOf<UserOption[] | undefined>();
54
+ });
55
+ });
@@ -4,10 +4,17 @@ import { describe, it, expect } from "vitest";
4
4
  import UDropdownBadge from "../UDropdownBadge.vue";
5
5
  import UBadge from "../../ui.text-badge/UBadge.vue";
6
6
  import UIcon from "../../ui.image-icon/UIcon.vue";
7
- import UListbox from "../../ui.form-listbox/UListbox.vue";
7
+ import UListboxComponent from "../../ui.form-listbox/UListbox.vue";
8
8
 
9
9
  import type { Props } from "../types";
10
10
 
11
+ import type { ComponentProps } from "../../types";
12
+
13
+ /* Generic SFCs are typed as a function, which `findComponent` does not accept. */
14
+ const UListbox = UListboxComponent as unknown as new () => {
15
+ $props: ComponentProps<typeof UListboxComponent>;
16
+ };
17
+
11
18
  describe("UDropdownBadge.vue", () => {
12
19
  const defaultOptions = [
13
20
  { value: 1, label: "Option 1" },
@@ -0,0 +1,107 @@
1
+ <!-- Type-level fixture: checked by `npm run ts:check`, never mounted.
2
+ Proves slot props infer from the `options` prop at a real call site. -->
3
+ <template>
4
+ <UDropdownBadge :options="options">
5
+ <!-- Forwarded through `UDropdown` to `UListbox`, so they inherit its group flattening — a
6
+ flattened member need not carry the parent's members, hence the optional types. -->
7
+ <template #before-option="{ option, index }">
8
+ {{ expectOptionalString(option.label) }}
9
+ {{ expectOptionalNumber(option.qty) }}
10
+ {{ expectNumber(index) }}
11
+ </template>
12
+
13
+ <template #option="{ option, index }">
14
+ {{ expectOptionalString(option.label) }}
15
+ {{ expectNumber(index) }}
16
+ </template>
17
+
18
+ <template #after-option="{ option, index }">
19
+ {{ expectOptionalString(option.label) }}
20
+ {{ expectNumber(index) }}
21
+ </template>
22
+
23
+ <template #empty>empty</template>
24
+ </UDropdownBadge>
25
+
26
+ <!-- Options from a non-literal source still expose the declared option shape. -->
27
+ <UDropdownBadge :options="typedOptions">
28
+ <template #option="{ option }">{{ expectOptionalString(option.label) }}</template>
29
+ </UDropdownBadge>
30
+
31
+ <UDropdownBadge :options="options">
32
+ <template #option="{ option }">
33
+ <!-- @vue-expect-error `nonExistent` is not a key of the inferred option. -->
34
+ {{ option.nonExistent }}
35
+ </template>
36
+ </UDropdownBadge>
37
+
38
+ <!-- `label` is `UDropdown`'s `displayLabel`, a join of `option[labelKey]` lookups. -->
39
+ <UDropdownBadge :options="options">
40
+ <template #default="{ label }">
41
+ <!-- @vue-expect-error the label is `undefined` when it cannot be resolved. -->
42
+ {{ expectString(label) }}
43
+ </template>
44
+ </UDropdownBadge>
45
+
46
+ <!-- Regression guard: an option slot must never promise the caller's members as present. -->
47
+ <UDropdownBadge
48
+ :options="groupedOptions"
49
+ group-label-key="groupName"
50
+ group-value-key="children"
51
+ label-key="label"
52
+ >
53
+ <template #option="{ option }">
54
+ <!-- @vue-expect-error a flattened group member need not carry `label`. -->
55
+ {{ expectString(option.label) }}
56
+ </template>
57
+ <template #before-option="{ option }">
58
+ <!-- @vue-expect-error a flattened group member need not carry `qty`. -->
59
+ {{ expectNumber(option.qty) }}
60
+ </template>
61
+ <template #after-option="{ option }">
62
+ <!-- @vue-expect-error a flattened group member need not carry `groupName`. -->
63
+ {{ expectString(option.groupName) }}
64
+ </template>
65
+ </UDropdownBadge>
66
+ </template>
67
+
68
+ <script setup lang="ts">
69
+ import { ref } from "vue";
70
+
71
+ import UDropdownBadge from "../UDropdownBadge.vue";
72
+
73
+ interface UserOption {
74
+ label: string;
75
+ value: string;
76
+ qty: number;
77
+ }
78
+
79
+ const options = [{ label: "a", value: "a", qty: 1 }];
80
+ const typedOptions = ref<UserOption[]>([]);
81
+
82
+ /* A group whose members lack the parent's members — exactly what `filterGroups` flattens. */
83
+ const groupedOptions = [
84
+ {
85
+ groupName: "Group A",
86
+ label: "Group A",
87
+ qty: 1,
88
+ children: [{ value: "c1", title: "Child" }],
89
+ },
90
+ ];
91
+
92
+ function expectString(value: string) {
93
+ return value;
94
+ }
95
+
96
+ function expectNumber(value: number) {
97
+ return value;
98
+ }
99
+
100
+ function expectOptionalString(value: string | undefined) {
101
+ return value;
102
+ }
103
+
104
+ function expectOptionalNumber(value: number | undefined) {
105
+ return value;
106
+ }
107
+ </script>
@@ -1,11 +1,25 @@
1
1
  import defaultConfig from "./config";
2
2
 
3
- import type { Option } from "../ui.form-listbox/types";
3
+ import type { ListboxOption, SlotOption } from "../ui.form-listbox/types";
4
4
  import type { ComponentConfig, UnknownObject } from "../types";
5
5
 
6
6
  export type Config = typeof defaultConfig;
7
7
 
8
- export interface Props {
8
+ /* Option slots are forwarded through `UDropdown` to `UListbox`, inheriting its group flattening —
9
+ a flattened member need not carry the parent's members, so `SlotOption` is `Partial`. */
10
+ export interface UDropdownBadgeSlots<TOption extends ListboxOption = ListboxOption> {
11
+ /* `label` is `UDropdown`'s `displayLabel`, a join of `option[labelKey]` lookups — `undefined`
12
+ when the label cannot be resolved. */
13
+ default?: (props: { label: string | undefined; opened: boolean }) => unknown;
14
+ left?: (props: { opened: boolean }) => unknown;
15
+ toggle?: (props: { opened: boolean }) => unknown;
16
+ "before-option"?: (props: { option: SlotOption<TOption>; index: number }) => unknown;
17
+ option?: (props: { option: SlotOption<TOption>; index: number }) => unknown;
18
+ "after-option"?: (props: { option: SlotOption<TOption>; index: number }) => unknown;
19
+ empty?: () => unknown;
20
+ }
21
+
22
+ export interface Props<TOption extends ListboxOption = ListboxOption> {
9
23
  /**
10
24
  * Selected badge.
11
25
  */
@@ -24,7 +38,7 @@ export interface Props {
24
38
  /**
25
39
  * Options list.
26
40
  */
27
- options?: Option[];
41
+ options?: TOption[];
28
42
 
29
43
  /**
30
44
  * Label key in the item object of options.
@@ -1,4 +1,4 @@
1
- <script setup lang="ts">
1
+ <script setup lang="ts" generic="TOption extends ListboxOption">
2
2
  import { computed, useTemplateRef } from "vue";
3
3
 
4
4
  import { useUI } from "../composables/useUI";
@@ -11,11 +11,13 @@ import UDropdown from "../ui.dropdown/UDropdown.vue";
11
11
  import defaultConfig from "./config";
12
12
  import { COMPONENT_NAME } from "./constants";
13
13
 
14
- import type { Props, Config } from "./types";
14
+ import type { Props, Config, UDropdownButtonSlots } from "./types";
15
+ import type { ListboxOption } from "../ui.form-listbox/types";
16
+ import type { ComponentExposed } from "../types";
15
17
 
16
18
  defineOptions({ inheritAttrs: false });
17
19
 
18
- const props = withDefaults(defineProps<Props>(), {
20
+ const props = withDefaults(defineProps<Props<TOption>>(), {
19
21
  ...getDefaults<Props, Config>(defaultConfig, COMPONENT_NAME),
20
22
  options: () => [],
21
23
  modelValue: "",
@@ -59,7 +61,10 @@ const emit = defineEmits([
59
61
  "update:search",
60
62
  ]);
61
63
 
62
- type UDropdownRef = InstanceType<typeof UDropdown>;
64
+ defineSlots<UDropdownButtonSlots<TOption>>();
65
+
66
+ /* `UDropdown` is generic, so its type is a function — `InstanceType` does not apply. */
67
+ type UDropdownRef = ComponentExposed<typeof UDropdown>;
63
68
 
64
69
  const dropdownRef = useTemplateRef<UDropdownRef>("dropdown");
65
70
 
@@ -6,7 +6,7 @@ import {
6
6
  getDocsDescription,
7
7
  } from "../../utils/storybook";
8
8
 
9
- import UDropdownButton from "../../ui.dropdown-button/UDropdownButton.vue";
9
+ import UDropdownButtonComponent from "../../ui.dropdown-button/UDropdownButton.vue";
10
10
  import URow from "../../ui.container-row/URow.vue";
11
11
  import UCol from "../../ui.container-col/UCol.vue";
12
12
  import UIcon from "../../ui.image-icon/UIcon.vue";
@@ -24,6 +24,11 @@ import emilyDavis from "../../ui.form-select/storybook/assets/images/emily-davis
24
24
  import alexJohnson from "../../ui.form-select/storybook/assets/images/alex-johnson.png";
25
25
  import patMorgan from "../../ui.form-select/storybook/assets/images/pat-morgan.png";
26
26
 
27
+ /* Generic SFCs are typed as a function, which drops the compiler-generated `__name`. */
28
+ const UDropdownButton = UDropdownButtonComponent as typeof UDropdownButtonComponent & {
29
+ __name: string;
30
+ };
31
+
27
32
  interface DefaultUDropdownButtonArgs extends Props {
28
33
  slotTemplate?: string;
29
34
  }
@@ -0,0 +1,57 @@
1
+ import { describe, it, expectTypeOf } from "vitest";
2
+
3
+ import type { Props, UDropdownButtonSlots } from "../types";
4
+ import type { ListboxOption, SlotOption } from "../../ui.form-listbox/types";
5
+
6
+ interface UserOption {
7
+ label: string;
8
+ value: string;
9
+ qty: number;
10
+ }
11
+
12
+ type OptionProps = Parameters<NonNullable<UDropdownButtonSlots<UserOption>["option"]>>[0];
13
+
14
+ describe("UDropdownButton types", () => {
15
+ it("infers the caller's option shape in a forwarded option slot", () => {
16
+ expectTypeOf<OptionProps["option"]["label"]>().toEqualTypeOf<string | undefined>();
17
+ expectTypeOf<OptionProps["option"]["qty"]>().toEqualTypeOf<number | undefined>();
18
+ expectTypeOf<OptionProps["index"]>().toEqualTypeOf<number>();
19
+ });
20
+
21
+ it("does not expose undeclared option properties to a slot", () => {
22
+ type HasIndexSignature = string extends keyof OptionProps["option"] ? true : false;
23
+
24
+ expectTypeOf<HasIndexSignature>().toEqualTypeOf<false>();
25
+ });
26
+
27
+ it("reuses UListbox's SlotOption rather than a second dialect", () => {
28
+ expectTypeOf<OptionProps["option"]>().toEqualTypeOf<SlotOption<UserOption>>();
29
+ });
30
+
31
+ it("does not promise the caller's members on any option slot", () => {
32
+ /* Forwarded through `UDropdown` to `UListbox`, whose `filterGroups` concats nested group
33
+ * members into the flat list — a member need not carry the parent's members. */
34
+ type BeforeProps = Parameters<
35
+ NonNullable<UDropdownButtonSlots<UserOption>["before-option"]>
36
+ >[0];
37
+ type AfterProps = Parameters<NonNullable<UDropdownButtonSlots<UserOption>["after-option"]>>[0];
38
+
39
+ type GroupMember = { value: string; title: string };
40
+
41
+ expectTypeOf<GroupMember>().toExtend<BeforeProps["option"]>();
42
+ expectTypeOf<GroupMember>().toExtend<OptionProps["option"]>();
43
+ expectTypeOf<GroupMember>().toExtend<AfterProps["option"]>();
44
+ });
45
+
46
+ it("types the default slot label as possibly undefined", () => {
47
+ /* It is `UDropdown`'s `displayLabel`, a join of `option[labelKey]` lookups. */
48
+ type DefaultProps = Parameters<NonNullable<UDropdownButtonSlots<UserOption>["default"]>>[0];
49
+
50
+ expectTypeOf<DefaultProps["label"]>().toEqualTypeOf<string | undefined>();
51
+ });
52
+
53
+ it("resolves Props with no type argument", () => {
54
+ expectTypeOf<Props>().toEqualTypeOf<Props<ListboxOption>>();
55
+ expectTypeOf<Props<UserOption>["options"]>().toEqualTypeOf<UserOption[] | undefined>();
56
+ });
57
+ });
@@ -4,10 +4,17 @@ import { describe, it, expect } from "vitest";
4
4
  import UDropdownButton from "../UDropdownButton.vue";
5
5
  import UButton from "../../ui.button/UButton.vue";
6
6
  import UIcon from "../../ui.image-icon/UIcon.vue";
7
- import UListbox from "../../ui.form-listbox/UListbox.vue";
7
+ import UListboxComponent from "../../ui.form-listbox/UListbox.vue";
8
8
 
9
9
  import type { Props } from "../types";
10
10
 
11
+ import type { ComponentProps } from "../../types";
12
+
13
+ /* Generic SFCs are typed as a function, which `findComponent` does not accept. */
14
+ const UListbox = UListboxComponent as unknown as new () => {
15
+ $props: ComponentProps<typeof UListboxComponent>;
16
+ };
17
+
11
18
  describe("UDropdownButton.vue", () => {
12
19
  const defaultOptions = [
13
20
  { value: 1, label: "Option 1" },