💄(frontend) updating the header and leftpanel for responsive

Previously we added a left panel. We now need to adapt the layout so that it becomesresponsive. We therefore add a burger menu on the left on mobile which, when clicked, deploys the left-panel over all the content.
2024-11-18 09:46:15 +01:00
parent ee937de2c4
commit 83eb33d54a
11 changed files with 223 additions and 140 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,6 +19,7 @@ and this project adheres to

 - 🏗️(yjs-server) organize yjs server #528
 - ♻️(frontend) better separation collaboration process #528
+- 💄(frontend) updating the header and leftpanel for responsive #421


 ## [1.10.0] - 2024-12-17
--- a/src/frontend/apps/e2e/tests/app-impress/header.spec.ts
+++ b/src/frontend/apps/e2e/tests/app-impress/header.spec.ts
@@ -75,29 +75,15 @@ test.describe('Header mobile', () => {
  test('it checks the header when mobile', async ({ page }) => {
    const header = page.locator('header').first();

+    await expect(header.getByLabel('Open the header menu')).toBeVisible();
+    await expect(
+      header.getByRole('link', { name: 'Docs Logo Docs' }),
+    ).toBeVisible();
    await expect(
      header.getByRole('button', {
        name: 'Les services de La Suite numérique',
      }),
    ).toBeVisible();
-
-    await expect(
-      page.getByRole('button', {
-        name: 'Logout',
-      }),
-    ).toBeHidden();
-
-    await expect(page.getByText('English')).toBeHidden();
-
-    await header.getByLabel('Open the header menu').click();
-
-    await expect(
-      page.getByRole('button', {
-        name: 'Logout',
-      }),
-    ).toBeVisible();
-
-    await expect(page.getByText('English')).toBeVisible();
  });
 });

--- a/src/frontend/apps/e2e/tests/app-impress/left-panel.spec.ts
+++ b/src/frontend/apps/e2e/tests/app-impress/left-panel.spec.ts
@@ -7,6 +7,7 @@ test.describe('Left panel desktop', () => {

  test('checks all the elements are visible', async ({ page }) => {
    await expect(page.getByTestId('left-panel-desktop')).toBeVisible();
+    await expect(page.getByTestId('left-panel-mobile')).toBeHidden();
    await expect(page.getByRole('button', { name: 'house' })).toBeVisible();
    await expect(page.getByRole('button', { name: 'New doc' })).toBeVisible();
  });
@@ -19,7 +20,29 @@ test.describe('Left panel mobile', () => {
    await page.goto('/');
  });

-  test('checks all the desktop elements are hidden', async ({ page }) => {
+  test('checks all the desktop elements are hidden and all mobile elements are visible', async ({
+    page,
+  }) => {
    await expect(page.getByTestId('left-panel-desktop')).toBeHidden();
+    await expect(page.getByTestId('left-panel-mobile')).not.toBeInViewport();
+
+    const header = page.locator('header').first();
+    const homeButton = page.getByRole('button', { name: 'house' });
+    const newDocButton = page.getByRole('button', { name: 'New doc' });
+    const languageButton = page.getByRole('combobox', { name: 'Language' });
+    const logoutButton = page.getByRole('button', { name: 'Logout' });
+
+    await expect(homeButton).not.toBeInViewport();
+    await expect(newDocButton).not.toBeInViewport();
+    await expect(languageButton).not.toBeInViewport();
+    await expect(logoutButton).not.toBeInViewport();
+
+    await header.getByLabel('Open the header menu').click();
+
+    await expect(page.getByTestId('left-panel-mobile')).toBeInViewport();
+    await expect(homeButton).toBeInViewport();
+    await expect(newDocButton).toBeInViewport();
+    await expect(languageButton).toBeInViewport();
+    await expect(logoutButton).toBeInViewport();
  });
 });
--- a/src/frontend/apps/impress/src/features/header/assets/icon-docs.svg
+++ b/src/frontend/apps/impress/src/features/header/assets/icon-docs.svg
@@ -1,31 +1,4 @@
-<svg viewBox="0 0 36 42" fill="none" xmlns="http://www.w3.org/2000/svg">
-  <g clip-path="url(#clip0_5_830)">
-    <path
-      fill-rule="evenodd"
-      clip-rule="evenodd"
-      d="M26.5706 16.681V20.756H9.59985V16.681H26.5706ZM26.5706 23.0467V27.1215H9.59985V23.0467H26.5706ZM19.5375 29.2926V33.3674H9.59985V29.2926H19.5375Z"
-      fill="#E1000F"
-    />
-    <path
-      fill-rule="evenodd"
-      clip-rule="evenodd"
-      d="M35.6982 16.7351V33.2911C35.6826 33.2845 35.667 33.2756 35.6492 33.269V37.4663C35.6492 39.8874 33.641 41.8683 31.1867 41.8683H4.461C2.00664 41.8683 -0.00146484 39.8874 -0.00146484 37.4663V4.45137C-0.00146484 2.03028 2.00664 0.0493774 4.461 0.0493774H18.723V4.45137H4.461V37.4663H31.1867V16.7351H35.6982Z"
-      fill="#000091"
-    />
-    <path
-      d="M33.9524 0.0360107H23.626C22.6794 0.0360107 21.9049 0.799997 21.9049 1.73376V11.9202C21.9049 12.854 22.6794 13.618 23.626 13.618H33.9524C34.899 13.618 35.6735 12.854 35.6735 11.9202V1.73376C35.6735 0.799997 34.899 0.0360107 33.9524 0.0360107ZM26.6378 6.40257C26.6378 7.10713 26.0613 7.67588 25.347 7.67588H24.4865V8.73697C24.4865 9.08501 24.1939 9.37362 23.8411 9.37362C23.4883 9.37362 23.1957 9.08501 23.1957 8.73697V5.12925C23.1957 4.66237 23.5829 4.28038 24.0562 4.28038H25.347C26.0613 4.28038 26.6378 4.84913 26.6378 5.55369V6.40257ZM30.9405 8.10031C30.9405 8.80488 30.364 9.37362 29.6497 9.37362H27.9286C27.6877 9.37362 27.4984 9.18687 27.4984 8.94919V4.70482C27.4984 4.46713 27.6877 4.28038 27.9286 4.28038H29.6497C30.364 4.28038 30.9405 4.84913 30.9405 5.55369V8.10031ZM34.3827 4.91704C34.3827 5.26507 34.0901 5.55369 33.7373 5.55369H33.0919V6.40257H33.7373C34.0901 6.40257 34.3827 6.69118 34.3827 7.03922C34.3827 7.38726 34.0901 7.67588 33.7373 7.67588H33.0919V8.73697C33.0919 9.08501 32.7993 9.37362 32.4465 9.37362C32.0936 9.37362 31.8011 9.08501 31.8011 8.73697V5.12925C31.8011 4.66237 32.1883 4.28038 32.6616 4.28038H33.7373C34.0901 4.28038 34.3827 4.569 34.3827 4.91704ZM24.4865 6.40257H25.347V5.55369H24.4865V6.40257ZM28.7892 8.10031H29.6497V5.55369H28.7892V8.10031Z"
-      fill="#000091"
-    />
-    <path
-      fill-rule="evenodd"
-      clip-rule="evenodd"
-      d="M35.6734 10.0666V13.6574H32.4942V10.0666H35.6734ZM25.0866 0.0441895V3.59171H21.9041V0.0441895H25.0866Z"
-      fill="#000091"
-    />
-  </g>
-  <defs>
-    <clipPath id="clip0_5_830">
-      <rect width="36" height="42" fill="white" />
-    </clipPath>
-  </defs>
+<svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M21.6305 28.8312C22.7983 28.5038 23.9166 27.9062 24.6505 26.8503C25.3749 25.8163 25.5789 24.5047 25.5789 23.2425V4.75099C25.5789 4.42358 25.5611 4.09557 25.5216 3.77148C26.1016 3.99961 26.5486 4.37658 26.8626 4.90239C27.2331 5.50024 27.4184 6.28757 27.4184 7.26435V26.0464C27.4184 27.3684 27.0942 28.3578 26.4458 29.0146C25.7974 29.6714 24.8207 29.9998 23.5155 29.9998H16.4209C16.5889 29.9704 16.7574 29.9401 16.9262 29.909C18.4067 29.6444 19.9713 29.2854 21.6185 28.8346L21.6305 28.8312Z" fill="#C9191E"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M4.58203 25.655V6.8477C4.58203 5.70251 4.88938 4.83519 5.50408 4.24575C6.1272 3.65631 6.95242 3.33212 7.97972 3.27318C9.49542 3.18055 10.9311 3.05425 12.2868 2.89425C13.6425 2.72584 14.9393 2.53217 16.1771 2.31324C17.4234 2.0943 18.6359 1.85011 19.8148 1.58065C21.0274 1.29435 21.9578 1.4375 22.6062 2.0101C23.2546 2.58269 23.5788 3.49632 23.5788 4.75099V23.2425C23.5788 24.3456 23.3893 25.1666 23.0104 25.7055C22.6315 26.2529 21.9915 26.6528 21.0905 26.9054C19.4906 27.3433 17.9833 27.6886 16.5687 27.9412C15.154 28.2022 13.7731 28.4001 12.4258 28.5348C11.0785 28.6696 9.69751 28.7748 8.28286 28.8506C7.11241 28.918 6.20299 28.6738 5.5546 28.118C4.90622 27.5707 4.58203 26.7497 4.58203 25.655ZM9.20865 10.2624C11.0635 10.1444 12.7632 9.96305 14.3075 9.71831C14.6822 9.65722 15.0564 9.5936 15.4291 9.52759C15.8192 9.45851 16.1013 9.11859 16.1013 8.72337C16.1013 8.21154 15.638 7.82609 15.135 7.91189C14.846 7.96118 14.5555 8.00909 14.2635 8.05562C12.7346 8.29923 11.0452 8.47998 9.19523 8.5977C8.91819 8.61558 8.69776 8.70188 8.55608 8.87391C8.42209 9.03661 8.35645 9.23229 8.35645 9.45535C8.35645 9.68212 8.43296 9.87951 8.58568 10.0418L8.58783 10.0439C8.75336 10.2095 8.96369 10.2811 9.20865 10.2624ZM9.20801 14.456C11.0631 14.338 12.763 14.1566 14.3075 13.9119C15.8588 13.6589 17.3936 13.3638 18.9112 13.0266C19.2191 12.9581 19.4498 12.8503 19.5652 12.683C19.6786 12.5221 19.7347 12.3376 19.7347 12.1332C19.7347 11.9026 19.6469 11.704 19.476 11.5426C19.2921 11.3689 19.0348 11.3284 18.7304 11.3911L18.7285 11.3915C17.2823 11.7194 15.794 12.0053 14.2635 12.2492C12.7346 12.4928 11.0452 12.6735 9.19523 12.7913C8.91819 12.8091 8.69776 12.8954 8.55608 13.0675C8.42276 13.2294 8.35645 13.4205 8.35645 13.6363C8.35645 13.8703 8.43209 14.0723 8.58558 14.2354L8.59 14.2396C8.75499 14.3949 8.96316 14.4655 9.20551 14.4562L9.20801 14.456ZM9.20847 18.6494C11.0634 18.5229 12.7631 18.3374 14.3075 18.0927C15.8589 17.8482 17.3934 17.5573 18.9112 17.22C19.2199 17.1514 19.4508 17.0391 19.566 16.8627C19.6783 16.7029 19.7347 16.5233 19.7347 16.3266C19.7347 16.0961 19.6469 15.8974 19.476 15.7361C19.2921 15.5623 19.0348 15.5218 18.7304 15.5845L18.729 15.5848C17.2827 15.9043 15.7942 16.1861 14.2635 16.43C12.7345 16.6736 11.045 16.8586 9.19495 16.9847C8.91804 17.0026 8.69771 17.0889 8.55608 17.2609C8.42276 17.4228 8.35645 17.6139 8.35645 17.8297C8.35645 18.0637 8.43209 18.2658 8.58558 18.4289L8.59 18.433C8.75499 18.5883 8.96316 18.6589 9.20551 18.6496L9.20847 18.6494ZM14.3075 22.257C12.7632 22.5018 11.0635 22.6831 9.20867 22.8012C8.9637 22.8198 8.75337 22.7482 8.58783 22.5826L8.58572 22.5805C8.433 22.4182 8.35645 22.2208 8.35645 21.9941C8.35645 21.771 8.42209 21.5753 8.55608 21.4126C8.69776 21.2406 8.91827 21.1543 9.19531 21.1364C11.0453 21.0187 12.7346 20.838 14.2635 20.5943C14.5555 20.5478 14.846 20.4999 15.135 20.4506C15.638 20.3648 16.1013 20.7503 16.1013 21.2621C16.1013 21.6573 15.8192 21.9972 15.4291 22.0663C15.0564 22.1323 14.6822 22.1959 14.3075 22.257Z" fill="#000091"/>
 </svg>
--- a/src/frontend/apps/impress/src/features/header/components/Header.tsx
+++ b/src/frontend/apps/impress/src/features/header/components/Header.tsx
@@ -1,67 +1,83 @@
+import { Button } from '@openfun/cunningham-react';
 import Image from 'next/image';
 import { useTranslation } from 'react-i18next';
+import { css } from 'styled-components';

-import { Box, StyledLink } from '@/components/';
+import { Box, Icon, StyledLink } from '@/components/';
 import { ButtonLogin } from '@/core/auth';
+import { useCunninghamTheme } from '@/cunningham';
 import { LanguagePicker } from '@/features/language';
+import { useLeftPanelStore } from '@/features/left-panel';
 import { useResponsiveStore } from '@/stores';

 import { default as IconDocs } from '../assets/icon-docs.svg?url';
+import { HEADER_HEIGHT } from '../conf';

-import { DropdownMenu } from './DropdownMenu';
 import { LaGaufre } from './LaGaufre';
 import Title from './Title/Title';

 export const Header = () => {
  const { t } = useTranslation();
-  const { isSmallMobile } = useResponsiveStore();
+  const theme = useCunninghamTheme();
+  const { isPanelOpen, togglePanel } = useLeftPanelStore();
+  const { isDesktop } = useResponsiveStore();
+
+  const spacings = theme.spacingsTokens();
+  const colors = theme.colorsTokens();

  return (
    <Box
      as="header"
-      $justify="center"
-      $width="100%"
-      $zIndex="100"
-      $padding={{ vertical: 'xtiny' }}
-      $css="border-bottom: 1px solid #EDEDED;"
+      $css={css`
+        display: flex;
+        position: fixed;
+        top: 0;
+        left: 0;
+        right: 0;
+        z-index: 1000;
+        flex-direction: row;
+        align-items: center;
+        justify-content: space-between;
+        height: ${HEADER_HEIGHT}px;
+        min-height: ${HEADER_HEIGHT}px;
+        padding: 0 ${spacings['base']};
+        background-color: ${colors['greyscale-000']};
+        border-bottom: 1px solid ${colors['greyscale-200']};
+      `}
    >
-      <Box
-        $margin={{
-          left: 'big',
-          right: isSmallMobile ? 'none' : 'big',
-        }}
-        $align="center"
-        $justify="space-between"
-        $direction="row"
-      >
-        <Box>
-          <StyledLink href="/">
-            <Box
-              $align="center"
-              $gap="0.8rem"
-              $direction="row"
-              $position="relative"
-              $height="fit-content"
-              $margin={{ top: 'auto' }}
-            >
-              <Image priority src={IconDocs} alt={t('Docs Logo')} width={25} />
-              <Title />
-            </Box>
-          </StyledLink>
+      {!isDesktop && (
+        <Button
+          size="medium"
+          onClick={togglePanel}
+          aria-label={t('Open the header menu')}
+          color="primary-text"
+          icon={<Icon iconName={isPanelOpen ? 'close' : 'menu'} />}
+        />
+      )}
+      <StyledLink href="/">
+        <Box
+          $align="center"
+          $gap={spacings['3xs']}
+          $direction="row"
+          $position="relative"
+          $height="fit-content"
+          $margin={{ top: 'auto' }}
+        >
+          <Image priority src={IconDocs} alt={t('Docs Logo')} width={25} />
+          <Title />
        </Box>
-        {isSmallMobile ? (
-          <Box $direction="row" $gap="2rem">
-            <LaGaufre />
-            <DropdownMenu />
-          </Box>
-        ) : (
-          <Box $align="center" $gap="2vw" $direction="row">
-            <ButtonLogin />
-            <LanguagePicker />
-            <LaGaufre />
-          </Box>
-        )}
-      </Box>
+      </StyledLink>
+      {!isDesktop ? (
+        <Box $direction="row" $gap={spacings['sm']}>
+          <LaGaufre />
+        </Box>
+      ) : (
+        <Box $align="center" $gap={spacings['sm']} $direction="row">
+          <ButtonLogin />
+          <LanguagePicker />
+          <LaGaufre />
+        </Box>
+      )}
    </Box>
  );
 };
--- a/src/frontend/apps/impress/src/features/left-panel/components/LeftPanel.tsx
+++ b/src/frontend/apps/impress/src/features/left-panel/components/LeftPanel.tsx
@@ -1,34 +1,29 @@
-import { Button } from '@openfun/cunningham-react';
-import { useRouter } from 'next/navigation';
 import { PropsWithChildren } from 'react';
-import { useTranslation } from 'react-i18next';
+import { createGlobalStyle, css } from 'styled-components';

-import { Box, Icon, SeparatedSection } from '@/components';
+import { Box, SeparatedSection } from '@/components';
+import { ButtonLogin } from '@/core';
 import { useCunninghamTheme } from '@/cunningham';
-import { useCreateDoc } from '@/features/docs';
 import { HEADER_HEIGHT } from '@/features/header/conf';
+import { LanguagePicker } from '@/features/language';
 import { useResponsiveStore } from '@/stores';

+import { useLeftPanelStore } from '../stores';
+
+import { LeftPanelHeader } from './LeftPanelHeader';
+
+const MobileLeftPanelStyle = createGlobalStyle`
+  body {
+    overflow: hidden;
+  }
+`;
+
 export const LeftPanel = ({ children }: PropsWithChildren) => {
-  const { t } = useTranslation();
-  const router = useRouter();
  const { isDesktop } = useResponsiveStore();
+  const { isPanelOpen } = useLeftPanelStore();
  const theme = useCunninghamTheme();
  const colors = theme.colorsTokens();
-
-  const { mutate: createDoc } = useCreateDoc({
-    onSuccess: (doc) => {
-      router.push(`/docs/${doc.id}`);
-    },
-  });
-
-  const goToHome = () => {
-    router.push('/');
-  };
-
-  const createNewDoc = () => {
-    createDoc({ title: t('Untitled document') });
-  };
+  const spacings = theme.spacingsTokens();

  return (
    <>
@@ -42,29 +37,45 @@ export const LeftPanel = ({ children }: PropsWithChildren) => {
            border-right: 1px solid ${colors['greyscale-200']};
        `}
        >
-          <div>
-            <SeparatedSection>
-              <Box
-                $padding={{ horizontal: 'sm' }}
-                $direction="row"
-                $justify="space-between"
-                $align="center"
-              >
-                <Box $direction="row" $gap="2px">
-                  <Button
-                    onClick={goToHome}
-                    size="medium"
-                    color="primary-text"
-                    icon={<Icon iconName="house" />}
-                  />
-                </Box>
-                <Button onClick={createNewDoc}>{t('New doc')}</Button>
-              </Box>
-            </SeparatedSection>
-            {children}
-          </div>
+          <LeftPanelHeader>{children}</LeftPanelHeader>
        </Box>
      )}
+
+      {!isDesktop && (
+        <>
+          {isPanelOpen && <MobileLeftPanelStyle />}
+          <Box
+            $hasTransition
+            $css={css`
+              z-index: 999;
+              width: 100dvw;
+              height: calc(100dvh - 52px);
+              border-right: 1px solid var(--c--theme--colors--greyscale-200);
+              position: fixed;
+              transform: translateX(${isPanelOpen ? '0' : '-100dvw'});
+              background-color: var(--c--theme--colors--greyscale-000);
+            `}
+          >
+            <Box
+              data-testid="left-panel-mobile"
+              $css={css`
+                width: 100%;
+                justify-content: center;
+                align-items: center;
+                gap: ${spacings['base']};
+              `}
+            >
+              <LeftPanelHeader>{children}</LeftPanelHeader>
+              <SeparatedSection showSeparator={false}>
+                <Box $justify="center" $align="center" $gap={spacings['sm']}>
+                  <ButtonLogin />
+                  <LanguagePicker />
+                </Box>
+              </SeparatedSection>
+            </Box>
+          </Box>
+        </>
+      )}
    </>
  );
 };
--- a/src/frontend/apps/impress/src/features/left-panel/components/LeftPanelHeader.tsx
+++ b/src/frontend/apps/impress/src/features/left-panel/components/LeftPanelHeader.tsx
@@ -0,0 +1,55 @@
+import { Button } from '@openfun/cunningham-react';
+import { t } from 'i18next';
+import { useRouter } from 'next/navigation';
+import { PropsWithChildren } from 'react';
+
+import { Box, Icon, SeparatedSection } from '@/components';
+import { useCreateDoc } from '@/features/docs';
+
+import { useLeftPanelStore } from '../stores';
+
+export const LeftPanelHeader = ({ children }: PropsWithChildren) => {
+  const router = useRouter();
+  const { togglePanel } = useLeftPanelStore();
+
+  const { mutate: createDoc } = useCreateDoc({
+    onSuccess: (doc) => {
+      router.push(`/docs/${doc.id}`);
+      togglePanel();
+    },
+  });
+
+  const goToHome = () => {
+    router.push('/');
+    togglePanel();
+  };
+
+  const createNewDoc = () => {
+    createDoc({ title: t('Untitled document') });
+  };
+
+  return (
+    <Box $width="100%">
+      <SeparatedSection>
+        <Box
+          $padding={{ horizontal: 'sm' }}
+          $width="100%"
+          $direction="row"
+          $justify="space-between"
+          $align="center"
+        >
+          <Box $direction="row" $gap="2px">
+            <Button
+              onClick={goToHome}
+              size="medium"
+              color="primary-text"
+              icon={<Icon iconName="house" />}
+            />
+          </Box>
+          <Button onClick={createNewDoc}>{t('New doc')}</Button>
+        </Box>
+      </SeparatedSection>
+      {children}
+    </Box>
+  );
+};
--- a/src/frontend/apps/impress/src/features/left-panel/index.ts
+++ b/src/frontend/apps/impress/src/features/left-panel/index.ts
@@ -1 +1,2 @@
 export * from './components';
+export * from './stores';
--- a/src/frontend/apps/impress/src/features/left-panel/stores/index.ts
+++ b/src/frontend/apps/impress/src/features/left-panel/stores/index.ts
@@ -0,0 +1 @@
+export * from './useLeftPanelStore';
--- a/src/frontend/apps/impress/src/features/left-panel/stores/useLeftPanelStore.tsx
+++ b/src/frontend/apps/impress/src/features/left-panel/stores/useLeftPanelStore.tsx
@@ -0,0 +1,11 @@
+import { create } from 'zustand';
+
+interface LeftPanelState {
+  isPanelOpen: boolean;
+  togglePanel: () => void;
+}
+
+export const useLeftPanelStore = create<LeftPanelState>((set) => ({
+  isPanelOpen: false,
+  togglePanel: () => set((state) => ({ isPanelOpen: !state.isPanelOpen })),
+}));
--- a/src/frontend/apps/impress/src/layouts/MainLayout.tsx
+++ b/src/frontend/apps/impress/src/layouts/MainLayout.tsx
@@ -1,4 +1,5 @@
 import { PropsWithChildren } from 'react';
+import { css } from 'styled-components';

 import { Box } from '@/components';
 import { useCunninghamTheme } from '@/cunningham';
@@ -27,7 +28,11 @@ export function MainLayout({
  return (
    <div>
      <Header />
-      <Box $direction="row" $width="100%">
+      <Box
+        $direction="row"
+        $margin={{ top: `${HEADER_HEIGHT}px` }}
+        $width="100%"
+      >
        <LeftPanel />
        <Box
          as="main"
@@ -45,10 +50,10 @@ export function MainLayout({
              ? colors['greyscale-000']
              : colors['greyscale-050']
          }
-          $css={`
-              overflow-y: auto;
-              overflow-x: clip;
-            `}
+          $css={css`
+            overflow-y: auto;
+            overflow-x: clip;
+          `}
        >
          {children}
        </Box>