Add name to useControllableReducer params

mui · Oct 12, 2023 · 0a8a9d2 · 0a8a9d2
1 parent f1ed0d3
commit 0a8a9d2
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 1 deletion.
diff --git a/packages/mui-base/src/useDropdown/useDropdown.ts b/packages/mui-base/src/useDropdown/useDropdown.ts
@@ -43,6 +43,7 @@ export function useDropdown(parameters: UseDropdownParameters = {}) {
     initialState: defaultOpen ? { open: true } : { open: false },
     onStateChange: handleStateChange,
     reducer: dropdownReducer,
+    name: 'useDropdown',
   });
 
   React.useEffect(() => {

diff --git a/packages/mui-base/src/useList/useList.ts b/packages/mui-base/src/useList/useList.ts
@@ -91,6 +91,7 @@ function useList<
     reducerActionContext = EMPTY_OBJECT as CustomActionContext,
     selectionMode = 'single',
     stateReducer: externalReducer,
+    name = 'useList',
   } = params;
 
   if (process.env.NODE_ENV !== 'production') {
@@ -222,6 +223,7 @@ function useList<
     controlledProps,
     stateComparers,
     onStateChange: handleStateChange,
+    name,
   });
 
   const { highlightedValue, selectedValues } = state;

diff --git a/packages/mui-base/src/useList/useList.types.ts b/packages/mui-base/src/useList/useList.types.ts
@@ -215,6 +215,10 @@ export interface UseListParameters<
       ListActionContext<ItemValue> & CustomActionContext
     >,
   ) => State;
+  /**
+   * The name of the hook or component
+   */
+  name?: string;
 }
 
 export interface ListItemState {

diff --git a/packages/mui-base/src/utils/useControllableReducer.test.tsx b/packages/mui-base/src/utils/useControllableReducer.test.tsx
@@ -49,6 +49,7 @@ describe('useControllableReducer', () => {
         reducer,
         controlledProps: {},
         initialState: { make: 'Mazda', model: '3', productionYear: 2022 },
+        name: 'TestReducer',
       };
 
       function TestComponent() {
@@ -73,6 +74,7 @@ describe('useControllableReducer', () => {
         reducer: (state) => state,
         controlledProps: {},
         initialState: { make: 'Mazda', model: '3', productionYear: 2022 },
+        name: 'TestReducer',
       };
 
       function TestComponent() {
@@ -109,6 +111,7 @@ describe('useControllableReducer', () => {
       const reducerParameters: ControllableReducerParameters<TestState, SetMakeAction> = {
         reducer,
         initialState: { make: 'Mazda', model: '3', productionYear: 2022 },
+        name: 'TestReducer',
       };
 
       function TestComponent(props: { make: string }) {
@@ -136,6 +139,7 @@ describe('useControllableReducer', () => {
       const reducerParameters: ControllableReducerParameters<TestState, SetMakeAction> = {
         reducer: (state) => state,
         initialState: { make: 'Mazda', model: '3', productionYear: 2022 },
+        name: 'TestReducer',
       };
 
       function TestComponent(props: { make: string }) {
@@ -166,6 +170,7 @@ describe('useControllableReducer', () => {
       const reducerParameters: ControllableReducerParameters<TestState, SetMakeAction> = {
         reducer: (state) => state,
         initialState: { make: 'Mazda', model: '3', productionYear: 2022 },
+        name: 'TestReducer',
       };
 
       function TestComponent(props: { make?: string }) {
@@ -227,6 +232,7 @@ describe('useControllableReducer', () => {
             a.every((v, i) => v === b[i]),
         },
         onStateChange: onStateChangeSpy,
+        name: 'TestReducer',
       };
 
       function TestComponent() {
@@ -267,6 +273,7 @@ describe('useControllableReducer', () => {
         controlledProps: {},
         initialState: { make: 'Mazda', model: '3', productionYear: 2022 },
         onStateChange: handleChange,
+        name: 'TestReducer',
       };
 
       function TestComponent() {
@@ -318,6 +325,7 @@ describe('useControllableReducer', () => {
         controlledProps: {},
         initialState: { make: 'Mazda', model: '3', productionYear: 2022 },
         actionContext: { overrideProductionYear: 2016 },
+        name: 'TestReducer',
       };
 
       function TestComponent() {

diff --git a/packages/mui-base/src/utils/useControllableReducer.types.ts b/packages/mui-base/src/utils/useControllableReducer.types.ts
@@ -52,9 +52,13 @@ export interface ControllableReducerParameters<
    */
   onStateChange?: StateChangeCallback<State>;
   /**
-   * Additional properties that will be added to the action.
+   * The name of the hook or component
    */
   actionContext?: ActionContext;
+  /**
+   * Additional properties that will be added to the action.
+   */
+  name: string;
 }
 
 /*