Export the hook types from components root's index

mui · Feb 8, 2023 · 68759c9 · 68759c9
1 parent de15ccc
commit 68759c9
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 4 deletions.
diff --git a/docs/pages/base/api/use-tab-panel.json b/docs/pages/base/api/use-tab-panel.json
@@ -1,6 +1,30 @@
 {
-  "parameters": {},
-  "returnValue": {},
+  "parameters": {
+    "value": {
+      "type": {
+        "name": "number | string",
+        "description": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected."
+      },
+      "required": true
+    }
+  },
+  "returnValue": {
+    "getRootProps": {
+      "type": {
+        "name": "() => {\n  'aria-labelledby': string | undefined\n  hidden: boolean\n  id: string | undefined\n}",
+        "description": "Resolver for the root slot's props."
+      },
+      "required": true
+    },
+    "hidden": {
+      "type": {
+        "name": "boolean",
+        "description": "If `true`, it indicates that the tab panel will be hidden."
+      },
+      "default": "false",
+      "required": true
+    }
+  },
   "name": "useTabPanel",
   "filename": "/packages/mui-base/src/TabPanelUnstyled/useTabPanel.ts",
   "demos": "<ul><li><a href=\"/base/react-tabs/#hooks\">Unstyled Tabs</a></li></ul>"

diff --git a/docs/translations/api-docs/use-tab-panel/use-tab-panel.json b/docs/translations/api-docs/use-tab-panel/use-tab-panel.json
@@ -1 +1,10 @@
-{ "hookDescription": "", "parametersDescriptions": {}, "returnValueDescriptions": {} }
+{
+  "hookDescription": "",
+  "parametersDescriptions": {
+    "value": "The value of the TabPanel. It will be shown when the Tab with the corresponding value is selected."
+  },
+  "returnValueDescriptions": {
+    "getRootProps": "Resolver for the root slot's props.",
+    "hidden": "If <code>true</code>, it indicates that the tab panel will be hidden."
+  }
+}
diff --git a/packages/mui-base/src/TabPanelUnstyled/index.ts b/packages/mui-base/src/TabPanelUnstyled/index.ts
@@ -5,3 +5,4 @@ export { default as tabPanelUnstyledClasses } from './tabPanelUnstyledClasses';
 export * from './tabPanelUnstyledClasses';
 
 export { default as useTabPanel } from './useTabPanel';
+export * from './useTabPanel.types';
diff --git a/packages/mui-base/src/TabPanelUnstyled/useTabPanel.ts b/packages/mui-base/src/TabPanelUnstyled/useTabPanel.ts
@@ -10,7 +10,7 @@ import { UseTabPanelParameters, UseTabPanelReturnValue } from './useTabPanel.typ
  *
  * - [useTabPanel API](https://mui.com/base/api/use-tab-panel/)
  */
-function useTabPanel(parameters: UseTabPanelParameters):UseTabPanelReturnValue {
+function useTabPanel(parameters: UseTabPanelParameters): UseTabPanelReturnValue {
   const { value } = parameters;
 
   const context = useTabContext();
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,4 @@ export { default as tabPanelUnstyledClasses } from './tabPanelUnstyledClasses';
		export * from './tabPanelUnstyledClasses';

		export { default as useTabPanel } from './useTabPanel';
		export * from './useTabPanel.types';