@servicetitan/navigation 11.0.0-canary.237.0ce6038.0 → 11.0.0-canary.237.4786284.0

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

@@ -2,7 +2,7 @@ import SvgAccountActive from '@servicetitan/anvil2/assets/icons/st/gnav_account_
 import SvgAccountInactive from '@servicetitan/anvil2/assets/icons/st/gnav_account_inactive.svg';
 
 import { FC, useState } from 'react';
-import { NavigationComponentContext } from '../../utils/navigation-context';
+import { NavLinkComponentProps, NavigationComponentContext } from '../../utils/navigation-context';
 import {
     ProfileDropdown as DesktopProfileDropdown,
     ProfileDropdownLinkProps,
@@ -24,6 +24,10 @@ export type {
     ProfileDropdownLinkProps,
 } from '../profile-dropdown/profile-dropdown';
 
+const ExternalNavComponent: FC<NavLinkComponentProps> = ({ children, isActive, ...props }) => (
+    <a {...props}>{children}</a>
+);
+
 const ProfileDropdownContent: FC<ProfileDropdownProps> = props => {
     const { breakpoint, NavigationComponent } = useTitanLayoutContext();
     return breakpoint.isMobile ? (
@@ -70,6 +74,18 @@ const ProfileDropdownDivider: FC = () => {
     );
 };
 
+const getText = (props: any): string | undefined => {
+    if (typeof props.children === 'string') {
+        return props.children;
+    }
+
+    if (typeof props.text === 'string') {
+        return props.text;
+    }
+
+    return undefined;
+};
+
 const ProfileDropdownSection: FC<ProfileDropdownSectionProps> = props => {
     const { breakpoint } = useTitanLayoutContext();
     return breakpoint.isMobile ? (
@@ -79,9 +95,9 @@ const ProfileDropdownSection: FC<ProfileDropdownSectionProps> = props => {
     );
 };
 const MobileProfileDropdownSection: FC<ProfileDropdownSectionProps> = props => {
-    const title = typeof props.children === 'string' ? props.children : undefined;
-    return title ? (
-        <InternalSideNavigationGroupTrigger id={props.id} title={title} onClick={props.onClick} />
+    const text = getText(props);
+    return text ? (
+        <InternalSideNavigationGroupTrigger id={props.id} title={text} onClick={props.onClick} />
     ) : null;
 };
 
@@ -98,13 +114,13 @@ const MobileProfileDropdownLink: FC<ProfileDropdownLinkProps & NavigationCompone
     navigationComponent,
     ...props
 }) => {
-    const title = typeof props.children === 'string' ? props.children : undefined;
-    return title ? (
+    const text = getText(props);
+    return text ? (
         <InternalSideNavigationGroupLink
             {...props}
             to={to}
-            title={title}
-            navigationComponent={navigationComponent}
+            title={text}
+            navigationComponent={props.external ? ExternalNavComponent : navigationComponent}
         />
     ) : null;
 };

package/src/components/titan-layout/layout-sidebar-links-internal.tsx

@@ -180,12 +180,22 @@ export const InternalSideNavigationTrigger: FC<
 
 export const InternalSideNavigationGroupLink: FC<
     NavigationSubmenuItemData & NavigationComponentProps
-> = ({ id, counter, tag, title, to, isActive, navigationComponent: NavigationComponent }) => {
+> = ({
+    id,
+    counter,
+    tag,
+    title,
+    to,
+    isActive,
+    navigationComponent: NavigationComponent,
+    ...rest
+}) => {
     return (
         <NavigationComponent
+            key={id}
             data-cy={`navigation-item-${id}`}
             data-pendo={`navigation-item-${id}`}
-            key={id}
+            {...rest}
             to={to}
             className={classNames(Styles.submenuItem, Styles.submenuLink, {
                 [Styles.submenuLinkActive]: isActive === true,

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

@@ -17,7 +17,10 @@ const WrappedLink: FC<{
 
 /** Side Navigation menu link */
 export function TitanLayoutSidebarLink({ wrapper, ...props }: TitanLayoutSidebarLinkProps) {
-    const { NavigationComponent } = useTitanLayoutContext();
+    const {
+        NavigationComponent,
+        breakpoint: { isMobile },
+    } = useTitanLayoutContext();
 
     const element = (
         <InternalSideNavigationLink
@@ -29,7 +32,7 @@ export function TitanLayoutSidebarLink({ wrapper, ...props }: TitanLayoutSidebar
         />
     );
 
-    return wrapper ? <WrappedLink wrapper={wrapper}>{element}</WrappedLink> : element;
+    return wrapper && !isMobile ? <WrappedLink wrapper={wrapper}>{element}</WrappedLink> : element;
 }
 
 /** Side Navigation menu trigger */

package/src/components/titan-layout/layout-sidebar.module.less

@@ -141,7 +141,6 @@
 // desktop version expanded
 .nav-wide {
     width: var(--nav-offset-left);
-    padding-top: @spacing-2;
 
     .toggle {
         .toggle-content {
@@ -162,6 +161,10 @@
         margin-top: @spacing-1;
         margin-bottom: @spacing-1;
     }
+
+    .nav-main {
+        padding-top: @spacing-1;
+    }
 }
 
 .nav-drawer,

package/src/components/titan-layout/titan-layout.module.less

@@ -13,7 +13,7 @@
     margin-top: var(--nav-offset-top);
 
     display: flex;
-    flex-direction: row;
+    flex-direction: column;
 
     .side {
         flex-basis: var(--nav-offset-left);
@@ -26,27 +26,45 @@
 
         display: flex;
         flex-direction: column;
-        overflow: hidden;
+        overflow-y: hidden;
+        overflow-x: auto;
+
+        .content-page {
+            position: relative;
+            display: flex;
+            flex-direction: column;
+            flex-grow: 1;
+            flex-basis: 0;
+            overflow-y: hidden;
+        }
     }
 }
 
-.layout-legacy,
 .layout-anvil2 {
+    .header {
+        position: sticky;
+        top: var(--nav-offset-top);
+        z-index: 989;
+    }
+}
+
+.layout-desktop {
     padding-left: var(--nav-offset-left);
 
-    .top-placeholder {
-        height: var(--nav-offset-top);
+    .side {
+        position: fixed;
+        top: var(--nav-offset-top);
+        bottom: 0;
+        left: 0;
+        right: 0;
+        z-index: @z-index-global-nav;
     }
+}
 
-    &:not(.layout-mobile) {
-        .side {
-            position: fixed;
-            top: var(--nav-offset-top);
-            bottom: 0;
-            left: 0;
-            right: 0;
-            z-index: @z-index-global-nav;
-        }
+.layout-legacy,
+.layout-anvil2 {
+    .top-placeholder {
+        height: var(--nav-offset-top);
     }
 }
 
@@ -58,11 +76,11 @@
         --nav-offset-left: 0;
     }
 
-    &.layout-nav-slim {
+    &.layout-desktop.layout-nav-slim {
         --nav-offset-left: 64px;
     }
 
-    &.layout-nav-wide {
+    &.layout-desktop.layout-nav-wide {
         --nav-offset-left: 212px;
     }
 
@@ -73,4 +91,26 @@
         right: 0;
         z-index: 991;
     }
+
+    .content {
+        overflow-x: auto;
+
+        .header {
+            position: sticky;
+            left: 0;
+            right: 0;
+        }
+    }
+}
+
+@media print {
+    .layout {
+        --nav-offset-left: 0px !important;
+        --nav-offset-right: 0px !important;
+
+        .side,
+        .top {
+            display: none !important;
+        }
+    }
 }

package/src/components/titan-layout/titan-layout.module.less.d.ts

@@ -1,8 +1,11 @@
 export const __esModule: true;
 export const content: string;
+export const contentPage: string;
+export const header: string;
 export const layout: string;
 export const layoutAnvil1: string;
 export const layoutAnvil2: string;
+export const layoutDesktop: string;
 export const layoutLegacy: string;
 export const layoutMobile: string;
 export const layoutNavSlim: string;

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

@@ -1,4 +1,4 @@
-import { Page as Anvil2Page, Popover } from '@servicetitan/anvil2';
+import { Announcement, Page as Anvil2Page, Button, Popover, TextField } from '@servicetitan/anvil2';
 import SvgSearch from '@servicetitan/anvil2/assets/icons/material/round/search.svg';
 import SvgAtlas from '@servicetitan/anvil2/assets/icons/st/atlas_logo.svg';
 import SvgSettingsActive from '@servicetitan/anvil2/assets/icons/st/gnav_settings_active.svg';
@@ -20,11 +20,28 @@ import { SideNavigationLinkWrapperProps } from '../left-navigation';
 import { HeaderNavigationLink, HeaderNavigationTrigger } from '../links';
 import { ProfileDropdown, TitanLayout, TitanLayoutProps, TitanLayoutState } from './';
 
+interface LayoutContentArgs {
+    header: boolean;
+    sideTop: boolean;
+    extraText: boolean;
+    search: boolean;
+    longContent: boolean;
+    wideContent: boolean;
+}
+
 export default {
     title: 'Navigation/TitanLayout',
-    component: TitanLayout,
     decorators: [withDefaultRedirects, withMemoryRouter, withAnvil],
     parameters: {},
+    argTypes: {},
+    args: {
+        header: true,
+        sideTop: true,
+        extraText: true,
+        search: true,
+        longContent: true,
+        wideContent: false,
+    } as LayoutContentArgs,
 };
 
 const mainNavItems = [
@@ -131,9 +148,9 @@ const SideLinkPopoverWrapper: FC<SideNavigationLinkWrapperProps> = ({ children,
 };
 
 const sidebarTop = () => [
-    <TitanLayout.SidebarLink key="tasks" {...items.tasks} />,
-    <TitanLayout.SidebarLink key="calls" {...items.calls} />,
-    <TitanLayout.SidebarTrigger
+    <TitanLayout.Link key="tasks" {...items.tasks} />,
+    <TitanLayout.Link key="calls" {...items.calls} />,
+    <TitanLayout.Trigger
         key="marketing"
         {...items.marketing}
         isActive={false}
@@ -142,51 +159,172 @@ const sidebarTop = () => [
         counter={50}
     />,
 ];
-const useLayoutProps = (): TitanLayoutProps => {
+const ContentHeader = () => {
+    const [longInfo, setLongInfo] = useState(false);
+
+    return (
+        <Fragment>
+            <Announcement title="Some info" status="info" />
+            <Announcement title="Some warning" status="warning" />
+            <div
+                className="d-f justify-content-center align-items-center bg-purple-100-i"
+                style={{ height: longInfo ? '120px' : '48px' }}
+            >
+                <div className="d-f align-items-center gap-1">
+                    custom content{' '}
+                    <Button onClick={() => setLongInfo(!longInfo)} size="small" aria-label="test">
+                        {longInfo ? '↑' : '↓'}
+                    </Button>
+                </div>
+            </div>
+        </Fragment>
+    );
+};
+const SearchBar = () => <TextField size="small" placeholder="Search" className="w-100-i" />;
+
+const useLayoutProps = (args: LayoutContentArgs): TitanLayoutProps => {
     const [state, setState] = useState<TitanLayoutState | undefined>(undefined);
 
     return {
         state,
         onStateChange: setState,
 
+        navigationComponent: NavLinkMock,
         navigationMainItems: mainNavItems,
+
         profile,
+        top: args.search ? <SearchBar /> : undefined,
+        header: args.header ? <ContentHeader /> : undefined,
+
         extraLinks,
         extraLinksTop,
+        extraText: args.extraText ? 'EST (-8 hrs)' : undefined,
 
-        sidebarTop: sidebarTop(),
-        navigationComponent: NavLinkMock,
-        extraText: 'EST (-8 hrs)',
+        sideTop: args.sideTop ? sidebarTop() : undefined,
     };
 };
 
-export const TitanLayoutLegacy = () => (
-    <TitanLayout {...useLayoutProps()} appearance="legacy">
+const Content = (args: LayoutContentArgs) => {
+    return (
+        <Fragment>
+            <LocationInfo />
+            {args.wideContent && (
+                <div style={{ width: '1200px' }}>
+                    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+                    incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
+                    nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
+                    Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
+                    fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
+                    culpa qui officia deserunt mollit anim id est laborum.
+                </div>
+            )}
+
+            {args.longContent && (
+                <div>
+                    <p>Lorem</p>
+                    <p>ipsum</p>
+                    <p>dolor</p>
+                    <p>sit</p>
+                    <p>amet,</p>
+                    <p>consectetur</p>
+                    <p>adipiscing</p>
+                    <p>elit,</p>
+                    <p>sed</p>
+                    <p>do</p>
+                    <p>eiusmod</p>
+                    <p>tempor</p>
+                    <p>incididunt</p>
+                    <p>ut</p>
+                    <p>labore</p>
+                    <p>et</p>
+                    <p>dolore</p>
+                    <p>magna</p>
+                    <p>aliqua.</p>
+                    <p>Ut</p>
+                    <p>enim</p>
+                    <p>ad</p>
+                    <p>minim</p>
+                    <p>veniam,</p>
+                    <p>quis</p>
+                    <p>nostrud</p>
+                    <p>exercitation</p>
+                    <p>ullamco</p>
+                    <p>laboris</p>
+                    <p>nisi</p>
+                    <p>ut</p>
+                    <p>aliquip</p>
+                    <p>ex</p>
+                    <p>ea</p>
+                    <p>commodo</p>
+                    <p>consequat.</p>
+                    <p>Duis</p>
+                    <p>aute</p>
+                    <p>irure</p>
+                    <p>dolor</p>
+                    <p>in</p>
+                    <p>reprehenderit</p>
+                    <p>in</p>
+                    <p>voluptate</p>
+                    <p>velit</p>
+                    <p>esse</p>
+                    <p>cillum</p>
+                    <p>dolore</p>
+                    <p>eu</p>
+                    <p>fugiat</p>
+                    <p>nulla</p>
+                    <p>pariatur.</p>
+                    <p>Excepteur</p>
+                    <p>sint</p>
+                    <p>occaecat</p>
+                    <p>cupidatat</p>
+                    <p>non</p>
+                    <p>proident,</p>
+                    <p>sunt</p>
+                    <p>in</p>
+                    <p>culpa</p>
+                    <p>qui</p>
+                    <p>officia</p>
+                    <p>deserunt</p>
+                    <p>mollit</p>
+                    <p>anim</p>
+                    <p>id</p>
+                    <p>est</p>
+                    <p>laborum.</p>
+                </div>
+            )}
+        </Fragment>
+    );
+};
+
+export const TitanLayoutLegacy = (args: LayoutContentArgs) => (
+    <TitanLayout {...useLayoutProps(args)} appearance="legacy">
         <TitanLayout.Logo title />
         <TitanLayout.Content>
-            <LocationInfo />
+            <div className="p-3">
+                <Content {...args} />
+            </div>
         </TitanLayout.Content>
     </TitanLayout>
 );
 
-export const TitanLayoutAnvil1 = () => (
-    <TitanLayout {...useLayoutProps()} appearance="anvil1">
+export const TitanLayoutAnvil1 = (args: LayoutContentArgs) => (
+    <TitanLayout {...useLayoutProps(args)} appearance="anvil1">
         <TitanLayout.Logo title />
         <TitanLayout.Content>
             <Anvil1Page>
-                <LocationInfo />
+                <Content {...args} />
             </Anvil1Page>
         </TitanLayout.Content>
     </TitanLayout>
 );
 
-export const TitanLayoutAnvil2 = () => (
-    <TitanLayout {...useLayoutProps()} appearance="anvil2">
+export const TitanLayoutAnvil2 = (args: LayoutContentArgs) => (
+    <TitanLayout {...useLayoutProps(args)} appearance="anvil2">
         <TitanLayout.Logo title />
         <TitanLayout.Content>
             <Anvil2Page>
                 <Anvil2Page.Content>
-                    <LocationInfo />
+                    <Content {...args} />
                 </Anvil2Page.Content>
             </Anvil2Page>
         </TitanLayout.Content>

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

@@ -11,6 +11,7 @@ import {
     useCallback,
     useEffect,
     useMemo,
+    useRef,
     useState,
 } from 'react';
 import { NavigationItemData } from '../../utils/navigation';
@@ -50,11 +51,13 @@ export type TitanLayoutProps = Omit<ComponentPropsWithoutRef<'div'>, 'children'
     onStateChange?: (state: TitanLayoutState) => void;
 
     header?: ReactElement;
+    top?: ReactElement;
+    sideTop?: ReactElement[];
     profile?: ReactElement;
     extraLinks?: ReactElement;
     extraLinksTop?: ReactElement;
     extraText?: string;
-    sidebarTop?: ReactElement[];
+    minContentWidth?: number;
 };
 
 const defaultSidebarContext: TitanLayoutSidebarContextType = {
@@ -115,6 +118,7 @@ const TitanLayoutComponent: FC<TitanLayoutProps> = ({
     children,
     navigationComponent,
     header,
+    top,
     profile,
     state,
     onStateChange,
@@ -122,7 +126,8 @@ const TitanLayoutComponent: FC<TitanLayoutProps> = ({
     extraLinks,
     extraLinksTop,
     extraText,
-    sidebarTop,
+    minContentWidth,
+    sideTop,
 }) => {
     const breakpoint = useTitanBreakpoint();
     const isMobile = breakpoint.isMobile;
@@ -154,6 +159,13 @@ const TitanLayoutComponent: FC<TitanLayoutProps> = ({
         return () => document.removeEventListener('click', listener);
     }, [isMobile]);
 
+    useEffect(() => {
+        if (variant.isAnvil1) {
+            document.body.classList.add('of-hidden-i');
+            return () => document.body.classList.remove('of-hidden');
+        }
+    }, [variant.isAnvil1]);
+
     const onBurgerClick = useCallback((e: MouseEvent) => {
         setMobileDrawerOpened(true);
         e.stopPropagation();
@@ -179,8 +191,6 @@ const TitanLayoutComponent: FC<TitanLayoutProps> = ({
         [state, onStateChange]
     );
 
-    const [layoutStyles] = useState<object>({});
-
     const layoutClass = variant.isLegacy
         ? Styles.layoutLegacy
         : variant.isAnvil1
@@ -194,21 +204,19 @@ const TitanLayoutComponent: FC<TitanLayoutProps> = ({
                     id={id}
                     className={classNames(
                         Styles.layout,
-                        isMobile
-                            ? Styles.layoutMobile
-                            : state?.navCollapsed
-                              ? Styles.layoutNavSlim
-                              : Styles.layoutNavWide,
+                        isMobile ? Styles.layoutMobile : Styles.layoutDesktop,
+                        !isMobile && state?.navCollapsed
+                            ? Styles.layoutNavSlim
+                            : Styles.layoutNavWide,
                         layoutClass
                     )}
-                    style={layoutStyles}
                 >
                     {variant.isSequent && <div className={Styles.topPlaceholder} />}
                     <LayoutHeader
                         className={Styles.top}
                         logo={logo}
                         profile={isMobile ? undefined : profile}
-                        center={header}
+                        center={top}
                         rightText={isMobile ? undefined : extraText}
                         right={
                             <Fragment>
@@ -226,7 +234,7 @@ const TitanLayoutComponent: FC<TitanLayoutProps> = ({
                         submenuExpanded={state?.submenuExpanded}
                         onBarExpandChange={onBarExpandChange}
                         onSubmenuExpandChange={onSubmenuExpandChange}
-                        top={sidebarTop}
+                        top={sideTop}
                         mainItems={navigationMainItems}
                         navigationComponent={context.NavigationComponent}
                         bottom={
@@ -250,23 +258,98 @@ const TitanLayoutComponent: FC<TitanLayoutProps> = ({
                         }
                     />
 
-                    {content}
+                    <LayoutContent
+                        header={header}
+                        anvil2={variant.isAnvil2}
+                        anvil1={variant.isAnvil1}
+                        minWidth={minContentWidth}
+                    >
+                        {content}
+                    </LayoutContent>
                 </div>
             </LayoutPlacementContext.Provider>
         </LayoutContext.Provider>
     );
 };
 
+const TitanLayoutHeaderObserved: FC<{
+    children: ReactNode;
+    heightChange?(value: number): void;
+}> = ({ children, heightChange }) => {
+    const ref = useRef<HTMLDivElement>(null);
+
+    useEffect(() => {
+        if (ref.current) {
+            const updatePosition = () => {
+                if (ref.current && heightChange) {
+                    const pos = ref.current.getBoundingClientRect();
+                    heightChange(pos.height);
+                }
+            };
+
+            const observer = new ResizeObserver(updatePosition);
+            observer.observe(ref.current);
+
+            updatePosition();
+            return () => observer.disconnect();
+        }
+    }, [heightChange]);
+
+    useEffect(() => {
+        return () => {
+            heightChange?.(0);
+        };
+    }, [heightChange]);
+    return (
+        <div ref={ref} className={Styles.header}>
+            {children}
+        </div>
+    );
+};
+
 export interface TitanLayoutContentProps {
     children: ReactNode;
 }
-const TitanLayoutContent: FC<TitanLayoutContentProps> = ({ children }) => (
-    <div className={Styles.content}>{children}</div>
-);
+const TitanLayoutContent: FC<TitanLayoutContentProps> = ({ children }) => children;
+
+const LayoutContent: FC<{
+    children: ReactNode;
+    header?: ReactNode;
+    anvil1: boolean;
+    anvil2: boolean;
+    minWidth: number | undefined;
+}> = ({ anvil1, anvil2, children, header }) => {
+    const [anvil2Styles, setAnvil2Styles] = useState<object>({});
+    const updateIndicatorsHeight = useCallback((offset: number) => {
+        setAnvil2Styles({ '--offset': `calc(var(--nav-offset-top) + ${offset}px)` });
+    }, []);
+
+    return (
+        <Fragment>
+            {!!header &&
+                (anvil2 ? (
+                    <TitanLayoutHeaderObserved heightChange={updateIndicatorsHeight}>
+                        {header}
+                    </TitanLayoutHeaderObserved>
+                ) : (
+                    <div className={Styles.header}>{header}</div>
+                ))}
+            <div className={Styles.content} style={anvil2Styles} data-cy="layout-content">
+                {anvil1 ? (
+                    <div className="position-relative d-f flex-grow-1 flex-basis-0 of-hidden">
+                        {children}
+                    </div>
+                ) : (
+                    children
+                )}
+            </div>
+        </Fragment>
+    );
+};
 
 export const TitanLayout = Object.assign(TitanLayoutComponent, {
     Content: TitanLayoutContent,
     Logo: TitanLayoutLogo,
-    SidebarLink: TitanLayoutSidebarLink,
-    SidebarTrigger: TitanLayoutSidebarTrigger,
+    Link: TitanLayoutSidebarLink,
+    Trigger: TitanLayoutSidebarTrigger,
 });