Skip to content

Commit 80bfbb4

Browse files
authored
[docs] Fix incorrect Tabs import instructions (#401)
1 parent e18187d commit 80bfbb4

File tree

7 files changed

+19
-6
lines changed

7 files changed

+19
-6
lines changed

Diff for: docs/pages/base-ui/api/tab-indicator.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"renderBeforeHydration": { "type": { "name": "bool" }, "default": "false" }
66
},
77
"name": "TabIndicator",
8-
"imports": ["import { TabIndicator } from '@base_ui/react/Tabs';"],
8+
"imports": ["import * as Tabs from '@base_ui/react/Tabs';\nconst TabIndicator = Tabs.Indicator;"],
99
"classes": [],
1010
"spread": true,
1111
"themeDefaultProps": true,

Diff for: docs/pages/base-ui/api/tab-panel.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"value": { "type": { "name": "any" } }
77
},
88
"name": "TabPanel",
9-
"imports": ["import { TabPanel } from '@base_ui/react/Tabs';"],
9+
"imports": ["import * as Tabs from '@base_ui/react/Tabs';\nconst TabPanel = Tabs.Panel;"],
1010
"classes": [],
1111
"spread": true,
1212
"themeDefaultProps": true,

Diff for: docs/pages/base-ui/api/tab.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"value": { "type": { "name": "any" } }
66
},
77
"name": "Tab",
8-
"imports": ["import { Tab } from '@base_ui/react/Tabs';"],
8+
"imports": ["import * as Tabs from '@base_ui/react/Tabs';\nconst Tab = Tabs.Tab;"],
99
"classes": [],
1010
"spread": true,
1111
"themeDefaultProps": true,

Diff for: packages/mui-base/src/Tabs/Root/TabsRoot.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,4 +106,4 @@ TabsRoot.propTypes /* remove-proptypes */ = {
106106
value: PropTypes.any,
107107
} as any;
108108

109-
export { TabsRoot as Tabs };
109+
export { TabsRoot };

Diff for: packages/mui-base/src/Tabs/index.barrel.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
export { Tabs } from './Root/TabsRoot';
1+
export { TabsRoot } from './Root/TabsRoot';
22
export type {
33
TabsRootOwnerState,
44
TabsRootProps,

Diff for: packages/mui-base/src/Tabs/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
export { Tabs as Root } from './Root/TabsRoot';
1+
export { TabsRoot as Root } from './Root/TabsRoot';
22
export type {
33
TabsRootOwnerState as RootOwnerState,
44
TabsRootProps as RootProps,

Diff for: scripts/buildApiDocs/config/getComponentImports.ts

+13
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@ import path from 'path';
22

33
const repositoryRoot = path.resolve(__dirname, '../../..');
44

5+
// components which names do not start with directory name
6+
const componentExportExceptions: Record<string, string> = {
7+
Tab: 'Tab',
8+
TabIndicator: 'Indicator',
9+
TabPanel: 'Panel',
10+
};
11+
512
export function getComponentImports(name: string, filename: string) {
613
const relativePath = path.relative(repositoryRoot, filename);
714
const directories = path.dirname(relativePath).split(path.sep);
@@ -18,6 +25,12 @@ export function getComponentImports(name: string, filename: string) {
1825
return [`import { ${name} } from '@base_ui/react/${name}';`];
1926
}
2027

28+
if (Object.keys(componentExportExceptions).includes(name)) {
29+
return [
30+
`import * as ${componentDirectory} from '@base_ui/react/${componentDirectory}';\nconst ${name} = ${componentDirectory}.${componentExportExceptions[name]};`,
31+
];
32+
}
33+
2134
if (name.startsWith(componentDirectory) && !name.startsWith('use')) {
2235
// cases like Switch/SwitchTrack.tsx
2336
const childName = name.slice(componentDirectory.length);

0 commit comments

Comments
 (0)