@sproutsocial/seeds-react-menu 0.5.0 → 0.6.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 (103) hide show
  1. package/.turbo/turbo-build.log +10 -10
  2. package/CHANGELOG.md +15 -0
  3. package/dist/esm/index.js +1486 -440
  4. package/dist/esm/index.js.map +1 -1
  5. package/dist/index.d.mts +248 -92
  6. package/dist/index.d.ts +248 -92
  7. package/dist/index.js +1500 -429
  8. package/dist/index.js.map +1 -1
  9. package/package.json +4 -1
  10. package/src/ActionMenu/ActionMenu.stories.tsx +426 -0
  11. package/src/ActionMenu/ActionMenu.tsx +24 -27
  12. package/src/ActionMenu/ActionMenuTypes.ts +8 -7
  13. package/src/ActionMenu/__tests__/ActionMenu.test.tsx +17 -8
  14. package/src/ActionMenu/__tests__/ActionMenu.typetest.tsx +8 -8
  15. package/src/Autocomplete/Autocomplete.stories.tsx +38 -3
  16. package/src/Autocomplete/Autocomplete.tsx +15 -80
  17. package/src/Autocomplete/AutocompleteInput.tsx +18 -27
  18. package/src/Autocomplete/AutocompleteTokenInput.tsx +50 -0
  19. package/src/Autocomplete/AutocompleteTypes.ts +25 -12
  20. package/src/Autocomplete/MultiAutocomplete.tsx +189 -0
  21. package/src/Autocomplete/SingleAutocomplete.tsx +74 -0
  22. package/src/Autocomplete/__tests__/Autocomplete.test.tsx +171 -3
  23. package/src/Autocomplete/__tests__/Autocomplete.typetest.tsx +90 -8
  24. package/src/MenuContent/MenuContent.stories.tsx +164 -0
  25. package/src/MenuContent/MenuContent.tsx +26 -12
  26. package/src/MenuContent/MenuContentTypes.ts +6 -4
  27. package/src/MenuContent/__tests__/MenuContent.typetest.tsx +8 -8
  28. package/src/MenuContext.tsx +191 -37
  29. package/src/MenuFooter/MenuFooter.stories.tsx +202 -0
  30. package/src/MenuFooter/__tests__/MenuFooter.test.tsx +16 -11
  31. package/src/MenuGroup/MenuGroup.feature +16 -16
  32. package/src/MenuGroup/MenuGroup.stories.tsx +248 -0
  33. package/src/MenuGroup/MenuGroup.tsx +8 -7
  34. package/src/MenuGroup/MenuGroupTypes.ts +6 -2
  35. package/src/MenuGroup/__tests__/MenuGroup.test.tsx +6 -6
  36. package/src/MenuGroup/__tests__/MenuGroup.typetest.tsx +7 -7
  37. package/src/MenuGroup/styles.tsx +4 -2
  38. package/src/MenuHeader/MenuHeader.stories.tsx +276 -0
  39. package/src/MenuHeader/MenuHeader.tsx +3 -1
  40. package/src/MenuHeader/__tests__/MenuHeader.test.tsx +23 -13
  41. package/src/MenuHeader/styles.tsx +18 -14
  42. package/src/MenuItem/MenuItem.stories.tsx +507 -0
  43. package/src/MenuItem/MenuItem.tsx +18 -8
  44. package/src/MenuItem/MenuItemTypes.ts +9 -4
  45. package/src/MenuItem/__tests__/MenuItem.test.tsx +6 -6
  46. package/src/MenuItem/styles.tsx +21 -5
  47. package/src/MenuItem/useOptionProps.tsx +10 -8
  48. package/src/MenuLabel.tsx +2 -2
  49. package/src/MenuRoot/MenuRoot.tsx +37 -23
  50. package/src/MenuRoot/__tests__/MenuRoot.test.tsx +59 -32
  51. package/src/MenuSearchInput/MenuSearchInput.tsx +63 -0
  52. package/src/MenuSearchInput/__tests__/MenuSearchInput.test.tsx +157 -0
  53. package/src/MenuSearchInput/__tests__/MenuSearchInput.typetest.tsx +31 -0
  54. package/src/MenuSearchInput/index.ts +1 -0
  55. package/src/MenuSearchTokenInput/MenuSearchTokenInput.tsx +98 -0
  56. package/src/MenuSearchTokenInput/__tests__/MenuSearchTokenInput.test.tsx +247 -0
  57. package/src/MenuSearchTokenInput/__tests__/MenuSearchTokenInput.typetest.tsx +33 -0
  58. package/src/MenuSearchTokenInput/index.ts +1 -0
  59. package/src/MenuToggleButton/MenuToggleButton.stories.tsx +72 -0
  60. package/src/{MenuToggleButton.tsx → MenuToggleButton/MenuToggleButton.tsx} +6 -5
  61. package/src/MenuToggleButton/index.ts +1 -0
  62. package/src/MenuTokenInput.tsx +104 -0
  63. package/src/MultiSelectMenu/MultiSelectMenu.stories.tsx +214 -0
  64. package/src/MultiSelectMenu/MultiSelectMenu.tsx +38 -68
  65. package/src/MultiSelectMenu/MultiSelectMenuTypes.ts +8 -6
  66. package/src/MultiSelectMenu/__tests__/MultiSelectMenu.test.tsx +46 -17
  67. package/src/MultiSelectMenu/__tests__/MultiSelectMenu.typetest.tsx +6 -6
  68. package/src/NestedMenu/NestedMenu.feature +109 -0
  69. package/src/NestedMenu/NestedMenu.stories.tsx +157 -0
  70. package/src/NestedMenu/NestedMenu.tsx +102 -0
  71. package/src/NestedMenu/NestedMenuContent.tsx +71 -0
  72. package/src/NestedMenu/NestedMenuContext.tsx +56 -0
  73. package/src/NestedMenu/NestedMenuHeader.tsx +25 -0
  74. package/src/NestedMenu/NestedMenuItem.tsx +37 -0
  75. package/src/NestedMenu/NestedMenuTypes.ts +47 -0
  76. package/src/NestedMenu/__tests__/NestedMenu.test.tsx +31 -0
  77. package/src/NestedMenu/__tests__/NestedMenu.typetest.tsx +134 -0
  78. package/src/NestedMenu/index.ts +5 -0
  79. package/src/SingleSelectMenu/SingleSelectMenu.stories.tsx +227 -0
  80. package/src/SingleSelectMenu/SingleSelectMenu.tsx +23 -26
  81. package/src/SingleSelectMenu/SingleSelectMenuTypes.ts +7 -5
  82. package/src/SingleSelectMenu/__tests__/SingleSelectMenu.typetest.tsx +6 -6
  83. package/src/SubmenuItem/SubmenuItem.feature +82 -0
  84. package/src/SubmenuItem/SubmenuItem.stories.tsx +163 -0
  85. package/src/SubmenuItem/SubmenuItem.tsx +254 -0
  86. package/src/SubmenuItem/SubmenuItemTypes.ts +24 -0
  87. package/src/SubmenuItem/__tests__/SubmenuItem.test.tsx +3 -0
  88. package/src/SubmenuItem/__tests__/SubmenuItem.typetest.tsx +112 -0
  89. package/src/SubmenuItem/index.ts +2 -0
  90. package/src/hooks/useDownshiftDefaults.tsx +107 -0
  91. package/src/hooks/useItemFiltering.tsx +66 -0
  92. package/src/hooks/useMenuChildren.tsx +197 -128
  93. package/src/index.ts +6 -0
  94. package/src/menuTestingUtils.tsx +21 -10
  95. package/src/reducers/nestedMenuStateReducer.tsx +23 -0
  96. package/src/reducers/useComboboxStateReducer.tsx +26 -8
  97. package/src/reducers/useSelectStateReducer.tsx +24 -6
  98. package/src/storybookUtilities/menu-storybook-components.tsx +5 -3
  99. package/src/types.ts +38 -30
  100. package/src/utils/downshiftDefaults.ts +9 -0
  101. package/src/utils/getMultiSelectOverrides.ts +21 -0
  102. package/src/utils/reduceReducers.ts +19 -0
  103. package/src/utils/itemToString.ts +0 -5
package/src/types.ts CHANGED
@@ -1,41 +1,49 @@
1
- import { type TypeMenuItemProps } from "./MenuItem";
2
- import type { TypeMenuGroupProps } from "./MenuGroup";
3
- import type { TypeMenuRootProps } from "./MenuRoot/index";
1
+ import type { UseComboboxGetInputPropsOptions } from "downshift";
2
+ import type { TypeMenuItemProps } from "./MenuItem";
3
+ import type { TypeMenuGroupBaseProps } from "./MenuGroup";
4
+ import type { TypeMenuRootProps } from "./MenuRoot";
4
5
 
5
- export interface TypeDefaultItemProps {
6
+ // The items object used internally for Menu functionality
7
+ export interface TypeInternalItemProps<Item = TypeMenuItemProps> {
6
8
  id: string;
7
9
  index: number;
8
10
  disabled?: boolean;
9
- hidden?: boolean;
10
- menuItemProps?: TypeMenuItemProps;
11
- menuGroupProps?: TypeMenuGroupProps;
11
+ menuItemProps?: Item;
12
+ menuGroupProps?: TypeMenuGroupBaseProps;
12
13
  }
13
14
 
14
- /* The base type, which is narrowed to specific configurations.*/
15
- type TypeBaseChildrenOrItems = {
16
- /** Allows menu items to be passed in as children. Cannot be used with the items prop.*/
17
- children?: TypeMenuRootProps["children"];
18
- /** Allows menu items to be passed in as objects. Cannot be used with the children prop.*/
19
- items?: TypeMenuItemProps[];
20
- /** Allows a custom MenuItem component to be used when rendering using the items prop.*/
21
- MenuItemComponent?: React.ComponentType<TypeMenuItemProps>;
22
- };
23
-
24
- type TypePropsWithChildren = {
25
- children: TypeMenuRootProps["children"];
26
- items?: never;
27
- MenuItemComponent?: never;
28
- };
29
-
30
- type TypePropsWithItems = {
31
- children?: never;
32
- items: TypeMenuItemProps[];
33
- };
34
-
35
- export type TypeChildrenOrItems = TypeBaseChildrenOrItems &
36
- (TypePropsWithChildren | TypePropsWithItems);
15
+ export type TypeChildrenOrItems<
16
+ I extends TypeMenuItemProps = TypeMenuItemProps
17
+ > =
18
+ | {
19
+ /** Allows menu items to be passed in as children. Cannot be used with the items prop.*/
20
+ children: TypeMenuRootProps["children"];
21
+ menuItems?: never;
22
+ MenuItemComponent?: never;
23
+ }
24
+ | {
25
+ children?: never;
26
+ /** Allows menu items to be passed in as objects. Cannot be used with the children prop.*/
27
+ menuItems: I[];
28
+ /** Allows a custom MenuItem component to be used when rendering using the items prop.*/
29
+ MenuItemComponent?: React.ComponentType<I>;
30
+ };
37
31
 
38
32
  export type TypeNotEmptyChildren =
39
33
  | React.ReactChild
40
34
  | React.ReactFragment
41
35
  | React.ReactPortal;
36
+
37
+ type TypeInputEventListeners =
38
+ | "onKeyDown"
39
+ | "onChange"
40
+ | "onInput"
41
+ | "onBlur"
42
+ | "onClick"
43
+ | "refKey";
44
+
45
+ export type TypeDownshiftMergedInputProps<B> = Pick<
46
+ UseComboboxGetInputPropsOptions,
47
+ TypeInputEventListeners
48
+ > &
49
+ Omit<Partial<B>, TypeInputEventListeners>;
@@ -0,0 +1,9 @@
1
+ import type { TypeInternalItemProps } from "../types";
2
+
3
+ export const itemToString = (item: TypeInternalItemProps | null) => {
4
+ return item ? item.id : "";
5
+ };
6
+
7
+ export const itemToKey = (item: TypeInternalItemProps | null) => {
8
+ return item ? item.id : "";
9
+ };
@@ -0,0 +1,21 @@
1
+ import type { TypeDownshiftMultiSelectProps } from "../MenuContext";
2
+
3
+ export const getMultiSelectOverrides = ({
4
+ getA11yMultiStatusMessage,
5
+ onMultiSelectStateChange,
6
+ multiSelectStateReducer,
7
+ ...useSelectProps
8
+ }: TypeDownshiftMultiSelectProps) =>
9
+ Object.entries({
10
+ ...useSelectProps,
11
+ getA11yStatusMessage: getA11yMultiStatusMessage,
12
+ onStateChange: onMultiSelectStateChange,
13
+ stateReducer: multiSelectStateReducer,
14
+ }).reduce(
15
+ (a, [k, v]) => (v ? ((a[k] = v), a) : a),
16
+ {} as {
17
+ getA11yStatusMessage?: TypeDownshiftMultiSelectProps["getA11yMultiStatusMessage"];
18
+ onStateChange?: TypeDownshiftMultiSelectProps["onMultiSelectStateChange"];
19
+ stateReducer?: TypeDownshiftMultiSelectProps["multiSelectStateReducer"];
20
+ }
21
+ );
@@ -0,0 +1,19 @@
1
+ export type TypeReducer<S extends Object, A extends { changes: Partial<S> }> = (
2
+ state: S,
3
+ action: A
4
+ ) => Partial<S>;
5
+ export const reduceReducers =
6
+ <S extends Object, A extends { changes: Partial<S> }>(
7
+ ...reducers: (undefined | TypeReducer<S, A>)[]
8
+ ): TypeReducer<S, A> =>
9
+ (state, action) =>
10
+ reducers.reduce(
11
+ (changes, nextReducer) =>
12
+ nextReducer
13
+ ? nextReducer(state, {
14
+ ...action,
15
+ changes,
16
+ })
17
+ : changes,
18
+ action.changes as Partial<S>
19
+ );
@@ -1,5 +0,0 @@
1
- import type { TypeDefaultItemProps } from "../types";
2
-
3
- export const itemToString = (item: TypeDefaultItemProps | null) => {
4
- return item ? item.id : "";
5
- };