@servicetitan/navigation 10.7.0 → 11.0.0-canary.237.4786284.0

package/src/components/header-navigation/header-navigation.stories.tsx

@@ -64,6 +64,7 @@ const HelpCenterButton = () => {
             trigger={
                 <HeaderNavigationTrigger
                     id="help"
+                    title="Help"
                     iconName="help_outline"
                     onClick={() => setOpen(true)}
                     icon={SvgIcon}
@@ -107,6 +108,7 @@ export const WithAllMonolithData = () => (
 
         <HeaderNavigationTrigger
             id="dialpad"
+            title="Dialpad"
             iconName="phone"
             counter={2}
             icon={SvgIcon}
@@ -115,6 +117,7 @@ export const WithAllMonolithData = () => (
 
         <HeaderNavigationLink
             id="search"
+            title="Search"
             to="https://google.com"
             target="_blank"
             iconComponent={SearchIcon}
@@ -126,6 +129,7 @@ export const WithAllMonolithData = () => (
         <HelpCenterButton />
         <HeaderNavigationTrigger
             id="titanAdvisor"
+            title="Titan Advisor"
             iconName="rocket"
             iconClassName={Styles.rocketIcon}
             icon={SvgIcon}
@@ -134,6 +138,7 @@ export const WithAllMonolithData = () => (
 
         <HeaderNavigationLink
             id="settings"
+            title="Settings"
             to="https://google.com"
             target="_blank"
             iconName="settings"
@@ -149,7 +154,7 @@ export const WithAllMonolithData = () => (
                 Task Management
             </ProfileDropdown.Link>
             <ProfileDropdown.Divider />
-            <ProfileDropdown.Link id="sign-out" to="https://googgle.com">
+            <ProfileDropdown.Link id="sign-out" to="https://googgle.com" text="Sign Out">
                 Sign Out <span className="c-neutral-100 m-l-half t-truncate">James Bond</span>
             </ProfileDropdown.Link>
             <ProfileDropdown.Section id="userid" className="c-neutral-100 fs-1">

package/src/components/left-navigation/header-navigation-tiny.stories.tsx

@@ -54,6 +54,7 @@ export const WithAllMonolithData = () => (
 
                 <HeaderNavigationLink
                     id="search"
+                    title="Search"
                     to="https://google.com"
                     target="_blank"
                     iconComponent={SearchIcon}
@@ -67,6 +68,7 @@ export const WithAllMonolithData = () => (
 
                 <HeaderNavigationLink
                     id="titanAdvisor"
+                    title="Titan Advisor"
                     to="titanAdvisor"
                     iconName="rocket"
                     iconClassName={Styles.rocketIcon}
@@ -76,6 +78,7 @@ export const WithAllMonolithData = () => (
 
                 <HeaderNavigationLink
                     id="settings"
+                    title="Settings"
                     to="settings"
                     target="_blank"
                     iconName="settings"
@@ -90,7 +93,7 @@ export const WithAllMonolithData = () => (
                         Task Management
                     </ProfileDropdown.Link>
                     <ProfileDropdown.Divider />
-                    <ProfileDropdown.Link id="sign-out" to="https://googgle.com">
+                    <ProfileDropdown.Link id="sign-out" to="https://googgle.com" text="Sign Out">
                         Sign Out{' '}
                         <span className="c-neutral-100 m-l-half t-truncate">James Bond</span>
                     </ProfileDropdown.Link>
@@ -121,6 +124,7 @@ export const WithAllMonolithDataCommercial = () => (
 
                 <HeaderNavigationLink
                     id="search"
+                    title="Search"
                     to="https://google.com"
                     target="_blank"
                     iconComponent={SearchIcon}
@@ -133,6 +137,7 @@ export const WithAllMonolithDataCommercial = () => (
 
                 <HeaderNavigationLink
                     id="titanAdvisor"
+                    title="Titan Advisor"
                     to="titanAdvisor"
                     iconName="rocket"
                     iconClassName={Styles.rocketIcon}
@@ -142,6 +147,7 @@ export const WithAllMonolithDataCommercial = () => (
 
                 <HeaderNavigationLink
                     id="settings"
+                    title="Settings"
                     to="settings"
                     iconName="settings"
                     aria-label="search"
@@ -156,7 +162,7 @@ export const WithAllMonolithDataCommercial = () => (
                         Task Management
                     </ProfileDropdown.Link>
                     <ProfileDropdown.Divider />
-                    <ProfileDropdown.Link id="sign-out" to="https://googgle.com">
+                    <ProfileDropdown.Link id="sign-out" to="https://googgle.com" text="Sign Out">
                         Sign Out{' '}
                         <span className="c-neutral-100 m-l-half t-truncate">James Bond</span>
                     </ProfileDropdown.Link>

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

@@ -11,7 +11,7 @@ import {
 } from './side-navigation-links-internal';
 
 const WrappedLink: FC<{
-    children: ReactElement;
+    children: ReactElement<any>;
     wrapper: NonNullable<SideNavigationLinkProps['wrapper']>;
 }> = ({ children, wrapper: WrapperComponent }) => {
     return (

package/src/components/links.tsx

@@ -1,5 +1,4 @@
-import { FC, useContext } from 'react';
-import { NavigationLegacyContext } from '../utils/navigation-context';
+import { FC } from 'react';
 import {
     HeaderNavigationLinkProps,
     HeaderNavigationTriggerProps,
@@ -8,27 +7,48 @@ import {
     HeaderNavigationLink as HeaderNavigationLinkLegacy,
     HeaderNavigationTrigger as HeaderNavigationTriggerLegacy,
 } from './header-navigation/header-navigation-links';
+import { useTitanLayoutPlacementContext } from './titan-layout';
 import {
-    HeaderNavigationLink as HeaderNavigationLinkModern,
-    HeaderNavigationTrigger as HeaderNavigationTriggerModern,
-} from './left-navigation/header-navigation-tiny-links';
+    LayoutHeaderNavigationLink,
+    LayoutHeaderNavigationTrigger,
+} from './titan-layout/layout-header-links';
+import {
+    TitanLayoutSidebarLink,
+    TitanLayoutSidebarTrigger,
+} from './titan-layout/layout-sidebar-links';
 
 export const HeaderNavigationLink: FC<HeaderNavigationLinkProps> = props => {
-    const isLegacy = useContext(NavigationLegacyContext);
+    const placement = useTitanLayoutPlacementContext();
 
-    return isLegacy ? (
-        <HeaderNavigationLinkLegacy {...props} />
+    return placement === 'top' ? (
+        <LayoutHeaderNavigationLink {...props} />
+    ) : placement === 'side' ? (
+        <TitanLayoutSidebarLink
+            id={props.id}
+            icon={props.icon}
+            iconActive={props.iconActive}
+            to={props.to}
+            title={props.title}
+            counter={props.counter}
+        />
     ) : (
-        <HeaderNavigationLinkModern {...props} />
+        <HeaderNavigationLinkLegacy {...props} />
     );
 };
 
 export const HeaderNavigationTrigger: FC<HeaderNavigationTriggerProps> = props => {
-    const isLegacy = useContext(NavigationLegacyContext);
+    const placement = useTitanLayoutPlacementContext();
 
-    return isLegacy ? (
-        <HeaderNavigationTriggerLegacy {...props} />
+    return placement === 'top' ? (
+        <LayoutHeaderNavigationTrigger {...props} />
+    ) : placement === 'side' ? (
+        <TitanLayoutSidebarTrigger
+            id={props.id}
+            title={props.title}
+            icon={props.icon}
+            iconActive={props.iconActive}
+        />
     ) : (
-        <HeaderNavigationTriggerModern {...props} />
+        <HeaderNavigationTriggerLegacy {...props} />
     );
 };

package/src/components/logo/logo-company-title.tsx

@@ -1,15 +1,17 @@
 import { FC } from 'react';
 
 /* tslint:disable: max-line-length */
-export const LogoCompanyTitle: FC<{ className?: string; fill?: string; size?: string }> = ({
-    className,
-    fill = 'currentColor',
-    size = '162',
-}) => {
+export const LogoCompanyTitle: FC<{
+    className?: string;
+    fill?: string;
+    size?: string;
+    height?: string | number;
+}> = ({ className, fill = 'currentColor', size = '162', height }) => {
     return (
         <svg
             className={className}
-            width={size}
+            width={height ? undefined : size}
+            height={height}
             viewBox="0 0 322 80"
             xmlns="http://www.w3.org/2000/svg"
         >

package/src/components/profile-dropdown/profile-dropdown.module.less

@@ -105,6 +105,10 @@
         position: relative;
     }
 
+    .dropdown-content-wrapper > span {
+        display: block !important;
+    }
+
     .dropdown-content-bottom-left {
         .dropdown-content-wrapper::before {
             content: '';

package/src/components/profile-dropdown/profile-dropdown.stories.tsx

@@ -21,9 +21,9 @@ export const ProfileDropdownDefault = () => (
         <ProfileDropdown.Link id="first" to="https://google.com">
             first link
         </ProfileDropdown.Link>
-        <ProfileDropdown.Link id="second" onClick={() => alert('second click')}>
+        <ProfileDropdown.Section id="second" onClick={() => alert('second click')}>
             second link
-        </ProfileDropdown.Link>
+        </ProfileDropdown.Section>
         <ProfileDropdown.Divider />
         <ProfileDropdown.Section id="content">some content</ProfileDropdown.Section>
         <ProfileDropdown.Divider />
@@ -45,9 +45,9 @@ export const ProfileDropdownWithLogo = () => (
         <ProfileDropdown.Link id="first" to="https://google.com">
             first link
         </ProfileDropdown.Link>
-        <ProfileDropdown.Link id="second" onClick={() => alert('second click')}>
+        <ProfileDropdown.Section id="second" onClick={() => alert('second click')}>
             second link
-        </ProfileDropdown.Link>
+        </ProfileDropdown.Section>
     </ProfileDropdown>
 );
 

package/src/components/profile-dropdown/profile-dropdown.tsx

@@ -6,6 +6,7 @@ import SvgAccountInactive from '@servicetitan/anvil2/assets/icons/st/gnav_accoun
 import { BodyText, Popover, PopoverPropsStrict } from '@servicetitan/design-system';
 import classNames from 'classnames';
 import {
+    ComponentPropsWithoutRef,
     FC,
     HTMLAttributeAnchorTarget,
     MouseEvent,
@@ -25,6 +26,7 @@ import {
 } from '../../utils/navigation-context';
 import { getCounterTag } from '../../utils/side-nav';
 import { CounterTag } from '../counter-tag';
+import { withTooltip } from '../titan-layout/with-tooltip';
 import * as Styles from './profile-dropdown.module.less';
 import { ProfileLogo } from './profile-icon';
 
@@ -146,21 +148,28 @@ const ProfileDropdownTrigger: FC<ProfileDropdownTriggerProps> = ({
     );
 };
 
+export type ProfileItemContent =
+    | { children: string; text?: string }
+    | { children: ReactNode; text: string };
+
 export interface ProfileDropdownSectionPropsStrict {
     children: ReactNode;
     id: string;
+    tooltip?: string;
     className?: string;
     onClick?(e: MouseEvent): void;
 }
 
-interface ProfileDropdownSectionProps extends ProfileDropdownSectionPropsStrict {
-    [key: string]: any;
-}
+export type ProfileDropdownSectionProps = Omit<ComponentPropsWithoutRef<'div'>, 'children'> &
+    ProfileDropdownSectionPropsStrict &
+    ProfileItemContent;
 
 export const ProfileDropdownSection: FC<ProfileDropdownSectionProps> = ({
     children,
     className,
     id,
+    text,
+    tooltip,
     onClick,
     ...rest
 }) => {
@@ -172,16 +181,20 @@ export const ProfileDropdownSection: FC<ProfileDropdownSectionProps> = ({
         }
     };
 
-    return (
+    return withTooltip(
         <div
-            className={classNames(Styles.dropdownSection, className)}
+            className={classNames(Styles.dropdownSection, className, {
+                'cursor-pointer': !!onClick,
+            })}
             onClick={clickHandler}
             data-cy={`profile-dropdown-section-${id}`}
             data-pendo={`profile-dropdown-section-${id}`}
             {...rest}
         >
             {children}
-        </div>
+        </div>,
+        tooltip,
+        'left'
     );
 };
 
@@ -193,15 +206,15 @@ export interface ProfileDropdownLinkPropsStrict {
     className?: string;
     external?: boolean;
     target?: HTMLAttributeAnchorTarget;
-    to?: string;
+    tooltip?: string;
+    to: string;
     tag?: CounterTagData;
     counter?: CounterTagValue;
-    onClick?: () => void;
 }
 
-export interface ProfileDropdownLinkProps extends ProfileDropdownLinkPropsStrict {
-    [key: string]: any;
-}
+export type ProfileDropdownLinkProps = Omit<ComponentPropsWithoutRef<'a'>, 'children'> &
+    ProfileDropdownLinkPropsStrict &
+    ProfileItemContent;
 
 export const ProfileDropdownLink: FC<ProfileDropdownLinkProps> = ({
     children,
@@ -211,17 +224,14 @@ export const ProfileDropdownLink: FC<ProfileDropdownLinkProps> = ({
     counter,
     tag,
     target,
+    text,
     to,
+    tooltip,
     onClick,
     ...rest
 }: ProfileDropdownLinkProps) => {
     const NavigationComponent = useContext(NavigationComponentContext);
 
-    const clickHandler = (e: MouseEvent<any>) => {
-        e.preventDefault();
-        onClick?.();
-    };
-
     const isExternalLink = external ?? to?.startsWith('http');
 
     const tagElement = useMemo(
@@ -229,41 +239,34 @@ export const ProfileDropdownLink: FC<ProfileDropdownLinkProps> = ({
         [counter, tag]
     );
 
-    return isExternalLink ? (
-        <a
-            className={classNames(Styles.dropdownSection, Styles.dropdownLink, className)}
-            href={to}
-            target={target}
-            data-cy={`profile-dropdown-link-${id}`}
-            data-pendo={`profile-dropdown-link-${id}`}
-            {...rest}
-        >
-            {children}
-            {tagElement}
-        </a>
-    ) : to ? (
-        <NavigationComponent
-            className={classNames(Styles.dropdownSection, Styles.dropdownLink, className)}
-            target={target}
-            to={to}
-            data-cy={`profile-dropdown-link-${id}`}
-            data-pendo={`profile-dropdown-link-${id}`}
-            {...rest}
-        >
-            {children}
-            {tagElement}
-        </NavigationComponent>
-    ) : (
-        <a
-            className={classNames(Styles.dropdownSection, Styles.dropdownLink, className)}
-            onClick={clickHandler}
-            data-cy={`profile-dropdown-link-${id}`}
-            data-pendo={`profile-dropdown-link-${id}`}
-            {...rest}
-        >
-            {children}
-            {tagElement}
-        </a>
+    return withTooltip(
+        isExternalLink ? (
+            <a
+                className={classNames(Styles.dropdownSection, Styles.dropdownLink, className)}
+                href={to}
+                target={target}
+                data-cy={`profile-dropdown-link-${id}`}
+                data-pendo={`profile-dropdown-link-${id}`}
+                {...rest}
+            >
+                {children}
+                {tagElement}
+            </a>
+        ) : (
+            <NavigationComponent
+                className={classNames(Styles.dropdownSection, Styles.dropdownLink, className)}
+                target={target}
+                to={to}
+                data-cy={`profile-dropdown-link-${id}`}
+                data-pendo={`profile-dropdown-link-${id}`}
+                {...rest}
+            >
+                {children}
+                {tagElement}
+            </NavigationComponent>
+        ),
+        tooltip,
+        'left'
     );
 };
 
@@ -291,6 +294,7 @@ export interface ProfileDropdownProps extends ProfileDropdownPropsStrict {
 export interface ProfileDropdownType extends FC<ProfileDropdownProps> {
     Divider: typeof ProfileDropdownDivider;
     Link: typeof ProfileDropdownLink;
+    Trigger: typeof ProfileDropdownTrigger;
     Section: typeof ProfileDropdownSection;
 }
 

package/src/components/titan-layout/index.ts

@@ -0,0 +1,5 @@
+export * from './titan-layout';
+export * from './layout-profile';
+export * from './layout-context';
+export * from './layout-logo';
+export * from './interface';

package/src/components/titan-layout/interface-internal.ts

@@ -0,0 +1,6 @@
+import { FC } from 'react';
+import { NavLinkComponentProps } from '../../utils/navigation-context';
+
+export interface NavigationComponentProps {
+    navigationComponent: FC<NavLinkComponentProps>;
+}

package/src/components/titan-layout/interface.ts

@@ -0,0 +1,26 @@
+import { FC, ReactElement } from 'react';
+import { NavigationItemData } from '../../utils/navigation';
+import { TitanLayoutSidebarContextType } from './layout-context';
+
+export interface TitanLayoutSidebarLinkWrapperProps {
+    children:
+        | ReactElement<TitanLayoutSidebarLinkProps>
+        | ReactElement<TitanLayoutSidebarTriggerProps>;
+    context: TitanLayoutSidebarContextType;
+}
+
+export interface TitanLayoutSidebarLinkProps extends Omit<NavigationItemData, 'submenu'> {
+    wrapper?: FC<TitanLayoutSidebarLinkWrapperProps>;
+}
+export interface TitanLayoutSidebarTriggerProps
+    extends Omit<TitanLayoutSidebarLinkProps, 'to' | 'isActive'> {
+    isActive?: boolean;
+    wrapper?: FC<TitanLayoutSidebarLinkWrapperProps>;
+    onClick?: () => void;
+    onMobileClick?: () => void;
+}
+
+export interface TitanLayoutState {
+    navCollapsed: boolean;
+    submenuExpanded?: string;
+}

package/src/components/titan-layout/layout-context.tsx

@@ -0,0 +1,30 @@
+import { CSSProperties, FC, createContext, useContext } from 'react';
+import { DefaultNavLinkComponent, NavLinkComponentProps } from '../../utils/navigation-context';
+import { TitanBreakpoint } from '../../utils/use-breakpoint';
+
+export interface TitanLayoutSidebarContextType {
+    styles: {
+        popoverContent: CSSProperties;
+    };
+}
+
+export type TitanLayoutPlacement = 'top' | 'side' | 'unset';
+
+export interface TitanLayoutContextType {
+    NavigationComponent: FC<NavLinkComponentProps>;
+    breakpoint: TitanBreakpoint;
+    isTitanLayout: boolean;
+    sidebar: TitanLayoutSidebarContextType;
+}
+
+export const LayoutContext = createContext<TitanLayoutContextType>({
+    NavigationComponent: DefaultNavLinkComponent,
+    breakpoint: { name: 'lg', isMobile: false },
+    isTitanLayout: false,
+    sidebar: { styles: { popoverContent: {} } },
+});
+
+export const useTitanLayoutContext = () => useContext(LayoutContext);
+
+export const LayoutPlacementContext = createContext<TitanLayoutPlacement | undefined>(undefined);
+export const useTitanLayoutPlacementContext = () => useContext(LayoutPlacementContext);

package/src/components/titan-layout/layout-header-links.tsx

@@ -0,0 +1,144 @@
+import { Icon, IconProps } from '@servicetitan/anvil2';
+import classNames from 'classnames';
+import { FC, Fragment } from 'react';
+import {
+    HeaderNavigationLinkProps,
+    HeaderNavigationTriggerProps,
+} from '../../utils/navigation-legacy';
+import { getCounterTag } from '../../utils/side-nav';
+import { CounterTag, CounterTagProps } from '../counter-tag';
+// use v1 tooltips due to bug with v2 in monolith
+import { withTooltip } from '../header-navigation/with-tooltip';
+import { useTitanLayoutContext } from './layout-context';
+import * as Styles from './layout-header.module.less';
+
+/** Content for navigation items */
+const HeaderNavigationItemContent: FC<{
+    tag?: CounterTagProps;
+    counterClassName?: string;
+    icon: IconProps['svg'] | undefined;
+    iconActive?: IconProps['svg'];
+    label?: string;
+    labelClassName?: string;
+}> = ({ counterClassName, icon, iconActive, label, labelClassName, tag }) => {
+    return (
+        <Fragment>
+            {!!icon && <Icon svg={icon} className={Styles.navigationIcon} />}
+            {!!iconActive && (
+                <Icon
+                    svg={iconActive}
+                    className={classNames(Styles.navigationIcon, Styles.navigationIconActive)}
+                />
+            )}
+
+            {!!label && (
+                <span className={classNames(Styles.navigationItemLabel, labelClassName)}>
+                    {label}
+                </span>
+            )}
+
+            {!!tag && (
+                <CounterTag
+                    data={tag}
+                    className={classNames(Styles.navigationItemCounter, counterClassName)}
+                    longClassName={Styles.navigationItemCounterLong}
+                />
+            )}
+        </Fragment>
+    );
+};
+
+/** Navigation extra item with link */
+export const LayoutHeaderNavigationLink: FC<HeaderNavigationLinkProps> = ({
+    id,
+    to,
+    hint,
+    tooltip,
+    className,
+    counter,
+    icon,
+    iconActive,
+    iconClassName,
+    iconComponent,
+    iconName,
+    isActive,
+    label,
+    labelClassName,
+    tag,
+    target,
+    ...rest
+}) => {
+    const { NavigationComponent } = useTitanLayoutContext();
+
+    return withTooltip(
+        <NavigationComponent
+            data-cy={`navigation-link-${id}`}
+            data-pendo={`navigation-link-${id}`}
+            {...rest}
+            key={id}
+            to={to}
+            title={hint}
+            className={classNames(Styles.navigationLink, className, {
+                [Styles.navigationItemActive]: isActive === true,
+                [Styles.navigationItemIconState]: !!icon && !!iconActive,
+            })}
+            isActive={typeof isActive === 'function' ? isActive : undefined}
+            activeClassName={Styles.navigationItemActive}
+            target={target}
+        >
+            <HeaderNavigationItemContent
+                tag={getCounterTag(counter, tag)}
+                icon={icon}
+                iconActive={iconActive}
+                label={label}
+                labelClassName={labelClassName}
+            />
+        </NavigationComponent>,
+        tooltip
+    );
+};
+
+/** Navigation extra item with icon button */
+export const LayoutHeaderNavigationTrigger: FC<HeaderNavigationTriggerProps> = ({
+    id,
+    className,
+    counter,
+    icon,
+    iconActive,
+    iconName,
+    isActive,
+    hint,
+    label,
+    labelClassName,
+    tag,
+    tooltip,
+    title,
+    titleClassName,
+    ...rest
+}) => {
+    return withTooltip(
+        <div
+            data-cy={`navigation-trigger-${id}`}
+            data-pendo={`navigation-trigger-${id}`}
+            {...rest}
+            title={hint}
+            className={classNames(
+                Styles.navigationLink,
+                {
+                    [Styles.navigationItemActive]: isActive === true,
+                    [Styles.navigationItemIconState]: !!icon && !!iconActive,
+                },
+                'cursor-pointer',
+                className
+            )}
+        >
+            <HeaderNavigationItemContent
+                tag={getCounterTag(counter, tag)}
+                icon={isActive && iconActive ? iconActive : icon}
+                label={label}
+                labelClassName={labelClassName}
+            />
+        </div>,
+        tooltip
+    );
+};