Skip to content

Commit ed0a187

Browse files
committed
fix: component references, @jzempel review
1 parent 8fd8135 commit ed0a187

File tree

4 files changed

+25
-13
lines changed

4 files changed

+25
-13
lines changed

docs/migration.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,20 @@ consider additional positioning prop support on a case-by-case basis.
4444
#### @zendeskgarden/react-chrome
4545

4646
- Removed `PRODUCT` type export. Use `IHeaderItemProps['product']` instead.
47-
- Some subcomponent exports have been deprecated and will be removed in a future major version.
48-
Update to subcomponent properties.
47+
- Renamed `ICollapsibleSubNavItemProps` type export to `ISubNavCollapsibleItemProps`.
48+
- Subcomponent exports have been deprecated and will be removed in a future major version. Update
49+
to subcomponent properties:
50+
- `FooterItem` -> `Footer.Item`
51+
- `HeaderItem` -> `Header.Item`
52+
- `HeaderItemIcon` -> `Header.ItemIcon`
53+
- `HeaderItemText` -> `Header.ItemText`
54+
- `HeaderItemWrapper` -> `Header.ItemWrapper`
55+
- `NavItem` -> `Nav.Item`
56+
- `NavItemIcon` -> `Nav.ItemIcon`
57+
- `NavItemText` -> `Nav.ItemText`
58+
- `CollapsibleSubNavItem` -> `SubNav.CollapsibleItem`
59+
- `SubNavItem` -> `SubNav.Item`
60+
- `SubNavItemText` -> `SubNav.ItemText`
4961

5062
#### @zendeskgarden/react-colorpickers
5163

packages/chrome/demo/chrome.stories.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ import README from '../README.md';
5252
SkipNav,
5353
SubNav,
5454
'SubNav.CollapsibleItem': SubNav.CollapsibleItem,
55-
'Sub.NavItem': Sub.NavItem,
56-
'Sub.NavItemText': Sub.NavItemText
55+
'SubNav.Item': SubNav.Item,
56+
'SubNav.ItemText': SubNav.ItemText
5757
}}
5858
/>
5959

@@ -97,17 +97,17 @@ import README from '../README.md';
9797
isExpanded: { name: 'Nav isExpanded', table: { category: 'Story' } },
9898
isWrapped: { name: 'Nav/SubNav isWrapped', table: { category: 'Story' } },
9999
hasNav: { name: 'Nav', table: { category: 'Story' } },
100-
navItems: { name: 'NavItem[]', table: { category: 'Story' } },
100+
navItems: { name: 'Nav.Item[]', table: { category: 'Story' } },
101101
hasLogo: { name: 'Nav hasLogo', table: { category: 'Story' } },
102102
hasBrandmark: { name: 'Nav hasBrandmark', table: { category: 'Story' } },
103103
hasSubNav: { name: 'SubNav', table: { category: 'Story' } },
104-
subNavItems: { name: 'SubNavItem[]', table: { category: 'Story' } },
104+
subNavItems: { name: 'SubNav.Item[]', table: { category: 'Story' } },
105105
subNavMaxWidth: { name: 'SubNav max-width', control: 'number', table: { category: 'Story' } },
106106
hasHeader: { name: 'Header', table: { category: 'Story' } },
107-
headerItems: { name: 'HeaderItem[]', table: { category: 'Story' } },
107+
headerItems: { name: 'Header.Item[]', table: { category: 'Story' } },
108108
hasSidebar: { name: 'Sidebar', table: { category: 'Story' } },
109109
hasFooter: { name: 'Footer', table: { category: 'Story' } },
110-
footerItems: { name: 'FooterItem[]', table: { category: 'Story' } },
110+
footerItems: { name: 'Footer.Item[]', table: { category: 'Story' } },
111111
product: {
112112
name: 'Nav product',
113113
control: { type: 'select', options: PRODUCTS },

packages/chrome/demo/stories/CollapsibleSubNavItemStory.tsx renamed to packages/chrome/demo/stories/SubNavCollapsibleItem.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ interface IArgs extends ICollapsibleSubNavItemProps {
1515
items: COLLAPSIBLE_SUB_NAV_ITEM[];
1616
}
1717

18-
export const CollapsibleSubNavItemStory: StoryFn<IArgs> = ({ items, ...args }) => {
18+
export const SubNavCollapsibleItem: StoryFn<IArgs> = ({ items, ...args }) => {
1919
const [current, setCurrent] = useState<number | undefined>();
2020

2121
return (

packages/chrome/demo/collapsibleSubNavItem.stories.mdx renamed to packages/chrome/demo/subNavCollapsibleItem.stories.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import { Meta, ArgsTable, Canvas, Story, Markdown } from '@storybook/addon-docs';
22
import { useArgs } from '@storybook/client-api';
33
import { CollapsibleSubNavItem } from '@zendeskgarden/react-chrome';
4-
import { CollapsibleSubNavItemStory } from './stories/CollapsibleSubNavItemStory';
4+
import { SubNavCollapsibleItem } from './stories/SubNavCollapsibleItem';
55
import { COLLAPSIBLE_SUB_NAV_ITEMS as ITEMS } from './stories/data';
66
import README from '../README.md';
77

8-
<Meta title="Packages/Chrome/CollapsibleSubNavItem" component={CollapsibleSubNavItem} />
8+
<Meta title="Packages/Chrome/SubNav.CollapsibleItem" component={CollapsibleSubNavItem} />
99

1010
# API
1111

@@ -21,7 +21,7 @@ import README from '../README.md';
2121
args={{ header: 'Header', items: ITEMS }}
2222
argTypes={{ items: { name: 'children' }, isExpanded: { control: false } }}
2323
>
24-
{({ onChange, ...args }) => <CollapsibleSubNavItemStory {...args} />}
24+
{({ onChange, ...args }) => <SubNavCollapsibleItem {...args} />}
2525
</Story>
2626
</Canvas>
2727

@@ -36,7 +36,7 @@ import README from '../README.md';
3636
{args => {
3737
const updateArgs = useArgs()[1];
3838
const handleChange = () => updateArgs({ isExpanded: !args.isExpanded });
39-
return <CollapsibleSubNavItemStory {...args} onChange={handleChange} />;
39+
return <SubNavCollapsibleItem {...args} onChange={handleChange} />;
4040
}}
4141
</Story>
4242
</Canvas>

0 commit comments

Comments
 (0)