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

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
+    );
+};

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

@@ -0,0 +1,154 @@
+/* stylelint-disable no-descending-specificity */
+@import (reference) '@servicetitan/tokens/core/tokens.less';
+
+@size-links-tiny: 24px;
+
+.header {
+    display: grid;
+
+    background-color: @color-white;
+    color: @color-black;
+    border-bottom: 1px solid @color-neutral-60;
+
+    & > * {
+        overflow-y: hidden;
+    }
+
+    .he-top-left {
+        grid-column: span 1;
+        display: flex;
+        align-items: center;
+    }
+
+    .he-top-center {
+        grid-column: span 1;
+    }
+
+    .he-top-right {
+        grid-column: span 1;
+
+        & > * {
+            color: @color-black;
+        }
+
+        .he-top-right-text {
+            font-size: @typescale-2;
+            font-weight: @font-weight-bold;
+            font-family: @base-font-family;
+            margin-right: @spacing-1;
+        }
+    }
+
+    :global(.profile-dropdown-image) {
+        height: 24px;
+        width: 24px;
+    }
+
+    :global(.profile-dropdown-trigger) {
+        height: 32px;
+        font-size: @size-links-tiny;
+    }
+
+    .navigation-link {
+        border-radius: 12px;
+        font-size: @size-links-tiny;
+        color: inherit;
+
+        &.navigation-item-active:not(.navigation-item-overflow) {
+            background-color: @color-blue-100 !important;
+            color: @color-blue-500 !important;
+        }
+        &:hover:not(.navigation-item-active):not(.navigation-item-overflow) {
+            background-color: rgba(0, 0, 0, 0.12) !important;
+        }
+
+        &.navigation-item-icon-state.navigation-item-active {
+            .navigation-icon:not(.navigation-icon-active) {
+                display: none;
+            }
+
+            .navigation-icon.navigation-icon-active[data-anv][data-anv] {
+                display: block;
+            }
+        }
+    }
+
+    .navigation-icon[data-anv][data-anv] {
+        display: inline-block;
+        color: inherit;
+        height: 24px;
+        width: 24px;
+
+        > svg {
+            height: @size-links-tiny;
+            width: @size-links-tiny;
+        }
+
+        &.navigation-icon-active {
+            display: none;
+        }
+    }
+}
+
+// desktop
+@media only screen and (min-width: 768px) {
+    .header {
+        grid-template-columns: repeat(3, 1fr);
+        grid-template-rows: 48px;
+
+        .navigation-link {
+            margin: 6px 2px;
+            padding: 6px 6px;
+        }
+    }
+
+    .he-top-left {
+        padding-left: @spacing-1;
+    }
+}
+
+// mobile
+@media only screen and (max-width: 768px) {
+    .header {
+        grid-template-columns: repeat(3, 1fr);
+        grid-template-rows: 44px;
+
+        padding: @spacing-1 @spacing-half;
+
+        .navigation-link {
+            padding: 10px;
+        }
+    }
+}
+
+.navigation-link {
+    // styles specific to extra nav links
+    color: @color-black;
+    position: relative;
+    display: flex;
+    align-items: center;
+    flex-wrap: nowrap;
+    text-wrap: nowrap;
+
+    .navigation-item-counter {
+        color: @color-white;
+        font-weight: @font-weight-semibold;
+        font-size: 8px !important;
+        min-width: 12px;
+        position: absolute;
+        top: 4px;
+        right: -2px;
+    }
+
+    .navigation-item-label {
+        color: inherit;
+        font-size: @typescale-1;
+        font-family: @base-font-family;
+        font-weight: @font-weight-semibold;
+        margin-left: @spacing-half;
+    }
+
+    &.navigation-item-counter-long {
+        right: -8px;
+    }
+}

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

@@ -0,0 +1,16 @@
+export const __esModule: true;
+export const heTopCenter: string;
+export const heTopLeft: string;
+export const heTopRight: string;
+export const heTopRightText: string;
+export const header: string;
+export const navigationIcon: string;
+export const navigationIconActive: string;
+export const navigationItemActive: string;
+export const navigationItemCounter: string;
+export const navigationItemCounterLong: string;
+export const navigationItemIconState: string;
+export const navigationItemLabel: string;
+export const navigationItemOverflow: string;
+export const navigationLink: string;
+

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

@@ -0,0 +1,86 @@
+import SvgBurgerMenu from '@servicetitan/anvil2/assets/icons/material/round/menu.svg';
+import classNames from 'classnames';
+import { ComponentPropsWithoutRef, FC, ReactElement, ReactNode } from 'react';
+import { LayoutPlacementContext, useTitanLayoutContext } from './layout-context';
+import { LayoutHeaderNavigationTrigger } from './layout-header-links';
+import * as Styles from './layout-header.module.less';
+import { TitanLayoutLogoProps } from './layout-logo';
+
+export interface TitanLayoutHeaderLogoProps {
+    title?: true | string;
+    mantleFill?: string;
+    to?: string;
+}
+
+export type LayoutHeaderProps = Omit<ComponentPropsWithoutRef<'div'>, 'children'> & {
+    right?: ReactNode;
+    rightText?: string;
+    rightClassName?: string;
+
+    id?: string;
+
+    center?: ReactElement;
+    centerClassName?: string;
+
+    logo: ReactElement<TitanLayoutLogoProps>;
+    profile?: ReactElement;
+
+    onBurgerClick?: (e: MouseEvent) => void;
+};
+
+export const LayoutHeader: FC<LayoutHeaderProps> = ({
+    className,
+    right,
+    rightText,
+    rightClassName,
+    center,
+    centerClassName,
+    logo,
+    profile,
+    onBurgerClick,
+    ...rest
+}) => {
+    const { breakpoint } = useTitanLayoutContext();
+
+    return (
+        <LayoutPlacementContext.Provider value="top">
+            <div
+                className={classNames(Styles.header, className)}
+                {...rest}
+                data-cy="header-navigation"
+            >
+                <div className={classNames(Styles.heTopLeft)} data-cy="navigation-left">
+                    {breakpoint.isMobile && (
+                        <LayoutHeaderNavigationTrigger
+                            id="burger"
+                            title=""
+                            icon={SvgBurgerMenu}
+                            iconActive={SvgBurgerMenu}
+                            className="m-r-1"
+                            onClick={onBurgerClick}
+                        />
+                    )}
+                    {logo}
+                </div>
+                <div
+                    className={classNames(Styles.heTopCenter, centerClassName)}
+                    data-cy="navigation-center"
+                >
+                    {center}
+                </div>
+                <div
+                    className={classNames(
+                        'd-f flex-row justify-content-end align-items-center',
+                        Styles.heTopRight,
+                        rightClassName
+                    )}
+                    data-cy="navigation-right"
+                >
+                    {!!rightText && <div className={Styles.heTopRightText}>{rightText}</div>}
+                    {right}
+                    {profile}
+                </div>
+            </div>
+        </LayoutPlacementContext.Provider>
+    );
+};

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

@@ -0,0 +1,31 @@
+import { Chip } from '@servicetitan/anvil2';
+import { ReactElement } from 'react';
+import { withAnvil, withDefaultRedirects, withMemoryRouter } from '../../test/data';
+import { TitanLayoutLogo, TitanLayoutLogoProps } from './layout-logo';
+import { TitanLayout } from './titan-layout';
+
+const withTitanLayout = (element: ReactElement<TitanLayoutLogoProps>) => () => (
+    <TitanLayout navigationMainItems={[]}>
+        {element}
+        <TitanLayout.Content>logo</TitanLayout.Content>
+    </TitanLayout>
+);
+
+export default {
+    title: 'Navigation/TitanLayoutLogo',
+    component: TitanLayoutLogo,
+    decorators: [withDefaultRedirects, withMemoryRouter, withAnvil],
+    parameters: {},
+};
+
+export const LogoDefault = withTitanLayout(<TitanLayoutLogo />);
+
+export const LogoCompanyTitle = withTitanLayout(<TitanLayoutLogo title />);
+
+export const LogoCommercial = withTitanLayout(
+    <TitanLayoutLogo title="Commercial" mantleFill="#2270EE" />
+);
+
+export const LogoWithPostfix = withTitanLayout(
+    <TitanLayoutLogo title postfix={<Chip className="m-l-2-i" label="demo" />} />
+);

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

@@ -0,0 +1,57 @@
+import classNames from 'classnames';
+import { FC, Fragment, ReactNode } from 'react';
+import { LogoCompanyTitle } from '../logo/logo-company-title';
+import { LogoTitan, LogoTitanTitle, WrapperProps } from '../logo/logo-titan-text';
+import { useTitanLayoutContext } from './layout-context';
+
+export interface TitanLayoutLogoProps {
+    /** container class name */
+    className?: string;
+
+    title?: string | boolean;
+
+    postfix?: ReactNode;
+
+    logoWrapper?: WrapperProps;
+
+    mantleFill?: string;
+}
+
+const EmptyWrapper: FC<any> = ({ children }) => children;
+
+export const TitanLayoutLogo: FC<TitanLayoutLogoProps> = ({
+    className,
+    mantleFill,
+    postfix,
+    title,
+    logoWrapper = EmptyWrapper,
+}) => {
+    const {
+        breakpoint: { isMobile },
+    } = useTitanLayoutContext();
+
+    const Wrapper = logoWrapper;
+    const logoSize = isMobile ? 44 : 56;
+    const logoCompanySize = 48;
+
+    return (
+        <div className={classNames('d-f align-items-center', className)}>
+            {typeof title === 'string' ? (
+                <Fragment>
+                    <LogoTitan size={logoSize} mantleFill={mantleFill} logoWrapper={Wrapper} />
+                    {!isMobile && (
+                        <LogoTitanTitle className="c-inherit m-l-1">{title}</LogoTitanTitle>
+                    )}
+                </Fragment>
+            ) : title === true && !isMobile ? (
+                <Wrapper className="">
+                    <LogoCompanyTitle height={logoCompanySize} />
+                </Wrapper>
+            ) : (
+                <LogoTitan size={logoSize} mantleFill={mantleFill} logoWrapper={Wrapper} />
+            )}
+
+            {!isMobile && postfix}
+        </div>
+    );
+};

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

@@ -0,0 +1,37 @@
+import { ReactElement } from 'react';
+import { withAnvil, withDefaultRedirects, withMemoryRouter } from '../../test/data';
+import { ProfileDropdown } from './layout-profile';
+import { TitanLayout } from './titan-layout';
+
+const withTitanLayout = (element: ReactElement) => () => (
+    <TitanLayout navigationMainItems={[]} profile={element}>
+        <TitanLayout.Content>profile</TitanLayout.Content>
+    </TitanLayout>
+);
+
+export default {
+    title: 'Navigation/TitanLayoutProfile',
+    component: ProfileDropdown,
+    decorators: [withDefaultRedirects, withMemoryRouter, withAnvil],
+    parameters: {},
+};
+
+export const ProfileDefault = withTitanLayout(
+    <ProfileDropdown>
+        <ProfileDropdown.Link id="first" to="https://google.com">
+            first link
+        </ProfileDropdown.Link>
+        <ProfileDropdown.Section id="second" onClick={() => alert('second click')}>
+            second link
+        </ProfileDropdown.Section>
+        <ProfileDropdown.Divider />
+        <ProfileDropdown.Section id="content">some content</ProfileDropdown.Section>
+        <ProfileDropdown.Divider />
+        <ProfileDropdown.Divider />
+        <ProfileDropdown.Divider />
+        <ProfileDropdown.Link id="third" to="third">
+            third link
+        </ProfileDropdown.Link>
+        <ProfileDropdown.Divider />
+    </ProfileDropdown>
+);

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

@@ -0,0 +1,116 @@
+import SvgAccountActive from '@servicetitan/anvil2/assets/icons/st/gnav_account_active.svg';
+import SvgAccountInactive from '@servicetitan/anvil2/assets/icons/st/gnav_account_inactive.svg';
+
+import { FC, useState } from 'react';
+import { NavigationComponentContext } from '../../utils/navigation-context';
+import {
+    ProfileDropdown as DesktopProfileDropdown,
+    ProfileDropdownLinkProps,
+    ProfileDropdownProps,
+    ProfileDropdownSectionProps,
+} from '../profile-dropdown/profile-dropdown';
+import { NavigationComponentProps } from './interface-internal';
+import { useTitanLayoutContext } from './layout-context';
+import {
+    InternalSideNavigationGroup,
+    InternalSideNavigationGroupDivider,
+    InternalSideNavigationGroupLink,
+    InternalSideNavigationGroupTrigger,
+} from './layout-sidebar-links-internal';
+
+export type {
+    ProfileDropdownProps,
+    ProfileDropdownSectionProps,
+    ProfileDropdownLinkProps,
+} from '../profile-dropdown/profile-dropdown';
+
+const ProfileDropdownContent: FC<ProfileDropdownProps> = props => {
+    const { breakpoint, NavigationComponent } = useTitanLayoutContext();
+    return breakpoint.isMobile ? (
+        <MobileProfileDropdown {...props} navigationComponent={NavigationComponent} />
+    ) : (
+        <NavigationComponentContext.Provider value={NavigationComponent}>
+            <DesktopProfileDropdown {...props} />
+        </NavigationComponentContext.Provider>
+    );
+};
+ProfileDropdownContent.displayName = 'ProfileDropdown';
+
+const MobileProfileDropdown: FC<ProfileDropdownProps & NavigationComponentProps> = ({
+    children,
+    ...props
+}) => {
+    const [expanded, setExpanded] = useState(false);
+    const onExpandToggle = () => setExpanded(!expanded);
+    return (
+        <InternalSideNavigationGroup
+            id="__profile"
+            to={undefined}
+            title="Profile"
+            icon={SvgAccountInactive}
+            iconActive={SvgAccountActive}
+            isActive={expanded}
+            {...props}
+            submenuExpanded={expanded}
+            onExpandToggle={onExpandToggle}
+            onClick={onExpandToggle}
+            tag={undefined}
+        >
+            {children}
+        </InternalSideNavigationGroup>
+    );
+};
+
+const ProfileDropdownDivider: FC = () => {
+    const { breakpoint } = useTitanLayoutContext();
+    return breakpoint.isMobile ? (
+        <InternalSideNavigationGroupDivider />
+    ) : (
+        <DesktopProfileDropdown.Divider />
+    );
+};
+
+const ProfileDropdownSection: FC<ProfileDropdownSectionProps> = props => {
+    const { breakpoint } = useTitanLayoutContext();
+    return breakpoint.isMobile ? (
+        <MobileProfileDropdownSection {...props} />
+    ) : (
+        <DesktopProfileDropdown.Section {...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} />
+    ) : null;
+};
+
+const ProfileDropdownLink: FC<ProfileDropdownLinkProps> = props => {
+    const { breakpoint, NavigationComponent } = useTitanLayoutContext();
+    return breakpoint.isMobile ? (
+        <MobileProfileDropdownLink {...props} navigationComponent={NavigationComponent} />
+    ) : (
+        <DesktopProfileDropdown.Link {...props} />
+    );
+};
+const MobileProfileDropdownLink: FC<ProfileDropdownLinkProps & NavigationComponentProps> = ({
+    to,
+    navigationComponent,
+    ...props
+}) => {
+    const title = typeof props.children === 'string' ? props.children : undefined;
+    return title ? (
+        <InternalSideNavigationGroupLink
+            {...props}
+            to={to}
+            title={title}
+            navigationComponent={navigationComponent}
+        />
+    ) : null;
+};
+
+export const ProfileDropdown = Object.assign(ProfileDropdownContent, {
+    Divider: ProfileDropdownDivider,
+    Link: ProfileDropdownLink,
+    Section: ProfileDropdownSection,
+});