@servicetitan/navigation 3.2.0 → 4.0.0

package/src/components/side-navigation/side-navigation.tsx

@@ -1,15 +1,12 @@
-import { BodyText, Divider, Eyebrow, Icon, Popover, Stack } from '@servicetitan/design-system';
+import { Icon } from '@servicetitan/anvil2';
+import SvgCollapse from '@servicetitan/anvil2/assets/icons/st/gnav_menu_collapse.svg';
+import SvgExpand from '@servicetitan/anvil2/assets/icons/st/gnav_menu_expand.svg';
 import classNames from 'classnames';
-import { FC, Fragment, PropsWithChildren, useState } from 'react';
+import { FC, Fragment } from 'react';
 import { HeaderNavigationItemData, NavLinkComponentProps } from '../../utils/navigation';
-import {
-    DefaultNavLinkComponent,
-    NavLinkContext,
-    useNavLink,
-} from '../../utils/navigation-context';
+import { DefaultNavLinkComponent } from '../../utils/navigation-context';
 import { withTooltip } from '../../utils/with-tooltip';
 import { CounterTag } from '../counter-tag';
-import { IconSideExpanded, IconSideOptions, IconSideSlim } from './icons';
 import * as Styles from './side-navigation.module.less';
 
 export interface SideNavigationProps {
@@ -39,48 +36,57 @@ export const SideNavigation: FC<SideNavigationProps> = ({
     onExpandedChange,
 }) => {
     return (
-        <NavLinkContext.Provider value={navigationComponent}>
-            <div
-                className={classNames(
-                    Styles.sideNav,
-                    expanded ? Styles.sideNavExpanded : Styles.sideNavSlim,
-                    className
-                )}
-                id={id}
-                data-cy="side-navigation"
-            >
-                {!!itemsTop?.length && (
-                    <Fragment>
-                        <div className={Styles.sideNavTop} data-cy="navigation-items-top">
-                            {itemsTop.map(item => (
-                                <SideNavigationItem key={item.id} expanded={expanded} {...item} />
-                            ))}
-                        </div>
-                        <div className={Styles.divider} />
-                    </Fragment>
-                )}
-                <div className={Styles.sideNavContent} data-cy="navigation-items">
-                    {items?.map(item => (
-                        <SideNavigationItem key={item.id} expanded={expanded} {...item} />
-                    ))}
-                </div>
-                <div className={Styles.sideNavBottom}>
-                    <SideNavigationOptionsToggle
+        <div
+            className={classNames(
+                Styles.sideNav,
+                expanded ? Styles.sideNavExpanded : Styles.sideNavSlim,
+                className
+            )}
+            id={id}
+            data-cy="side-navigation"
+        >
+            {!!itemsTop?.length && (
+                <Fragment>
+                    <div className={Styles.sideNavTop} data-cy="navigation-items-top">
+                        {itemsTop.map(item => (
+                            <SideNavigationItem
+                                key={item.id}
+                                expanded={expanded}
+                                navigationComponent={navigationComponent}
+                                {...item}
+                            />
+                        ))}
+                    </div>
+                    <div className={Styles.divider} />
+                </Fragment>
+            )}
+            <div className={Styles.sideNavContent} data-cy="navigation-items">
+                {items?.map(item => (
+                    <SideNavigationItem
+                        key={item.id}
                         expanded={expanded}
-                        onExpandedChange={onExpandedChange}
+                        navigationComponent={navigationComponent}
+                        {...item}
                     />
-                </div>
+                ))}
             </div>
-        </NavLinkContext.Provider>
+            <div className={Styles.sideNavBottom}>
+                <SideNavigationOptionsToggle
+                    expanded={expanded}
+                    onExpandedChange={onExpandedChange}
+                />
+            </div>
+        </div>
     );
 };
 
 interface SideNavigationItemProps extends HeaderNavigationItemData {
+    navigationComponent: FC<NavLinkComponentProps>;
     expanded?: boolean;
 }
 
 /** Side Navigation menu item */
-export const SideNavigationItem: FC<SideNavigationItemProps> = ({
+const SideNavigationItem: FC<SideNavigationItemProps> = ({
     id,
     to,
     title,
@@ -89,13 +95,12 @@ export const SideNavigationItem: FC<SideNavigationItemProps> = ({
     className,
     iconClassName,
     iconComponent: IconComponent,
-    iconName,
+    icon,
+    iconActive,
     isActive,
+    navigationComponent: NavigationComponent,
     expanded,
 }) => {
-    const NavigationComponent = useNavLink();
-    const iconClass = classNames(Styles.navigationIcon, iconClassName);
-
     return withTooltip(
         <NavigationComponent
             data-cy={`navigation-item-${id}`}
@@ -105,25 +110,41 @@ export const SideNavigationItem: FC<SideNavigationItemProps> = ({
             title={hint}
             className={classNames(Styles.navigationItem, className, {
                 [Styles.navigationItemActive]: isActive === true,
+                [Styles.navigationItemIconState]: !!icon && !!iconActive,
             })}
             isActive={typeof isActive === 'function' ? isActive : undefined}
             activeClassName={Styles.navigationItemActive}
         >
             {IconComponent ? (
-                <i className={iconClass}>
+                <i className={classNames(Styles.navigationIcon, iconClassName)}>
                     <IconComponent />
                 </i>
-            ) : iconName ? (
-                <Icon name={iconName} className={iconClass} />
             ) : (
-                <i className={iconClass} />
+                <Fragment>
+                    {icon && (
+                        <Icon
+                            svg={icon}
+                            className={classNames(Styles.navigationIcon, iconClassName)}
+                        />
+                    )}
+                    {iconActive && (
+                        <Icon
+                            svg={iconActive}
+                            className={classNames(
+                                Styles.navigationIcon,
+                                Styles.navigationIconActive,
+                                iconClassName
+                            )}
+                        />
+                    )}
+                </Fragment>
             )}
 
             {!!expanded && <span className={Styles.navigationItemText}>{title}</span>}
             {!!counter && <CounterTag data={counter} className={Styles.navigationItemCounter} />}
         </NavigationComponent>,
         expanded ? undefined : title,
-        'r'
+        'right'
     );
 };
 
@@ -140,85 +161,11 @@ export const SideNavigationOptionsToggle: FC<{
             onClick={() => onExpandedChange(!expanded)}
         >
             <div className={Styles.optionsIcon}>
-                <IconSideOptions expanded={expanded} />
+                <Icon svg={expanded ? SvgCollapse : SvgExpand} />
             </div>
 
             {!!expanded && <span className={Styles.optionsItemText}>Collapse Menu</span>}
         </div>,
         expanded ? undefined : 'Expand Menu',
-        'r'
-    );
-
-/** Side Navigation options popover */
-export const SideNavigationOptionsPopover: FC<
-    PropsWithChildren<{
-        expanded?: boolean;
-        onExpandedChange(expanded: boolean): void;
-    }>
-> = ({ children, expanded, onExpandedChange }) => {
-    const [open, setOpen] = useState(false);
-
-    const onExpand = () => {
-        setOpen(false);
-        onExpandedChange(true);
-    };
-    const onCollapse = () => {
-        setOpen(false);
-        onExpandedChange(false);
-    };
-
-    return (
-        <Popover
-            className="bg-neutral-30"
-            trigger={children}
-            direction="tr"
-            onClickOutside={() => setOpen(false)}
-            open={open}
-            padding="s"
-            width="xs"
-        >
-            <Eyebrow className="p-l-2">menu options</Eyebrow>
-            <SideNavigationOptionsItem
-                active={!expanded}
-                icon={IconSideSlim}
-                title="Slim"
-                onClick={onCollapse}
-            />
-            <SideNavigationOptionsItem
-                active={!!expanded}
-                icon={IconSideExpanded}
-                title="Expanded"
-                onClick={onExpand}
-            />
-
-            <Divider className="m-x-half m-y-1" />
-
-            <SideNavigationOptionsItem
-                active={false}
-                icon={expanded ? IconSideExpanded : IconSideSlim}
-                title={expanded ? 'Expanded' : 'Slim'}
-            />
-        </Popover>
+        'right'
     );
-};
-
-const SideNavigationOptionsItem: FC<{
-    active: boolean;
-    icon: FC;
-    title: string;
-    onClick?: () => void;
-}> = ({ active, onClick, title, icon: IconComponent }) => (
-    <Stack
-        className={classNames(
-            active ? Styles.optionsPopoverItemActive : Styles.optionsPopoverItemInactive,
-            'p-y-1 p-x-2',
-            { [Styles.optionsPopoverItemClickable]: onClick && !active }
-        )}
-        alignItems="center"
-        onClick={!active && onClick}
-    >
-        <IconComponent />
-        <BodyText className="c-inherit m-l-1 flex-grow-1 flex-basis-0">{title}</BodyText>
-        {active && <Icon name="check" />}
-    </Stack>
-);

package/src/test/data-stories.module.less

@@ -0,0 +1,6 @@
+// temp fix to reset incorrect coloring from anvil2
+.fix-icons {
+    :global(span[data-anv='icon'] > svg > path) {
+        fill: inherit !important;
+    }
+}

package/src/test/data-stories.module.less.d.ts

@@ -0,0 +1,3 @@
+export const __esModule: true;
+export const fixIcons: string;
+

package/src/test/data.stories.tsx

@@ -0,0 +1,220 @@
+import { AnvilProvider } from '@servicetitan/anvil2';
+import SvgPhone from '@servicetitan/anvil2/assets/icons/material/round/phone_disabled.svg';
+import SvgPhoneActive from '@servicetitan/anvil2/assets/icons/material/round/phone_enabled.svg';
+import SvgAccountingActive from '@servicetitan/anvil2/assets/icons/st/gnav_accounting_active.svg';
+import SvgAccounting from '@servicetitan/anvil2/assets/icons/st/gnav_accounting_inactive.svg';
+import SvgCallsActive from '@servicetitan/anvil2/assets/icons/st/gnav_calls_active.svg';
+import SvgCalls from '@servicetitan/anvil2/assets/icons/st/gnav_calls_inactive.svg';
+import SvgDashboardActive from '@servicetitan/anvil2/assets/icons/st/gnav_dashboard_active.svg';
+import SvgDashboard from '@servicetitan/anvil2/assets/icons/st/gnav_dashboard_inactive.svg';
+import SvgDispatchActive from '@servicetitan/anvil2/assets/icons/st/gnav_dispatch_active.svg';
+import SvgDispatch from '@servicetitan/anvil2/assets/icons/st/gnav_dispatch_inactive.svg';
+import SvgFleetProActive from '@servicetitan/anvil2/assets/icons/st/gnav_fleet_pro_active.svg';
+import SvgFleetPro from '@servicetitan/anvil2/assets/icons/st/gnav_fleet_pro_inactive.svg';
+import SvgFollowUpActive from '@servicetitan/anvil2/assets/icons/st/gnav_follow_up_active.svg';
+import SvgFollowUp from '@servicetitan/anvil2/assets/icons/st/gnav_follow_up_inactive.svg';
+import SvgInventoryActive from '@servicetitan/anvil2/assets/icons/st/gnav_inventory_active.svg';
+import SvgInventory from '@servicetitan/anvil2/assets/icons/st/gnav_inventory_inactive.svg';
+import SvgMarketingActive from '@servicetitan/anvil2/assets/icons/st/gnav_marketing_active.svg';
+import SvgMarketing from '@servicetitan/anvil2/assets/icons/st/gnav_marketing_inactive.svg';
+import SvgPosActive from '@servicetitan/anvil2/assets/icons/st/gnav_pos_active.svg';
+import SvgPos from '@servicetitan/anvil2/assets/icons/st/gnav_pos_inactive.svg';
+import SvgPriceBookActive from '@servicetitan/anvil2/assets/icons/st/gnav_pricebook_active.svg';
+import SvgPriceBook from '@servicetitan/anvil2/assets/icons/st/gnav_pricebook_inactive.svg';
+import SvgProjectsActive from '@servicetitan/anvil2/assets/icons/st/gnav_projects_active.svg';
+import SvgProjects from '@servicetitan/anvil2/assets/icons/st/gnav_projects_inactive.svg';
+import SvgReportsActive from '@servicetitan/anvil2/assets/icons/st/gnav_reports_active.svg';
+import SvgReports from '@servicetitan/anvil2/assets/icons/st/gnav_reports_inactive.svg';
+import SvgScheduleActive from '@servicetitan/anvil2/assets/icons/st/gnav_schedule_active.svg';
+import SvgSchedule from '@servicetitan/anvil2/assets/icons/st/gnav_schedule_inactive.svg';
+import SvgTasksActive from '@servicetitan/anvil2/assets/icons/st/gnav_tasks_active.svg';
+import SvgTasks from '@servicetitan/anvil2/assets/icons/st/gnav_tasks_inactive.svg';
+
+import { Popover } from '@servicetitan/design-system';
+
+import classNames from 'classnames';
+import { forwardRef, useState } from 'react';
+// needed only for storybook and added in root dependencies
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { MemoryRouter, useHistory, useLocation } from 'react-router-dom';
+import { HeaderNavigationTrigger } from '../components/header-navigation';
+import { HeaderNavigationItemData, NavLinkComponentProps } from '../utils/navigation';
+import * as Styles from './data-stories.module.less';
+
+export const NavLinkMock = forwardRef<any, NavLinkComponentProps>(
+    ({ to, children, activeClassName, className, isActive, ...rest }, ref) => {
+        const history = useHistory();
+        const location = useLocation();
+        const linkActive = location.pathname.replace('/', '') === to;
+
+        return (
+            <a
+                {...rest}
+                className={classNames(className, linkActive ? activeClassName : '')}
+                href={to}
+                onClick={e => {
+                    e.preventDefault();
+
+                    if (!to.startsWith('http')) {
+                        history.push(to);
+                    }
+                }}
+                ref={ref}
+            >
+                {children}
+            </a>
+        );
+    }
+);
+
+export const withMemoryRouter = (Story: any) => (
+    <MemoryRouter>
+        <Story />
+    </MemoryRouter>
+);
+
+export const withAnvil = (Story: any) => (
+    <AnvilProvider className={Styles.fixIcons}>
+        <Story />
+    </AnvilProvider>
+);
+
+export const InventoryIcon = () => (
+    <svg width="20" xmlns="http://www.w3.org/2000/svg" viewBox="-293 385 24 24" fill="currentColor">
+        <polyline points="-288,400.9 -282,404.3 -282,397.6 -288,394.2 -288,400.9 " />
+        <path d="M-272,401.5c0,0.4-0.2,0.7-0.5,0.9l-7.9,4.4c-0.2,0.1-0.4,0.2-0.6,0.2s-0.4-0.1-0.6-0.2l-7.9-4.4c-0.3-0.2-0.5-0.5-0.5-0.9v-9c0-0.4,0.2-0.7,0.5-0.9l7.9-4.4c0.2-0.1,0.4-0.2,0.6-0.2s0.4,0.1,0.6,0.2l7.9,4.4c0.3,0.2,0.5,0.5,0.5,0.9V401.5 M-287,392.5 l6,3.4l5.9-3.3l-5.9-3.4L-287,392.5 M-274,400.9v-6.7l-6,3.4v6.7L-274,400.9z" />
+    </svg>
+);
+
+export const SearchIcon = () => (
+    <svg
+        width="1em"
+        height="1em"
+        viewBox="0 0 24 24"
+        fill="none"
+        xmlns="http://www.w3.org/2000/svg"
+    >
+        <g transform="translate(0,4)">
+            <path
+                d="M0 15.7992V13.9992H12V15.7992H0ZM0 9.49922V7.69922H6V9.49922H0ZM0 3.19922V1.39922H6V3.19922H0ZM22.74 15.7992L17.94 10.9992C17.42 11.3992 16.86 11.6992 16.26 11.8992C15.66 12.0992 15.04 12.1992 14.4 12.1992C12.74 12.1992 11.325 11.6142 10.155 10.4442C8.985 9.27422 8.4 7.85922 8.4 6.19922C8.4 4.53922 8.985 3.12422 10.155 1.95422C11.325 0.784219 12.74 0.199219 14.4 0.199219C16.06 0.199219 17.475 0.784219 18.645 1.95422C19.815 3.12422 20.4 4.53922 20.4 6.19922C20.4 6.83922 20.3 7.45922 20.1 8.05922C19.9 8.65922 19.6 9.21922 19.2 9.73922L24 14.5392L22.74 15.7992ZM14.393 10.3992C15.5577 10.3992 16.55 9.99157 17.37 9.17627C18.19 8.36099 18.6 7.37099 18.6 6.20627C18.6 5.04157 18.1923 4.04922 17.377 3.22922C16.5618 2.40922 15.5718 1.99922 14.407 1.99922C13.2423 1.99922 12.25 2.40687 11.43 3.22217C10.61 4.03745 10.2 5.02745 10.2 6.19217C10.2 7.35687 10.6077 8.34922 11.423 9.16922C12.2382 9.98922 13.2282 10.3992 14.393 10.3992Z"
+                fill="white"
+            />
+        </g>
+    </svg>
+);
+
+const getItem = (
+    id: string,
+    data: Partial<HeaderNavigationItemData>
+): HeaderNavigationItemData => ({
+    id,
+    to: id,
+    title: id[0].toUpperCase() + id.substring(1),
+    hint: id,
+    icon: undefined,
+    iconActive: undefined,
+    ...(data ?? {}),
+});
+
+export const items = {
+    calendar: getItem('calendar', {
+        iconName: 'event',
+        icon: SvgSchedule,
+        iconActive: SvgScheduleActive,
+    }),
+    calls: getItem('calls', {
+        iconName: 'local_phone',
+        icon: SvgCalls,
+        iconActive: SvgCallsActive,
+        counter: 12,
+    }),
+    dashboard: getItem('dashboard', {
+        iconName: 'odometer',
+        icon: SvgDashboard,
+        iconActive: SvgDashboardActive,
+    }),
+    dispatch: getItem('dispatch', {
+        iconName: 'location_disabled',
+        icon: SvgDispatch,
+        iconActive: SvgDispatchActive,
+        counter: 1,
+    }),
+    fleet: getItem('fleet', {
+        iconName: 'fleet-pro',
+        icon: SvgFleetPro,
+        iconActive: SvgFleetProActive,
+        title: 'Fleet Pro',
+    }),
+    followUps: getItem('followUps', {
+        iconName: 'flag',
+        icon: SvgFollowUp,
+        iconActive: SvgFollowUpActive,
+        title: 'Follow Ups',
+    }),
+    inventory: getItem('inventory', {
+        iconName: 'toys',
+        icon: SvgInventory,
+        iconActive: SvgInventoryActive,
+    }),
+    purchasing: getItem('purchasing', { iconComponent: InventoryIcon }),
+    accounting: getItem('accounting', {
+        iconName: 'assignment',
+        icon: SvgAccounting,
+        iconActive: SvgAccountingActive,
+    }),
+    marketing: getItem('marketing', {
+        iconName: 'bullhorn',
+        icon: SvgMarketing,
+        iconActive: SvgMarketingActive,
+    }),
+    priceBook: getItem('priceBook', {
+        iconName: 'book',
+        icon: SvgPriceBook,
+        iconActive: SvgPriceBookActive,
+    }),
+    pointOfSale: getItem('pointOfSale', {
+        iconName: 'cash-register',
+        icon: SvgPos,
+        iconActive: SvgPosActive,
+    }),
+    projects: getItem('projects', {
+        iconName: 'folder_special',
+        icon: SvgProjects,
+        iconActive: SvgProjectsActive,
+    }),
+    reports: getItem('reports', {
+        iconName: 'folder_special',
+        icon: SvgReports,
+        iconActive: SvgReportsActive,
+    }),
+    tasks: getItem('tasks', {
+        iconName: 'format_list_bulleted',
+        icon: SvgTasks,
+        iconActive: SvgTasksActive,
+    }),
+};
+
+export const CallsNavigationTrigger = () => {
+    const [open, setOpen] = useState(false);
+
+    return (
+        <Popover
+            open={open}
+            onClickOutside={() => setOpen(false)}
+            direction="bl"
+            trigger={
+                <HeaderNavigationTrigger
+                    id="dialpad"
+                    iconName="phone"
+                    counter={2}
+                    icon={SvgPhone}
+                    iconActive={SvgPhoneActive}
+                    onClick={() => setOpen(!open)}
+                    isActive={open}
+                />
+            }
+        >
+            calls content
+        </Popover>
+    );
+};

package/src/utils/navigation-context.tsx

@@ -1,13 +1,18 @@
-import { FC, createContext, useContext } from 'react';
-import { NavLink } from 'react-router-dom';
+import { FC, createContext } from 'react';
 import { NavLinkComponentProps } from './navigation';
 
-export const DefaultNavLinkComponent: FC<NavLinkComponentProps> = props => (
-    <NavLink
-        {...props}
-        isActive={props.isActive && ((_, { pathname }) => props.isActive!(pathname))}
-    />
-);
+export const DefaultNavLinkComponent: FC<NavLinkComponentProps> = ({
+    children,
+    activeClassName,
+    isActive,
+    ...props
+}) => <a {...props}>{children}</a>;
 
-export const NavLinkContext = createContext(DefaultNavLinkComponent);
-export const useNavLink = () => useContext(NavLinkContext);
+export interface NavigationContextType {
+    NavigationComponent: FC<NavLinkComponentProps>;
+    isLegacy: boolean;
+}
+export const NavigationContext = createContext<NavigationContextType>({
+    NavigationComponent: DefaultNavLinkComponent,
+    isLegacy: false,
+});

package/src/utils/navigation.ts

@@ -1,3 +1,4 @@
+import { IconProps } from '@servicetitan/anvil2';
 import { IconPropsStrict } from '@servicetitan/design-system';
 import { FC, HTMLAttributeAnchorTarget, ReactNode } from 'react';
 import { CounterTagPropsType } from '../components/counter-tag';
@@ -27,6 +28,12 @@ export interface HeaderNavigationItemData {
     /** anvil's icon name of item */
     iconName?: IconPropsStrict['name'];
 
+    /** svg icon (anvil2) of inactive item */
+    icon: IconProps['svg'] | undefined;
+
+    /** svg icon (anvil2) of active item */
+    iconActive: IconProps['svg'] | undefined;
+
     /** icon component of item (<svg />) */
     iconComponent?: FC;