Skip to content

Commit d8dd819

Browse files
committed
chore: update storybook and readme documentation
1 parent a577ffe commit d8dd819

File tree

4 files changed

+28
-15
lines changed

4 files changed

+28
-15
lines changed

docs/migration.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,8 @@ consider additional positioning prop support on a case-by-case basis.
110110

111111
#### @zendeskgarden/react-tabs
112112

113-
- All sub-component exports have been deprecated. Use them as properties on `Tabs` instead.
113+
- All sub-component exports have been deprecated and will be removed in a future major version.
114+
Update to sub-component properties (e.g., `Tabs.TabList`).
114115

115116
#### @zendeskgarden/react-theming
116117

@@ -128,7 +129,8 @@ consider additional positioning prop support on a case-by-case basis.
128129
- `Tooltip`
129130
- removed `eventsEnabled` prop (no longer exposed by Floating UI)
130131
- removed `popperModifiers` prop (see [note](#breaking-changes))
131-
- All sub-component exports have been deprecated. Use them as properties on `Tooltip` instead.
132+
- All sub-component exports have been deprecated and will be removed in a future major version.
133+
Update to sub-component properties (e.g., `Tooltip.Title`).
132134

133135
#### @zendeskgarden/react-utilities
134136

packages/tabs/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ npm install react react-dom styled-components @zendeskgarden/react-theming
1717
```jsx
1818
import React, { useState } from 'react';
1919
import { ThemeProvider } from '@zendeskgarden/react-theming';
20-
import { Tabs, TabList, Tab, TabPanel } from '@zendeskgarden/react-tabs';
20+
import { Tabs } from '@zendeskgarden/react-tabs';
2121

2222
const Example = () => {
2323
const [selectedTab, setSelectedTab] = useState('tab-1');
@@ -28,15 +28,15 @@ const Example = () => {
2828
return (
2929
<ThemeProvider>
3030
<Tabs selectedItem={selectedTab} onChange={setSelectedTab}>
31-
<TabList>
32-
<Tab item="tab-1">Tab 1</Tab>
33-
<Tab item="tab-2">Tab 2</Tab>
34-
<Tab disabled>Disabled Tab</Tab>
35-
<Tab item="tab-3">Tab 3</Tab>
36-
</TabList>
37-
<TabPanel item="tab-1">Tab 1 content</TabPanel>
38-
<TabPanel item="tab-2">Tab 2 content</TabPanel>
39-
<TabPanel item="tab-3">Tab 3 content</TabPanel>
31+
<Tabs.TabList>
32+
<Tabs.Tab item="tab-1">Tab 1</Tabs.Tab>
33+
<Tabs.Tab item="tab-2">Tab 2</Tabs.Tab>
34+
<Tabs.Tab disabled>Disabled Tab</Tabs.Tab>
35+
<Tabs.Tab item="tab-3">Tab 3</Tabs.Tab>
36+
</Tabs.TabList>
37+
<Tabs.TabPanel item="tab-1">Tab 1 content</Tabs.TabPanel>
38+
<Tabs.TabPanel item="tab-2">Tab 2 content</Tabs.TabPanel>
39+
<Tabs.TabPanel item="tab-3">Tab 3 content</Tabs.TabPanel>
4040
</Tabs>
4141
</ThemeProvider>
4242
);

packages/tabs/demo/tabs.stories.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
import { Meta, ArgsTable, Canvas, Story, Markdown } from '@storybook/addon-docs';
22
import { useArgs } from '@storybook/client-api';
3-
import { Tabs, Tab, TabList, TabPanel } from '@zendeskgarden/react-tabs';
3+
import { Tabs } from '@zendeskgarden/react-tabs';
44
import { TabsStory } from './stories/TabsStory';
55
import { TABS } from './stories/data';
66
import README from '../README.md';
77

88
<Meta
99
title="Packages/Tabs/Tabs"
1010
component={Tabs}
11-
subcomponents={{ Tab, TabList, TabPanel }}
11+
subcomponents={{
12+
'Tabs.Tab': Tabs.Tab,
13+
'Tabs.TabList': Tabs.TabList,
14+
'Tabs.TabPanel': Tabs.TabPanel
15+
}}
1216
args={{ tabs: TABS }}
1317
argTypes={{ tabs: { table: { category: 'Story' } } }}
1418
parameters={{

packages/tooltips/demo/tooltip.stories.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,14 @@ import { TooltipStory } from './stories/TooltipStory';
44
import { TOOLTIP_CONTENT as CONTENT } from './stories/data';
55
import README from '../README.md';
66

7-
<Meta title="Packages/Tooltips/Tooltip" component={Tooltip} subcomponents={{ Paragraph, Title }} />
7+
<Meta
8+
title="Packages/Tooltips/Tooltip"
9+
component={Tooltip}
10+
subcomponents={{
11+
'Tooltip.Paragraph': Tooltip.Paragraph,
12+
'Tooltip.Title': Tooltip.Title
13+
}}
14+
/>
815

916
# API
1017

0 commit comments

Comments
 (0)