use TabsContextValue interface

mui · Mar 7, 2023 · 19ac5fd · 19ac5fd
1 parent 7774d78
commit 19ac5fd
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 13 deletions.
diff --git a/docs/pages/base/api/use-tabs.json b/docs/pages/base/api/use-tabs.json
@@ -30,10 +30,7 @@
   },
   "returnValue": {
     "tabsContextValue": {
-      "type": {
-        "name": "{\n  idPrefix: string | undefined\n  value: string | number | false\n  onSelected: (e: React.SyntheticEvent, newValue: string | number | false) =&gt void\n  orientation?: &#39;horizontal&#39; | &#39;vertical&#39;\n  direction: &#39;ltr&#39; | &#39;rtl&#39; | undefined\n  selectionFollowsFocus: boolean | undefined\n}",
-        "description": "{\n  idPrefix: string | undefined\n  value: string | number | false\n  onSelected: (e: React.SyntheticEvent, newValue: string | number | false) =&gt void\n  orientation?: &#39;horizontal&#39; | &#39;vertical&#39;\n  direction: &#39;ltr&#39; | &#39;rtl&#39; | undefined\n  selectionFollowsFocus: boolean | undefined\n}"
-      },
+      "type": { "name": "TabsContextValue", "description": "TabsContextValue" },
       "required": true
     }
   },

diff --git a/docs/translations/api-docs/use-tabs/use-tabs.json b/docs/translations/api-docs/use-tabs/use-tabs.json
@@ -8,5 +8,7 @@
     "selectionFollowsFocus": "If <code>true</code> the selected tab changes on focus. Otherwise it only\nchanges on activation.",
     "value": "The value of the currently selected <code>Tab</code>.\nIf you don't want any selected <code>Tab</code>, you can set this prop to <code>false</code>."
   },
-  "returnValueDescriptions": {}
+  "returnValueDescriptions": {
+    "tabsContextValue": "Returns the values to be passed to the tabs context provider."
+  }
 }
diff --git a/packages/mui-base/src/useTabs/useTabs.types.ts b/packages/mui-base/src/useTabs/useTabs.types.ts
@@ -1,3 +1,5 @@
+import type { TabsContextValue } from '../TabsUnstyled';
+
 export interface UseTabsParameters {
   /**
    * The value of the currently selected `Tab`.
@@ -30,12 +32,8 @@ export interface UseTabsParameters {
 }
 
 export interface UseTabsReturnValue {
-  tabsContextValue: {
-    idPrefix: string | undefined;
-    value: string | number | false;
-    onSelected: (e: React.SyntheticEvent, newValue: string | number | false) => void;
-    orientation?: 'horizontal' | 'vertical';
-    direction: 'ltr' | 'rtl' | undefined;
-    selectionFollowsFocus: boolean | undefined;
-  };
+  /**
+   * Returns the values to be passed to the tabs context provider.
+   */
+  tabsContextValue: TabsContextValue;
 }