Skip to content

feat(chrome): adds sub-component mapping #1736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 7, 2024
Merged

feat(chrome): adds sub-component mapping #1736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e39f90
feat(chrome): adds sub-component mapping
geotrev Mar 4, 2024
8fd8135
chore: adds storybook and readme updates
geotrev Mar 5, 2024
ed0a187
fix: component references, @jzempel review
geotrev Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,20 @@ consider additional positioning prop support on a case-by-case basis.
#### @zendeskgarden/react-chrome

- Removed `PRODUCT` type export. Use `IHeaderItemProps['product']` instead.
- Renamed `ICollapsibleSubNavItemProps` type export to `ISubNavCollapsibleItemProps`.
- Subcomponent exports have been deprecated and will be removed in a future major version. Update
to subcomponent properties:
- `FooterItem` -> `Footer.Item`
- `HeaderItem` -> `Header.Item`
- `HeaderItemIcon` -> `Header.ItemIcon`
- `HeaderItemText` -> `Header.ItemText`
- `HeaderItemWrapper` -> `Header.ItemWrapper`
- `NavItem` -> `Nav.Item`
- `NavItemIcon` -> `Nav.ItemIcon`
- `NavItemText` -> `Nav.ItemText`
- `CollapsibleSubNavItem` -> `SubNav.CollapsibleItem`
- `SubNavItem` -> `SubNav.Item`
- `SubNavItemText` -> `SubNav.ItemText`

#### @zendeskgarden/react-colorpickers

Expand Down
34 changes: 15 additions & 19 deletions packages/chrome/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,41 +15,37 @@ npm install react react-dom styled-components @zendeskgarden/react-theming

```jsx
import { ThemeProvider } from '@zendeskgarden/react-theming';
import { Chrome, Nav, NavItem, ... } from '@zendeskgarden/react-chrome';
import { Chrome, Nav, SubNav, Body, Header, Content, Main } from '@zendeskgarden/react-chrome';
import ConnectIcon from '@zendeskgarden/icons/src/26/relationshape-connect.svg';

<ThemeProvider>
<Chrome>
<Nav isExpanded>
<NavItem hasLogo product="connect" title="Zendesk Connect">
<NavItemIcon>
<Nav.Item hasLogo product="connect" title="Zendesk Connect">
<Nav.ItemIcon>
<ConnectIcon />
</NavItemIcon>
</Nav.ItemIcon>
<NavItemText>Zendesk Connect</NavItemText>
</NavItem>
<NavItem isCurrent>
<NavItemIcon>
</Nav.Item>
<Nav.Item isCurrent>
<Nav.ItemIcon>
<HomeIcon />
</NavItemIcon>
</Nav.ItemIcon>
<NavItemText>Home</NavItemText>
</NavItem>
</Nav.Item>
</Nav>
<SubNav>
<SubNavItem isCurrent>
<SubNavItemText>Subnav 1</SubNavItemText>
</SubNavItem>
<SubNav.Item isCurrent>
<SubNav.ItemText>Subnav 1</SubNav.ItemText>
</SubNav.Item>
...
</SubNav>
<Body>
<Header>
...
</Header>
<Header>...</Header>
<Content>
<Main>
Lorem ipsum...
</Main>
<Main>Lorem ipsum...</Main>
</Content>
</Body>
</Chrome>
</ThemeProvider>
</ThemeProvider>;
```
43 changes: 16 additions & 27 deletions packages/chrome/demo/chrome.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,17 @@
import { Meta, ArgsTable, Canvas, Story, Markdown } from '@storybook/addon-docs';
import { useArgs } from '@storybook/client-api';
import {
Chrome,
CollapsibleSubNavItem,
Body,
Chrome,
Content,
Footer,
FooterItem,
Header,
HeaderItem,
HeaderItemIcon,
HeaderItemText,
HeaderItemWrapper,
Main,
Nav,
NavItem,
NavItemIcon,
NavItemText,
Sheet,
Sidebar,
SkipNav,
SubNav,
SubNavItem,
SubNavItemText,
PRODUCTS
} from '@zendeskgarden/react-chrome';
import { ChromeStory } from './stories/ChromeStory';
Expand All @@ -44,27 +33,27 @@ import README from '../README.md';
title="Packages/Chrome/Chrome"
component={Chrome}
subcomponents={{
CollapsibleSubNavItem,
Body,
Content,
Footer,
FooterItem,
'Footer.Item': Footer.Item,
Header,
HeaderItem,
HeaderItemIcon,
HeaderItemText,
HeaderItemWrapper,
'Item.HeaderItem': Header.Item,
'Item.HeaderItemIcon': Header.ItemIcon,
'Item.HeaderItemText': Header.ItemText,
'Item.HeaderItemWrapper': Header.ItemWrapper,
Main,
Nav,
NavItem,
NavItemIcon,
NavItemText,
'Nav.Item': Nav.Item,
'Nav.ItemIcon': Nav.ItemIcon,
'Nav.ItemText': Nav.ItemText,
Sheet,
Sidebar,
SkipNav,
SubNav,
SubNavItem,
SubNavItemText
'SubNav.CollapsibleItem': SubNav.CollapsibleItem,
'SubNav.Item': SubNav.Item,
'SubNav.ItemText': SubNav.ItemText
}}
/>

Expand Down Expand Up @@ -108,17 +97,17 @@ import README from '../README.md';
isExpanded: { name: 'Nav isExpanded', table: { category: 'Story' } },
isWrapped: { name: 'Nav/SubNav isWrapped', table: { category: 'Story' } },
hasNav: { name: 'Nav', table: { category: 'Story' } },
navItems: { name: 'NavItem[]', table: { category: 'Story' } },
navItems: { name: 'Nav.Item[]', table: { category: 'Story' } },
hasLogo: { name: 'Nav hasLogo', table: { category: 'Story' } },
hasBrandmark: { name: 'Nav hasBrandmark', table: { category: 'Story' } },
hasSubNav: { name: 'SubNav', table: { category: 'Story' } },
subNavItems: { name: 'SubNavItem[]', table: { category: 'Story' } },
subNavItems: { name: 'SubNav.Item[]', table: { category: 'Story' } },
subNavMaxWidth: { name: 'SubNav max-width', control: 'number', table: { category: 'Story' } },
hasHeader: { name: 'Header', table: { category: 'Story' } },
headerItems: { name: 'HeaderItem[]', table: { category: 'Story' } },
headerItems: { name: 'Header.Item[]', table: { category: 'Story' } },
hasSidebar: { name: 'Sidebar', table: { category: 'Story' } },
hasFooter: { name: 'Footer', table: { category: 'Story' } },
footerItems: { name: 'FooterItem[]', table: { category: 'Story' } },
footerItems: { name: 'Footer.Item[]', table: { category: 'Story' } },
product: {
name: 'Nav product',
control: { type: 'select', options: PRODUCTS },
Expand Down
89 changes: 39 additions & 50 deletions packages/chrome/demo/stories/ChromeStory.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,16 @@ import { DEFAULT_THEME } from '@zendeskgarden/react-theming';
import {
Body,
Chrome,
CollapsibleSubNavItem,
Content,
Footer,
FooterItem,
Header,
HeaderItem,
HeaderItemIcon,
HeaderItemText,
HeaderItemWrapper,
IChromeProps,
INavItemProps,
Main,
Nav,
NavItem,
NavItemIcon,
NavItemText,
Sidebar,
SkipNav,
SubNav,
SubNavItem,
SubNavItemText
SubNav
} from '@zendeskgarden/react-chrome';
import { Button } from '@zendeskgarden/react-buttons';
import { IFooterItem, IHeaderItem, INavItem, ISubNavItem } from './types';
Expand Down Expand Up @@ -150,13 +139,13 @@ export const ChromeStory: Story<IArgs> = ({
{hasNav && (
<Nav isExpanded={isExpanded} aria-label="Nav">
{hasLogo && (
<NavItem hasLogo product={product}>
<NavItemIcon>{product ? PRODUCT_ICONS[product] : <ProductIcon />}</NavItemIcon>
<NavItemText>Nav Logo</NavItemText>
</NavItem>
<Nav.Item hasLogo product={product}>
<Nav.ItemIcon>{product ? PRODUCT_ICONS[product] : <ProductIcon />}</Nav.ItemIcon>
<Nav.ItemText>Nav Logo</Nav.ItemText>
</Nav.Item>
)}
{navItems.map((item, index) => (
<NavItem
<Nav.Item
key={index}
isCurrent={currentNav === index}
onClick={() => {
Expand All @@ -165,43 +154,43 @@ export const ChromeStory: Story<IArgs> = ({
onNavClick({ hasSubNav: item.hasSubNav, hasSidebar: item.hasSidebar });
}}
>
<NavItemIcon>{NAV_ICONS[index] || <NavIcon />}</NavItemIcon>
<NavItemText isWrapped={isWrapped}>{item.text}</NavItemText>
</NavItem>
<Nav.ItemIcon>{NAV_ICONS[index] || <NavIcon />}</Nav.ItemIcon>
<Nav.ItemText isWrapped={isWrapped}>{item.text}</Nav.ItemText>
</Nav.Item>
))}
{hasBrandmark && (
<NavItem hasBrandmark>
<NavItemIcon>
<Nav.Item hasBrandmark>
<Nav.ItemIcon>
<BrandmarkIcon />
</NavItemIcon>
<NavItemText>Brandmark</NavItemText>
</NavItem>
</Nav.ItemIcon>
<Nav.ItemText>Brandmark</Nav.ItemText>
</Nav.Item>
)}
</Nav>
)}
{hasSubNav && (
<SubNav style={{ maxWidth: subNavMaxWidth }}>
{subNavItems.map((item, index) =>
item.items ? (
<CollapsibleSubNavItem key={index} header={item.text}>
<SubNav.CollapsibleItem key={index} header={item.text}>
{item.items.map((subItem, subIndex) => (
<SubNavItem
<SubNav.Item
key={subIndex}
isCurrent={currentSubNav === parseFloat(`${index}.${subIndex}`)}
onClick={() => setCurrentSubNav(parseFloat(`${index}.${subIndex}`))}
>
<SubNavItemText isWrapped={isWrapped}>{subItem}</SubNavItemText>
</SubNavItem>
<SubNav.ItemText isWrapped={isWrapped}>{subItem}</SubNav.ItemText>
</SubNav.Item>
))}
</CollapsibleSubNavItem>
</SubNav.CollapsibleItem>
) : (
<SubNavItem
<SubNav.Item
key={index}
isCurrent={currentSubNav === index}
onClick={() => setCurrentSubNav(index)}
>
<SubNavItemText isWrapped={isWrapped}>{item.text}</SubNavItemText>
</SubNavItem>
<SubNav.ItemText isWrapped={isWrapped}>{item.text}</SubNav.ItemText>
</SubNav.Item>
)
)}
</SubNav>
Expand All @@ -210,41 +199,41 @@ export const ChromeStory: Story<IArgs> = ({
{hasHeader && (
<Header isStandalone={!(hasNav || hasSubNav)}>
{hasLogo && (
<HeaderItem hasLogo product={product}>
<HeaderItemIcon>
<Header.Item hasLogo product={product}>
<Header.ItemIcon>
<SupportIcon />
</HeaderItemIcon>
<HeaderItemText>Header Logo</HeaderItemText>
</HeaderItem>
</Header.ItemIcon>
<Header.ItemText>Header Logo</Header.ItemText>
</Header.Item>
)}
{headerItems.map((item, index) =>
item.isWrapper ? (
<HeaderItemWrapper
<Header.ItemWrapper
key={index}
maxX={item.maxX}
maxY={item.maxY}
isRound={item.isRound}
>
{item.hasIcon && (
<HeaderItemIcon>
<Header.ItemIcon>
{HEADER_ICONS[HEADER_ICONS.length - headerItems.length + index] || (
<HeaderIcon />
)}
</HeaderItemIcon>
</Header.ItemIcon>
)}
<HeaderItemText isClipped={item.isClipped}>{item.text}</HeaderItemText>
</HeaderItemWrapper>
<Header.ItemText isClipped={item.isClipped}>{item.text}</Header.ItemText>
</Header.ItemWrapper>
) : (
<HeaderItem key={index} maxX={item.maxX} maxY={item.maxY} isRound={item.isRound}>
<Header.Item key={index} maxX={item.maxX} maxY={item.maxY} isRound={item.isRound}>
{item.hasIcon && (
<HeaderItemIcon>
<Header.ItemIcon>
{HEADER_ICONS[HEADER_ICONS.length - headerItems.length + index] || (
<HeaderIcon />
)}
</HeaderItemIcon>
</Header.ItemIcon>
)}
<HeaderItemText isClipped={item.isClipped}>{item.text}</HeaderItemText>
</HeaderItem>
<Header.ItemText isClipped={item.isClipped}>{item.text}</Header.ItemText>
</Header.Item>
)
)}
</Header>
Expand All @@ -271,11 +260,11 @@ export const ChromeStory: Story<IArgs> = ({
<Footer>
{footerItems &&
footerItems.map(({ text, type }, index) => (
<FooterItem key={index}>
<Footer.Item key={index}>
<Button isBasic={type === 'basic'} isPrimary={type === 'primary'}>
{text}
</Button>
</FooterItem>
</Footer.Item>
))}
</Footer>
)}
Expand Down
18 changes: 7 additions & 11 deletions ...mo/stories/CollapsibleSubNavItemStory.tsx → ...me/demo/stories/SubNavCollapsibleItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,33 @@
*/

import React, { useState } from 'react';
import { Story } from '@storybook/react';
import { StoryFn } from '@storybook/react';
import { Col, Grid, Row } from '@zendeskgarden/react-grid';
import {
CollapsibleSubNavItem,
ICollapsibleSubNavItemProps,
SubNavItem
} from '@zendeskgarden/react-chrome';
import { SubNav, ICollapsibleSubNavItemProps } from '@zendeskgarden/react-chrome';
import { COLLAPSIBLE_SUB_NAV_ITEM } from './types';

interface IArgs extends ICollapsibleSubNavItemProps {
items: COLLAPSIBLE_SUB_NAV_ITEM[];
}

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

return (
<Grid>
<Row>
<Col sm={6}>
<CollapsibleSubNavItem {...args}>
<SubNav.CollapsibleItem {...args}>
{items.map((item, index) => (
<SubNavItem
<SubNav.Item
key={index}
isCurrent={current === index}
onClick={() => setCurrent(index)}
>
{item}
</SubNavItem>
</SubNav.Item>
))}
</CollapsibleSubNavItem>
</SubNav.CollapsibleItem>
</Col>
</Row>
</Grid>
Expand Down
Loading