feat(frontend): Add SidebarMenu component and navigation hook

This commit includes a new SidebarMenu component along with its tests and styling. It also introduces a new hook "useNavigation" which will handle active state for the navigation menu. The sidebar menu items include home and profiles options, with their icons changing based on the active state of the page. Refs: #1
maikbasel · Dec 21, 2023 · ac813ed · ac813ed
1 parent 3d5e082
commit ac813ed
Show file tree

Hide file tree

Showing 12 changed files with 409 additions and 119 deletions.
diff --git a/jest.config.ts b/jest.config.ts
@@ -10,6 +10,9 @@ const createJestConfig = nextJest({
 const config: Config = {
     coverageProvider: 'v8',
     testEnvironment: 'jsdom',
+    moduleNameMapper: {
+        "^@/(.*)$": "<rootDir>/src/$1",
+    },
     setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
 }
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -33,9 +33,11 @@
     "@testing-library/react": "^14.1.2",
     "@types/jest": "^29.5.11",
     "@types/node": "^20.10.5",
+    "@types/react-test-renderer": "^18.0.7",
     "eslint-plugin-jest": "^27.6.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
+    "react-test-renderer": "^18.2.0",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
     "tslib": "^2.6.2"

diff --git a/src/app/layout.tsx b/src/app/layout.tsx
@@ -1,22 +1,26 @@
-import './globals.css'
-import type { Metadata } from 'next'
-import { Inter } from 'next/font/google'
-
-const inter = Inter({ subsets: ['latin'] })
+import '../styles/globals.css';
+import type {Metadata} from 'next'
+import React, {ReactNode} from "react";
+import SidebarMenu from "@/components/SidebarMenu";
 
 export const metadata: Metadata = {
   title: 'Create Next App',
   description: 'Generated by create next app',
 }
 
-export default function RootLayout({
-  children,
-}: {
-  children: React.ReactNode
-}) {
+type RootLayoutProps = {
+    children: ReactNode;
+};
+
+export default function RootLayout({ children }: Readonly<RootLayoutProps>) {
   return (
     <html lang="en">
-      <body className={inter.className}>{children}</body>
+    <body>
+    <div className="flex bg-gray-800 min-h-screen">
+        <SidebarMenu/>
+        <main className="flex-1">{children}</main>
+    </div>
+    </body>
     </html>
   )
 }
diff --git a/src/app/page.tsx b/src/app/page.tsx
@@ -1,113 +1,7 @@
-import Image from 'next/image'
-
 export default function Home() {
   return (
-    <main className="flex min-h-screen flex-col items-center justify-between p-24">
-      <div className="z-10 max-w-5xl w-full items-center justify-between font-mono text-sm lg:flex">
-        <p className="fixed left-0 top-0 flex w-full justify-center border-b border-gray-300 bg-gradient-to-b from-zinc-200 pb-6 pt-8 backdrop-blur-2xl dark:border-neutral-800 dark:bg-zinc-800/30 dark:from-inherit lg:static lg:w-auto  lg:rounded-xl lg:border lg:bg-gray-200 lg:p-4 lg:dark:bg-zinc-800/30">
-          Get started by editing&nbsp;
-          <code className="font-mono font-bold">src/app/page.tsx</code>
-        </p>
-        <div className="fixed bottom-0 left-0 flex h-48 w-full items-end justify-center bg-gradient-to-t from-white via-white dark:from-black dark:via-black lg:static lg:h-auto lg:w-auto lg:bg-none">
-          <a
-            className="pointer-events-none flex place-items-center gap-2 p-8 lg:pointer-events-auto lg:p-0"
-            href="https://vercel.com?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            By{' '}
-            <Image
-              src="/vercel.svg"
-              alt="Vercel Logo"
-              className="dark:invert"
-              width={100}
-              height={24}
-              priority
-            />
-          </a>
-        </div>
+      <div className="flex flex-col pt-4 sm:ml-[120px] md:ml-[250px] sm:border-r sm:border-zinc-700 pb-20 h-full">
+        <span className="px-8 mt-10 font-bold text-3xl">Home Page</span>
       </div>
-
-      <div className="relative flex place-items-center before:absolute before:h-[300px] before:w-[480px] before:-translate-x-1/2 before:rounded-full before:bg-gradient-radial before:from-white before:to-transparent before:blur-2xl before:content-[''] after:absolute after:-z-20 after:h-[180px] after:w-[240px] after:translate-x-1/3 after:bg-gradient-conic after:from-sky-200 after:via-blue-200 after:blur-2xl after:content-[''] before:dark:bg-gradient-to-br before:dark:from-transparent before:dark:to-blue-700 before:dark:opacity-10 after:dark:from-sky-900 after:dark:via-[#0141ff] after:dark:opacity-40 before:lg:h-[360px] z-[-1]">
-        <Image
-          className="relative dark:drop-shadow-[0_0_0.3rem_#ffffff70] dark:invert"
-          src="/next.svg"
-          alt="Next.js Logo"
-          width={180}
-          height={37}
-          priority
-        />
-      </div>
-
-      <div className="mb-32 grid text-center lg:max-w-5xl lg:w-full lg:mb-0 lg:grid-cols-4 lg:text-left">
-        <a
-          href="https://nextjs.org/docs?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Docs{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Find in-depth information about Next.js features and API.
-          </p>
-        </a>
-
-        <a
-          href="https://nextjs.org/learn?utm_source=create-next-app&utm_medium=appdir-template-tw&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Learn{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Learn about Next.js in an interactive course with&nbsp;quizzes!
-          </p>
-        </a>
-
-        <a
-          href="https://vercel.com/templates?framework=next.js&utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Templates{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Explore the Next.js 13 playground.
-          </p>
-        </a>
-
-        <a
-          href="https://vercel.com/new?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Deploy{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Instantly deploy your Next.js site to a shareable URL with Vercel.
-          </p>
-        </a>
-      </div>
-    </main>
   )
 }
diff --git a/src/app/profiles/page.tsx b/src/app/profiles/page.tsx
@@ -0,0 +1,10 @@
+'use client'
+
+export default function Configuration() {
+    return (
+        <div
+            className="flex flex-col pt-4 sm:ml-[120px] md:ml-[250px] sm:border-r sm:border-zinc-700 pb-20 min-h-screen">
+            <span className="px-8 mt-10 font-bold text-3xl">Profiles Page</span>
+        </div>
+    );
+}
diff --git a/src/components/SidebarMenu.test.tsx b/src/components/SidebarMenu.test.tsx
@@ -0,0 +1,115 @@
+import React from 'react';
+import {render, screen} from '@testing-library/react';
+import SidebarMenu from './SidebarMenu';
+import Link from "next/link";
+import {Icon} from "@iconify/react";
+import renderer from 'react-test-renderer';
+
+describe('<SidebarMenu />', () => {
+    const mockUseNavigation = jest.fn();
+
+    jest.mock('@/hooks/Navigation', () => ({
+        __esModule: true,
+        useNavigation: mockUseNavigation(),
+    }));
+
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+
+    it('should render the Home menu item', () => {
+        render(<SidebarMenu/>);
+
+        const homeMenuItem = screen.getByText('Home');
+        expect(homeMenuItem).toBeInTheDocument();
+    });
+
+    it('should render the Profiles menu item', () => {
+        render(<SidebarMenu/>);
+
+        const profilesMenuItem = screen.getByText('Profiles');
+        expect(profilesMenuItem).toBeInTheDocument();
+    });
+
+    it('should render inactive Home icon when isHomeActive is false', () => {
+        mockUseNavigation.mockImplementation(() => ({
+            isHomeActive: false,
+            isProfilesActive: false,
+        }));
+
+        const tree = renderer
+            .create(<Link href="/"
+                          className="flex flex-row space-x-4 items-center px-4 py-3 duration-200 hover:bg-white/10 w-full">
+                <Icon icon="ant-design:home-outlined" width="38" height="38"/>
+                <span className="text-2xl pt-2 hidden md:flex">Home</span>
+            </Link>)
+            .toJSON();
+
+        expect(tree).toMatchSnapshot();
+    });
+
+    it('should render active Home icon when isHomeActive is true', () => {
+        mockUseNavigation.mockImplementation(() => ({
+            isHomeActive: true,
+            isProfilesActive: false,
+        }));
+
+        const tree = renderer
+            .create(<Link href="/"
+                          className="flex flex-row space-x-4 items-center px-4 py-3 duration-200 hover:bg-white/10 w-full">
+                <Icon icon="ant-design:home-filled" width="38" height="38" />
+                <span className="text-2xl pt-2 hidden md:flex">Home</span>
+            </Link>)
+            .toJSON();
+
+        expect(tree).toMatchSnapshot();
+    });
+
+    it('should render inactive Profiles icon when isProfilesActive is false', () => {
+        mockUseNavigation.mockImplementation(() => ({
+            isHomeActive: false,
+            isProfilesActive: false,
+        }));
+
+        const tree = renderer
+            .create(<Link href="/"
+                          className="flex flex-row space-x-4 items-center px-4 py-3 duration-200 hover:bg-white/10 w-full">
+                <Icon icon="ant-design:profile-outlined" width="38" height="38"/>
+                <span className="text-2xl pt-2 hidden md:flex">Home</span>
+            </Link>)
+            .toJSON();
+
+        expect(tree).toMatchSnapshot();
+    });
+
+    it('should render active Profiles icon when isProfilesActive is true', () => {
+        mockUseNavigation.mockImplementation(() => ({
+            isHomeActive: false,
+            isProfilesActive: true,
+        }));
+
+        const tree = renderer
+            .create(<Link href="/"
+                          className="flex flex-row space-x-4 items-center px-4 py-3 duration-200 hover:bg-white/10 w-full">
+                <Icon icon="ant-design:profile-filled" width="38" height="38" />
+                <span className="text-2xl pt-2 hidden md:flex">Home</span>
+            </Link>)
+            .toJSON();
+
+        expect(tree).toMatchSnapshot();
+    });
+
+    it('should render Home menu item with correct href', () => {
+        render(<SidebarMenu/>);
+
+        const homeMenuItem = screen.getByRole('link', {name: /home/i});
+        expect(homeMenuItem).toHaveAttribute('href', '/');
+    });
+
+    it('should render Profiles menu item with correct href', () => {
+        render(<SidebarMenu/>);
+
+        const profilesMenuItem = screen.getByRole('link', {name: /profiles/i});
+        expect(profilesMenuItem).toHaveAttribute('href', '/profiles');
+    });
+});