@dnanpm/styleguide 3.1.0 → 3.3.0

package/build/es/components/MainHeaderNavigation/MainHeaderNavigation.js

@@ -0,0 +1,315 @@
+import { Close, Menu } from '@dnanpm/icons';
+import { prop, indexBy } from 'ramda';
+import React__default, { useRef, useMemo, useState, useEffect } from 'react';
+import useScrollPosition from '../../hooks/useScrollPosition.js';
+import useWindowSize from '../../hooks/useWindowSize.js';
+import styled, { createGlobalStyle, keyframes } from '../../themes/styled.js';
+import theme from '../../themes/theme.js';
+import { navMaxHeight, headerLogoSize, navIconSize } from '../../themes/themeComponents/navigation.js';
+import { getMultipliedSize } from '../../utils/styledUtils.js';
+import DnaLogo from '../DnaLogo/DnaLogo.js';
+import Icon from '../Icon/Icon.js';
+import Notification from '../Notification/Notification.js';
+import BusinessMenu from './ChildComponents/BusinessMenu.js';
+import DesktopMenu from './ChildComponents/DesktopMenu.js';
+import LanguageSelector from './ChildComponents/LanguageSelector.js';
+import LoginTooltip from './ChildComponents/LoginTooltip.js';
+import { IconContainer } from './ChildComponents/MainNavTooltipMenu.js';
+import MinicartTooltip from './ChildComponents/MinicartTooltip.js';
+import RenderMobileMenu from './ChildComponents/MobileMenu.js';
+import PageSearch from './ChildComponents/PageSearch.js';
+import NavContext from './context/NavContext.js';
+import { LogoLink, DesktopMenuContainer, HeaderIconContainer, MobileMenuButton } from './globalNavStyles.js';
+
+const GlobalStyle = createGlobalStyle `
+    body.overflow-hidden {
+        overflow: hidden;
+    }
+`;
+// detect common touch screen devices
+const isIosDevice = () => {
+    const validate = /iPad|iPhone|iPod|iPad Simulator|iPhone Simulator/i;
+    if (typeof navigator !== 'undefined' && typeof window !== 'undefined') {
+        return (validate.test(navigator.userAgent) &&
+            !window.MSStream);
+    }
+    return false;
+};
+const iosDevice = isIosDevice();
+const fadeIn = keyframes `
+    0% {
+        opacity: 0;
+        transform: translateY(-5px);
+    }
+    5% {
+        opacity: 0;
+        transform: translateY(-5px);
+    }
+    100% {
+        opacity: 1;
+        transform: translateY(0px);
+    }
+`;
+const preventBodyScroll = () => {
+    const { scrollY } = window;
+    document.body.style.position = 'fixed';
+    document.body.style.top = `-${scrollY}px`;
+};
+const resumeBodyScroll = () => {
+    const scrollY = document.body.style.top;
+    document.body.style.position = '';
+    document.body.style.top = '';
+    // if the call to close overlay is done multiple times, scroll only the first time
+    if (scrollY) {
+        setTimeout(() => {
+            window.scrollTo(0, parseInt(scrollY, 10) * -1);
+        });
+    }
+};
+const PageOverlay = styled.div `
+    position: fixed;
+    animation: ${fadeIn} 0.2s ease-in-out;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    background: ${theme.color.background.plum.default + theme.color.transparency.T10};
+    z-index: ${({ navZIndex }) => navZIndex - 1};
+`;
+const scrollThreshold = 82;
+const checkThreshold = (prevPos, currPos) => {
+    if (prevPos >= currPos) {
+        return prevPos - currPos > scrollThreshold;
+    }
+    return currPos - prevPos > scrollThreshold;
+};
+const GlobalNavigationContainer = styled.header `
+    z-index: ${({ navZIndex }) => navZIndex};
+    position: sticky;
+    top: 0;
+    left: 0;
+    right: 0;
+    width: 100%;
+    background-color: ${theme.color.background.white.default};
+    color: ${theme.color.text.black};
+    max-width: 2560px;
+    margin: 0 auto;
+    > nav {
+        background-color: ${theme.color.background.plum.E02};
+    }
+`;
+const NavigationWrapper = styled.div `
+    display: flex;
+    width: 100%;
+    max-width: ${getMultipliedSize(theme.base.baseWidth, 256)};
+    margin: 0 auto;
+    height: ${navMaxHeight};
+    position: relative;
+    flex-wrap: nowrap;
+    gap: 0;
+    background-color: ${theme.color.background.white.default};
+    border-bottom: 1px solid ${theme.color.line.L04};
+    @media (min-width: ${p => p.collapseSize + 1}px) {
+        flex-wrap: nowrap;
+        gap: 0 ${getMultipliedSize(theme.base.baseWidth, 1.5)};
+    }
+`;
+let previousValue = false;
+const isStickySupported = typeof CSS !== 'undefined' &&
+    typeof CSS.supports !== 'undefined' &&
+    (CSS.supports('position', 'sticky') || CSS.supports('position', '-webkit-sticky'));
+const initiateScrollToHeader = (componentRef) => {
+    if ((componentRef === null || componentRef === void 0 ? void 0 : componentRef.current) && isStickySupported && typeof window !== 'undefined') {
+        window.scrollTo({ top: componentRef.current.offsetTop, left: 0 });
+    }
+};
+/** @visibleName MainHeaderNavigation */
+const MainHeaderNavigation = ({ businessMenuAriaLabel = 'Sivustot', categoryCollectionText = 'Muut kategoriat', className, collapseSize = 767, currentUrl = '', isLoggedIn = false, items = {}, language = 'fi', languageSelector = false, languageSelectorText = 'Vaihda kieltä', login = true, loginComponent, loginText = 'Kirjaudu', mainMenuAriaLabel = 'Päänavigaatio', minicart = true, minicartAmount = 0, minicartComponent = false, minicartText = 'Ostoskori', nextJSLinkComponent = false, notificationText = '', search = true, searchComponent = false, searchText = 'Haku', showLoginTooltip = false, showMinicart = false, zIndex = 1030, }) => {
+    var _a, _b, _c;
+    const { isMobile } = useWindowSize(collapseSize);
+    const navigationEl = useRef(null);
+    const key = prop('id');
+    // Index & memoize menu levels
+    const level1 = useMemo(() => { var _a, _b; return (_b = (_a = items.mainNavigation) === null || _a === void 0 ? void 0 : _a.pages) !== null && _b !== void 0 ? _b : []; }, [items.mainNavigation]);
+    const level1Items = useMemo(() => indexBy(key, level1), [level1, key]);
+    const level2 = useMemo(() => level1.map(item => indexBy(key, item.pages)), [level1, key]);
+    const level2Items = Object.assign({}, ...level2);
+    // All states to for handling menus
+    const [isMobileMenuOpen, setIsMobileMenuOpen] = useState(false);
+    const [menuLevel, setMenuLevel] = useState({
+        level1: null,
+        animate1: true,
+        level2: null,
+        animate2: true,
+        level1Mobile: null,
+        level2Mobile: null,
+        scrollPosition: 0,
+        hideOnScroll: false,
+    });
+    const [lang] = useState(language);
+    // As scroll position cannot be always retained, close mobile menu when orientation changes
+    const initRotation = () => {
+        setIsMobileMenuOpen(false);
+    };
+    useEffect(() => {
+        if (iosDevice && isMobileMenuOpen) {
+            window.addEventListener('orientationchange', initRotation, false);
+            preventBodyScroll();
+        }
+        if (iosDevice && !isMobileMenuOpen) {
+            window.removeEventListener('orientationchange', initRotation, false);
+            resumeBodyScroll();
+        }
+        return () => {
+            window.removeEventListener('orientationchange', initRotation, false);
+            resumeBodyScroll();
+        };
+    }, [isMobileMenuOpen]);
+    const [tooltipItems, setTooltipItems] = useState(useMemo(() => ({
+        minicart: false,
+        login: false,
+        search: false,
+    }), []));
+    const tooltipMenuActive = tooltipItems.minicart || tooltipItems.login || tooltipItems.search;
+    const freezeOverflow = isMobileMenuOpen || (tooltipMenuActive && isMobile);
+    const isPageOverlay = isMobileMenuOpen || tooltipMenuActive || menuLevel.level1 || menuLevel.level2;
+    useEffect(() => {
+        const bodyClasses = ['overflow-shown', 'overflow-hidden'];
+        document.body.classList.remove(...bodyClasses);
+        document.body.classList.add(bodyClasses[Number(Boolean(freezeOverflow))]);
+    }, [freezeOverflow]);
+    const navigationContext = useMemo(() => {
+        const handleNavMenuClick = (newValue, updatedLevel) => {
+            let clickedItself = false;
+            switch (updatedLevel) {
+                case 'level1':
+                    clickedItself = newValue === menuLevel.level1;
+                    setMenuLevel(Object.assign(Object.assign({}, menuLevel), { level1: !clickedItself ? newValue : null, animate1: !clickedItself, level2: null, animate2: true }));
+                    break;
+                case 'level2':
+                    clickedItself = newValue === menuLevel.level2;
+                    setMenuLevel(Object.assign(Object.assign({}, menuLevel), { level2: newValue !== menuLevel.level2 ? newValue : null, animate1: false, animate2: !clickedItself }));
+                    break;
+                case 'level1Mobile':
+                    setMenuLevel(Object.assign(Object.assign({}, menuLevel), { level1Mobile: newValue || menuLevel.level1Mobile, scrollPosition: newValue ? 1 : 0 }));
+                    break;
+                case 'level2Mobile':
+                    setMenuLevel(Object.assign(Object.assign({}, menuLevel), { level2Mobile: newValue || menuLevel.level2Mobile, scrollPosition: newValue ? 2 : 1 }));
+                    break;
+            }
+        };
+        const resetMenuEvents = () => {
+            setMenuLevel({
+                level2: null,
+                animate2: true,
+                level1: null,
+                animate1: true,
+                level1Mobile: null,
+                level2Mobile: null,
+                scrollPosition: 0,
+                hideOnScroll: false,
+            });
+            if (isMobileMenuOpen) {
+                setIsMobileMenuOpen(false);
+            }
+            setTooltipItems({
+                minicart: false,
+                login: false,
+                search: false,
+            });
+        };
+        const getBackLink = (menuElements, i) => {
+            const idValue = menuLevel[`level${i}Mobile`];
+            return menuElements[idValue];
+        };
+        // Resets menu states when menu content alters between mobile and desktop
+        const menuChanged = previousValue !== isMobile;
+        if (menuChanged) {
+            resetMenuEvents();
+            previousValue = isMobile;
+        }
+        return {
+            categoryCollectionText,
+            collapseSize,
+            currentUrl,
+            getBackLink,
+            handleNavMenuClick,
+            isLoggedIn,
+            isMobileMenu: isMobile,
+            isMobileMenuOpen,
+            items,
+            lang,
+            level1Items,
+            level2Items,
+            loginComponent,
+            menuLevel,
+            minicartComponent,
+            navZIndex: zIndex,
+            nextJSLinkComponent,
+            resetMenuEvents,
+            searchComponent,
+            setTooltipItems,
+            showLoginTooltip,
+            showMinicart,
+            tooltipItems,
+        };
+    }, [
+        categoryCollectionText,
+        collapseSize,
+        currentUrl,
+        isLoggedIn,
+        isMobile,
+        isMobileMenuOpen,
+        items,
+        lang,
+        level1Items,
+        level2Items,
+        loginComponent,
+        menuLevel,
+        minicartComponent,
+        nextJSLinkComponent,
+        searchComponent,
+        showLoginTooltip,
+        showMinicart,
+        tooltipItems,
+        zIndex,
+    ]);
+    useScrollPosition(({ prevPos, currPos }) => {
+        const overThreshold = checkThreshold(prevPos.y, currPos.y);
+        const isShow = currPos.y < prevPos.y;
+        if (isShow !== menuLevel.hideOnScroll && overThreshold && !menuLevel.level1) {
+            setMenuLevel(Object.assign(Object.assign({}, menuLevel), { animate1: false, animate2: false, hideOnScroll: isShow }));
+        }
+    }, undefined, false, 200);
+    const currentBusinessSite = (_a = items === null || items === void 0 ? void 0 : items.businessSelector) === null || _a === void 0 ? void 0 : _a.items.find(item => item.businessId === items.businessId);
+    const languagesObject = (_b = items === null || items === void 0 ? void 0 : items.languageSelector) === null || _b === void 0 ? void 0 : _b.urls;
+    const { resetMenuEvents } = navigationContext;
+    const handleToggleClick = () => {
+        resetMenuEvents();
+        initiateScrollToHeader(navigationEl);
+        setIsMobileMenuOpen(!isMobileMenuOpen);
+    };
+    return (React__default.createElement(React__default.Fragment, null,
+        isPageOverlay && React__default.createElement(PageOverlay, { "data-testid": "navigation-overlay", navZIndex: zIndex }),
+        React__default.createElement(GlobalNavigationContainer, { className: className, collapseSize: collapseSize, "data-testid": "dna-main-header", navZIndex: zIndex, ref: navigationEl, role: "banner" },
+            React__default.createElement(NavContext.Provider, { value: navigationContext },
+                React__default.createElement(GlobalStyle, null),
+                !items.mainNavigation && notificationText && (React__default.createElement(Notification, { type: "info" }, notificationText)),
+                React__default.createElement(BusinessMenu, { ariaLabel: businessMenuAriaLabel, currentBusinessId: items.businessId, items: (_c = items.businessSelector) === null || _c === void 0 ? void 0 : _c.items, lang: language }),
+                React__default.createElement(NavigationWrapper, { collapseSize: collapseSize },
+                    React__default.createElement(LogoLink, { "data-testid": "dna-logo-link", href: currentBusinessSite === null || currentBusinessSite === void 0 ? void 0 : currentBusinessSite.urls[language], title: "DNA" },
+                        React__default.createElement(DnaLogo, { size: headerLogoSize })),
+                    React__default.createElement(DesktopMenuContainer, { "aria-label": mainMenuAriaLabel, collapseSize: collapseSize },
+                        React__default.createElement(DesktopMenu, null)),
+                    React__default.createElement(HeaderIconContainer, { collapseSize: collapseSize },
+                        languagesObject && languageSelector && (React__default.createElement(LanguageSelector, { currentLanguage: language, languagesObject: languagesObject, languageSelectorLabel: languageSelectorText })),
+                        search && React__default.createElement(PageSearch, { searchLabel: searchText }),
+                        minicart && (React__default.createElement(MinicartTooltip, { minicartAmount: minicartAmount, minicartLabel: minicartText })),
+                        login && React__default.createElement(LoginTooltip, { loginLabel: loginText, isLogged: isLoggedIn }),
+                        React__default.createElement(IconContainer, { collapseSize: collapseSize, "data-testid": "header-mobile-menu-container" },
+                            React__default.createElement(MobileMenuButton, { "aria-expanded": isMobileMenuOpen, "aria-label": "menu toggle", "data-testid": "header-mobile-menu-toggle", onClick: handleToggleClick },
+                                React__default.createElement(Icon, { icon: isMobileMenuOpen ? Close : Menu, size: navIconSize })))),
+                    isMobile && React__default.createElement(RenderMobileMenu, null))))));
+};
+
+export { MainHeaderNavigation as default };

package/build/es/components/MainHeaderNavigation/context/MobileMenuContext.d.ts

@@ -0,0 +1,6 @@
+import type { RefObject } from 'react';
+interface MobileMenuContextProps {
+    mobileMenuRef: RefObject<HTMLElement> | null;
+}
+declare const MobileMenuContext: import("react").Context<MobileMenuContextProps>;
+export default MobileMenuContext;

package/build/es/components/MainHeaderNavigation/context/MobileMenuContext.js

@@ -0,0 +1,7 @@
+import { createContext } from 'react';
+
+const MobileMenuContext = createContext({
+    mobileMenuRef: null,
+});
+
+export { MobileMenuContext as default };

package/build/es/components/MainHeaderNavigation/context/NavContext.d.ts

@@ -0,0 +1,29 @@
+import type { Dispatch, ReactNode, SetStateAction } from 'react';
+import type { GlobalNavItems, MenuLevelItem, MenuStates, MenuTooltipItems, MobileMenuLevel } from '../types/globalNavProps';
+export interface NavContextProps {
+    categoryCollectionText: string;
+    collapseSize: number;
+    currentUrl: string;
+    getBackLink: (menuElements: MobileMenuLevel, i: number) => MenuLevelItem;
+    handleNavMenuClick: (id: string | null, level: string) => void;
+    isLoggedIn: boolean;
+    isMobileMenu: boolean;
+    isMobileMenuOpen: boolean;
+    items: GlobalNavItems;
+    level1Items: MobileMenuLevel;
+    level2Items: MobileMenuLevel;
+    lang: string;
+    loginComponent?: ReactNode | boolean | undefined;
+    menuLevel: MenuStates;
+    minicartComponent?: ReactNode | boolean | undefined;
+    navZIndex: number;
+    nextJSLinkComponent: ReactNode | boolean;
+    resetMenuEvents: () => void;
+    searchComponent?: ReactNode | boolean | undefined;
+    setTooltipItems: Dispatch<SetStateAction<MenuTooltipItems>>;
+    showLoginTooltip: boolean;
+    showMinicart: boolean;
+    tooltipItems: MenuTooltipItems;
+}
+declare const NavContext: import("react").Context<NavContextProps>;
+export default NavContext;

package/build/es/components/MainHeaderNavigation/context/NavContext.js

@@ -0,0 +1,52 @@
+import { createContext } from 'react';
+
+const NavContext = createContext({
+    categoryCollectionText: 'Muut kategoriat',
+    collapseSize: 767,
+    currentUrl: '',
+    getBackLink: () => ({
+        id: '',
+        pageIsLinkInDesktopNavigation: false,
+        pages: [],
+        titles: {},
+        urls: {},
+    }),
+    handleNavMenuClick: () => { },
+    isLoggedIn: false,
+    isMobileMenu: false,
+    isMobileMenuOpen: false,
+    items: {},
+    lang: 'fi',
+    level1Items: {
+        level1: { id: '', pageIsLinkInDesktopNavigation: false, pages: [], titles: {}, urls: {} },
+    },
+    level2Items: {
+        level2: { id: '', pageIsLinkInDesktopNavigation: false, pages: [], titles: {}, urls: {} },
+    },
+    loginComponent: false,
+    menuLevel: {
+        level1: null,
+        animate1: true,
+        level2: null,
+        animate2: true,
+        level1Mobile: null,
+        level2Mobile: null,
+        scrollPosition: 0,
+        hideOnScroll: false,
+    },
+    minicartComponent: undefined,
+    navZIndex: 1030,
+    nextJSLinkComponent: false,
+    resetMenuEvents: () => { },
+    searchComponent: false,
+    setTooltipItems: () => { },
+    showLoginTooltip: false,
+    showMinicart: true,
+    tooltipItems: {
+        minicart: false,
+        login: false,
+        search: false,
+    },
+});
+
+export { NavContext as default };