@cnamts/synapse 0.0.2-alpha → 0.0.4-alpha

package/src/components/HeaderBar/HeaderBurgerMenu/HeaderSubMenu/HeaderSubMenu.stories.ts

@@ -0,0 +1,261 @@
+import type { Meta, StoryObj } from '@storybook/vue3'
+import HeaderBar from '../../HeaderBar.vue'
+import HeaderBurgerMenu from '../HeaderBurgerMenu.vue'
+import HeaderMenuItem from '../HeaderMenuItem/HeaderMenuItem.vue'
+import HeaderMenuSection from '../HeaderMenuSection/HeaderMenuSection.vue'
+import HeaderSubMenu from './HeaderSubMenu.vue'
+
+const meta = {
+	title: 'Composants/Structure/HeaderBar/HeaderBurgerMenu/HeaderSubMenu',
+	component: HeaderSubMenu,
+	argTypes: {
+		title: {
+			control: { type: 'text' },
+			description: 'Titre du sous-menu',
+			table: {
+				type: { summary: '{}' },
+			},
+		},
+		default: {
+			control: { type: 'text' },
+			description: 'Contenu du sous-menu, construit avec des composants `HeaderMenuSection`',
+			table: {
+				type: { summary: '{}' },
+			},
+		},
+	},
+	parameters: {
+		layout: 'fullscreen',
+	},
+} satisfies Meta<typeof HeaderSubMenu>
+
+export default meta
+
+type Story = StoryObj<typeof meta>
+
+export const Default: Story = {
+	args: {
+		title: 'Menu de premier niveau',
+	},
+	render: (args) => {
+		return {
+			components: { HeaderMenuItem, HeaderBurgerMenu, HeaderBar, HeaderSubMenu, HeaderMenuSection },
+			setup() {
+				return { args }
+			},
+			template: `
+				<HeaderBar>
+					<template #menu>
+						<HeaderBurgerMenu>
+							<HeaderMenuSection>
+								<HeaderMenuItem>
+									<a>Item</a>
+								</HeaderMenuItem>
+								<HeaderMenuItem>
+									<a>Item</a>
+								</HeaderMenuItem>
+								<headerMenuItem>
+									<HeaderSubMenu v-bind="args">
+										<template #title>
+											{{ args.title }}
+										</template>
+										<HeaderMenuItem>
+											<a>Item</a>
+										</HeaderMenuItem>
+									</HeaderSubMenu>
+								</headerMenuItem>
+								<HeaderMenuItem>
+									<a>Item</a>
+								</HeaderMenuItem>
+							</HeaderMenuSection>
+						</HeaderBurgerMenu>
+					</template>
+				</HeaderBar>
+			`,
+		}
+	},
+	play: async ({ canvasElement }) => {
+		const menuBtn = canvasElement.querySelector('button')
+		setTimeout(() => {
+			menuBtn!.click()
+		}, 1000)
+	},
+	parameters: {
+		sourceCode: [
+			{
+				name: 'Template',
+				code: `
+				<HeaderBar>
+					<template #menu>
+						<HeaderBurgerMenu>
+							<HeaderMenuSection>
+								<HeaderMenuItem>
+									<a>Item</a>
+								</HeaderMenuItem>
+								<HeaderMenuItem>
+									<a>Item</a>
+								</HeaderMenuItem>
+								<headerMenuItem>
+									<HeaderSubMenu>
+										<template #title>
+											Menu de premier niveau
+										</template>
+										<HeaderMenuItem>
+											<a>Item</a>
+										</HeaderMenuItem>
+									</HeaderSubMenu>
+								</headerMenuItem>
+								<HeaderMenuItem>
+									<a>Item</a>
+								</HeaderMenuItem>
+							</HeaderMenuSection>
+						</HeaderBurgerMenu>
+					</template>
+				</HeaderBar>
+				`,
+			},
+			{
+				name: 'Script',
+				code: `
+				<script setup>
+					import { HeaderBurgerMenu, HeaderBar, HeaderMenuSection, HeaderMenuItem, HeaderSubMenu } from '@cnamts/synapse'
+				</script>
+				`,
+			},
+		],
+	},
+}
+
+export const Deep: Story = {
+	args: {
+		title: 'Menu de deuxième niveau',
+	},
+	render: (args) => {
+		return {
+			components: { HeaderMenuItem, HeaderBurgerMenu, HeaderBar, HeaderSubMenu, HeaderMenuSection },
+			setup() {
+				return { args }
+			},
+			template: `
+			<Template>
+				<HeaderBar>
+					<template #menu>
+						<HeaderBurgerMenu>
+							<HeaderMenuSection>
+								<HeaderMenuItem>
+									<a>Item 1</a>
+								</HeaderMenuItem>
+								<HeaderMenuItem>
+									<a>Item 2</a>
+								</HeaderMenuItem>
+								<headerMenuItem>
+									<HeaderSubMenu>
+										<template #title>
+											Menu de premier niveau
+										</template>
+										<HeaderMenuItem>
+											<a>Item 2.1</a>
+										</HeaderMenuItem>
+										<HeaderMenuItem>
+											<a>Item 2.2</a>
+										</HeaderMenuItem>
+										<HeaderMenuItem>
+											<HeaderSubMenu v-bind="args">
+												<template #title>
+													{{ args.title }}
+												</template>
+												<HeaderMenuItem>
+													<a>Item 3.1</a>
+												</HeaderMenuItem>
+												<HeaderMenuItem>
+													<a>Item 3.2</a>
+												</HeaderMenuItem>
+											</HeaderSubMenu>
+										</HeaderMenuItem>
+									</HeaderSubMenu>
+								</headerMenuItem>
+								<HeaderMenuItem>
+									<a>Item 3</a>
+								</HeaderMenuItem>
+							</HeaderMenuSection>
+						</HeaderBurgerMenu>
+					</template>
+				</HeaderBar>
+			</Template>
+			`,
+		}
+	},
+	play: async ({ canvasElement }) => {
+		const menuBtn = canvasElement.querySelector('button')
+		await new Promise(resolve => setTimeout(resolve, 1000))
+		await menuBtn!.click()
+		await new Promise(resolve => setTimeout(resolve, 500))
+		const subMenuBtn = document.querySelector<HTMLElement>('.sub-menu-btn')
+		await subMenuBtn!.click()
+		await new Promise(resolve => setTimeout(resolve, 500))
+		const subMenuBtn2 = document.querySelector<HTMLElement>('.sub-menu .sub-menu .sub-menu-btn')
+		await subMenuBtn2!.click()
+	},
+	parameters: {
+		sourceCode: [
+			{
+				name: 'Template',
+				code: `
+				<Template>
+					<HeaderBar>
+						<template #menu>
+							<HeaderBurgerMenu>
+								<HeaderMenuSection>
+									<HeaderMenuItem>
+										<a>Item 1</a>
+									</HeaderMenuItem>
+									<HeaderMenuItem>
+										<a>Item 2</a>
+									</HeaderMenuItem>
+									<headerMenuItem>
+										<HeaderSubMenu>
+											<template #title>
+												Menu de premier niveau
+											</template>
+											<HeaderMenuItem>
+												<a>Item 2.1</a>
+											</HeaderMenuItem>
+											<HeaderMenuItem>
+												<a>Item 2.2</a>
+											</HeaderMenuItem>
+											<HeaderMenuItem>
+												<HeaderSubMenu>
+													<template #title>
+														Menu de deuxième niveau
+													</template>
+													<HeaderMenuItem>
+														<a>Item 3.1</a>
+													</HeaderMenuItem>
+													<HeaderMenuItem>
+														<a>Item 3.2</a>
+													</HeaderMenuItem>
+												</HeaderSubMenu>
+											</HeaderMenuItem>
+										</HeaderSubMenu>
+									</headerMenuItem>
+									<HeaderMenuItem>
+										<a>Item 3</a>
+									</HeaderMenuItem>
+								</HeaderMenuSection>
+							</HeaderBurgerMenu>
+						</template>
+					</HeaderBar>
+				</Template>
+				`,
+			},
+			{
+				name: 'Script',
+				code: `
+				<script setup>
+					import { HeaderBurgerMenu, HeaderBar, HeaderMenuSection, HeaderMenuItem, HeaderSubMenu } from '@cnamts/synapse'
+				</script>
+				`,
+			},
+		],
+	},
+}

package/src/components/HeaderBar/HeaderBurgerMenu/HeaderSubMenu/HeaderSubMenu.vue

@@ -0,0 +1,194 @@
+<script setup lang="ts">
+	import { mdiChevronLeft, mdiChevronRight } from '@mdi/js'
+	import { inject, readonly, ref, useId, type DeepReadonly, type Ref } from 'vue'
+	import { registerSubMenuKey } from '../conts'
+	import useHandleSubMenus from '../useHandleSubMenus'
+
+	const menuOpen = ref(false)
+	const submenuId = useId()
+	const btnId = `${submenuId}-btn`
+
+	const registerSubMenu = inject<
+		((r: DeepReadonly<Ref<boolean>>, c: () => void) => void) | undefined
+	>(registerSubMenuKey, undefined)
+	if (!registerSubMenu) throw new Error('The HeaderSubMenu component must be used inside a HeaderBurgerMenu component')
+	registerSubMenu(menuOpen, () => {
+		menuOpen.value = false
+	})
+
+	const { haveOpenSubMenu } = useHandleSubMenus(readonly(menuOpen))
+</script>
+
+<template>
+	<div
+		class="sub-menu"
+		:class="{
+			'sub-menu--open': menuOpen,
+			'sub-menu--child-open': haveOpenSubMenu,
+		}"
+	>
+		<button
+			:id="btnId"
+			class="sub-menu-btn"
+			type="button"
+			:aria-expanded="menuOpen ? 'true' : 'false'"
+			:aria-controls="submenuId"
+			:title="menuOpen ? 'Close submenu' : 'Open submenu'"
+			@click="menuOpen = !menuOpen"
+		>
+			<slot name="title" />
+
+			<VIcon
+				size="36"
+				class="sub-menu-btn__icon"
+			>
+				{{ menuOpen ? mdiChevronLeft : mdiChevronRight }}
+			</VIcon>
+		</button>
+		<transition name="slide-fade">
+			<div
+				v-show="menuOpen"
+				:id="submenuId"
+				class="sub-menu-content-wrapper"
+				:aria-labelledby="btnId"
+			>
+				<div class="sub-menu-content">
+					<slot />
+				</div>
+			</div>
+		</transition>
+	</div>
+</template>
+
+<style lang="scss" scoped>
+	@use "@/assets/tokens.scss" as *;
+	@use '../../consts' as *;
+
+	.sub-menu-btn {
+		display: flex;
+		justify-content: center;
+		flex-direction: column;
+		width: 100%;
+		padding: 16px 50px 16px 20px;
+		text-align: left;
+		color: $primary-base;
+
+		&:hover {
+			background-color: $primary-base;
+			color: $neutral-white;
+			text-decoration: underline;
+
+			> :deep(*) {
+				color: $neutral-white !important;
+			}
+		}
+
+		&::first-letter {
+			text-transform: uppercase;
+		}
+	}
+
+	.sub-menu-btn__icon {
+		position: absolute;
+		right: 20px;
+	}
+
+	@media screen and (max-width: ($header-breakpoint - 1)) {
+		.sub-menu--open {
+			position: absolute;
+			left: 0;
+			top: 0;
+			width: 100%;
+			height: 100%;
+			overflow-y: auto;
+			background-color: $neutral-white;
+			padding-top: 40px;
+			z-index: 10;
+		}
+
+		// If a submenu is open, the parent menu should not scroll, the child menu should
+		.sub-menu--child-open {
+			overflow-y: clip;
+		}
+
+		.sub-menu--open > .sub-menu-btn {
+			padding: 0 16px 8px 40px;
+			border-bottom: 1px solid $menu-border-color;
+			color: #000;
+			background-color: transparent;
+
+			&:hover {
+				color: #000;
+				> :deep(*) {
+					color: #000 !important;
+				}
+			}
+		}
+
+		.sub-menu--open > .sub-menu-btn > :deep(.sub-menu-btn__icon) {
+			left: 10px;
+			right: auto;
+		}
+	}
+
+	@media screen and (min-width: $header-breakpoint) {
+		.sub-menu-btn {
+			position: relative;
+		}
+
+		.sub-menu--open > .sub-menu-btn {
+			background-color: $primary-base;
+			color: $neutral-white;
+			transition: color 0.15s linear, background-color 0.15s linear;
+
+			> :deep(*) {
+				color: $neutral-white !important;
+			}
+		}
+
+		.sub-menu-content-wrapper {
+			position: absolute;
+			top: 0;
+			bottom: 0;
+			left: $menu-width;
+		}
+
+		.sub-menu-content {
+			width: $menu-width + 1px;
+			height: 100%;
+			background: #f9f9f9;
+			border-left: 1px solid $menu-border-color;
+			overflow-y: auto;
+			overflow-x: hidden;
+
+			> .sub-menu--open .sub-menu-content {
+				left: $menu-width * 2;
+
+				> .sub-menu--open .sub-menu-content {
+					left: $menu-width * 3;
+				}
+			}
+		}
+
+		/* Transitions */
+
+		.slide-fade-enter-active {
+			transition: opacity 0.17s ease-out, transform 0.17s ease-out;
+		}
+
+		.slide-fade-leave-active {
+			transition: opacity 0.08s ease-in, transform 0.08s ease-in;
+		}
+
+		.slide-fade-enter-from, .slide-fade-leave-to {
+			opacity: 0;
+			transform: translateX(-10px);
+		}
+
+		@media (prefers-reduced-motion) {
+			.slide-fade-enter-active, .slide-fade-leave-active {
+				transition: none;
+			}
+		}
+	}
+</style>

package/src/components/HeaderBar/HeaderBurgerMenu/HeaderSubMenu/tests/HeaderSubMenu.spec.ts

@@ -0,0 +1,63 @@
+import { mount } from '@vue/test-utils'
+import { afterEach, describe, expect, it, vi } from 'vitest'
+
+import { vuetify } from '@tests/unit/setup'
+import { registerSubMenuKey } from '../../conts'
+import HeaderSubMenu from '../HeaderSubMenu.vue'
+
+const registerSubMenu = vi.fn()
+describe('HeaderSubMenu', () => {
+	afterEach(() => {
+		vi.resetAllMocks()
+	})
+
+	it('should render the component', async () => {
+		const wrapper = mount(HeaderSubMenu, {
+			slots: {
+				title: '<h2>Sub menu title</h2>',
+				default: '<ul><li><a>Test 1</a></li></ul>',
+			},
+			global: {
+				plugins: [vuetify],
+				provide: {
+					[registerSubMenuKey]: registerSubMenu,
+				},
+			},
+		})
+
+		const content = wrapper.find('.sub-menu-content-wrapper')
+
+		expect(wrapper.find('h2').text()).toBe('Sub menu title')
+		expect(wrapper.find('.sub-menu-content').element.children[0].textContent).toBe('Test 1')
+		expect(registerSubMenu.mock.calls.length).toBe(1)
+		const sharedStatus = registerSubMenu.mock.calls[0][0]
+		const sharedClose = registerSubMenu.mock.calls[0][1]
+
+		expect(sharedStatus.value).toBe(false)
+		expect(content.attributes('style')).toContain('display: none;')
+
+		const btn = wrapper.find('.sub-menu-btn')
+		await btn.trigger('click')
+
+		expect(sharedStatus.value).toBe(true)
+		expect(content.attributes('style')).toBeUndefined()
+
+		await sharedClose()
+		expect(sharedStatus.value).toBe(false)
+		expect(content.attributes('style')).toContain('display: none;')
+	})
+
+	it('throws an error if no register function is provided', async () => {
+		const mountWithoutInject = () => mount(HeaderSubMenu, {
+			slots: {
+				title: '<h2>Sub menu title</h2>',
+				default: '<ul><li><a>Test 1</a></li></ul>',
+			},
+			global: {
+				plugins: [vuetify],
+			},
+		})
+
+		expect(mountWithoutInject).toThrowError('The HeaderSubMenu component must be used inside a HeaderBurgerMenu component')
+	})
+})

package/src/components/HeaderBar/HeaderBurgerMenu/conts.ts

@@ -0,0 +1 @@
+export const registerSubMenuKey = Symbol('registerSubMenu')

package/src/components/HeaderBar/HeaderBurgerMenu/locals.ts

@@ -0,0 +1,4 @@
+export default {
+	mainMenu: 'Menu principal',
+	publicMenu: 'Menu public',
+}

package/src/components/HeaderBar/HeaderBurgerMenu/tests/HeaderBurgerMenu.spec.ts

@@ -0,0 +1,180 @@
+import { vuetify } from '@tests/unit/setup'
+import { mount } from '@vue/test-utils'
+import { describe, expect, it, vi, afterAll } from 'vitest'
+import { registerHeaderMenuKey } from '../../consts'
+import HeaderBurgerMenu from '../HeaderBurgerMenu.vue'
+import { defineComponent, toRef } from 'vue'
+
+describe('HeaderBurgerMenu', () => {
+	const BtnTestComponent = defineComponent({
+		props: {
+			modelValue: {
+				type: Boolean,
+				default: false,
+			},
+		},
+		setup(props) {
+			return { open: toRef(props, 'modelValue'), focus: () => {} }
+		},
+		template: `<button @click="$emit('update:modelValue', !open)">Test</button>`,
+	})
+
+	vi.mock('@/utils/functions/throttleDisplayFn/throttleDisplayFn.ts', () => ({
+		default: (fn: (...args: unknown[]) => void) => fn,
+	}))
+
+	afterAll(() => {
+		vi.restoreAllMocks()
+		document.body.innerHTML = ''
+	})
+
+	it('should render the component', async () => {
+		const wrapper = mount(HeaderBurgerMenu, {
+			global: {
+				plugins: [vuetify],
+				provide: {
+					[registerHeaderMenuKey]: () => {},
+				},
+				stubs: {
+					teleport: true,
+					HeaderMenuBtn: BtnTestComponent,
+				},
+			},
+			slots: {
+				default: '<div>Default slot</div>',
+			},
+			attachTo: document.body,
+		})
+
+		expect(wrapper.find('.overlay').exists()).toBe(false)
+		const btn = wrapper.find('button')
+		await btn.trigger('click')
+		expect(wrapper.find('.overlay').exists()).toBe(true)
+		expect(wrapper.find('.overlay').html()).toMatchSnapshot()
+
+		wrapper.unmount()
+	})
+
+	it('should close the menu when clicking outside', async () => {
+		const wrapper = mount(HeaderBurgerMenu, {
+			global: {
+				plugins: [vuetify],
+				provide: {
+					[registerHeaderMenuKey]: () => {},
+				},
+				stubs: {
+					teleport: true,
+					HeaderMenuBtn: BtnTestComponent,
+				},
+			},
+			slots: {
+				default: '<div>Default slot</div>',
+			},
+			attachTo: document.body,
+		})
+
+		const btn = wrapper.find('button')
+
+		await btn.trigger('click')
+		expect(wrapper.find('.overlay').exists()).toBe(true)
+
+		await wrapper.find('.overlay').trigger('click')
+		expect(wrapper.find('.overlay').exists()).toBe(false)
+
+		wrapper.unmount()
+	})
+
+	it('should not close the menu when clicking inside', async () => {
+		const wrapper = mount(HeaderBurgerMenu, {
+			global: {
+				plugins: [vuetify],
+				provide: {
+					[registerHeaderMenuKey]: () => {},
+				},
+				stubs: {
+					teleport: true,
+					HeaderMenuBtn: BtnTestComponent,
+				},
+			},
+			slots: {
+				default: '<div>Default slot</div>',
+			},
+			attachTo: document.body,
+		})
+
+		const btn = wrapper.find('button')
+		await btn.trigger('click')
+		expect(wrapper.find('.overlay').exists()).toBe(true)
+
+		await wrapper.find('.header-menu').trigger('click')
+		expect(wrapper.find('.overlay').exists()).toBe(true)
+
+		wrapper.unmount()
+	})
+
+	it('should listen to the button to open and close the menu', async () => {
+		const wrapper = mount(HeaderBurgerMenu, {
+			global: {
+				plugins: [vuetify],
+				provide: {
+					[registerHeaderMenuKey]: () => {},
+				},
+				stubs: {
+					Teleport: true,
+					HeaderMenuBtn: BtnTestComponent,
+				},
+			},
+			slots: {
+				default: '<div>Default slot</div>',
+			},
+			attachTo: document.body,
+		})
+
+		const btn = wrapper.find('button')
+		await btn.trigger('click')
+		expect(wrapper.find('.overlay').exists()).toBe(true)
+
+		await btn.trigger('click')
+		expect(wrapper.find('.overlay').exists()).toBe(false)
+
+		wrapper.unmount()
+	})
+
+	it('reposition the menu when the size of the window changes', async () => {
+		const wrapper = mount(HeaderBurgerMenu, {
+			global: {
+				plugins: [vuetify],
+				provide: {
+					[registerHeaderMenuKey]: () => {},
+				},
+				stubs: {
+					Teleport: true,
+					HeaderMenuBtn: BtnTestComponent,
+				},
+			},
+			attachTo: document.body,
+		})
+
+		const btn = wrapper.find('button')
+		await btn.trigger('click')
+		const menuBtnWrapper = wrapper.find('[role="dialog"]>div')
+
+		vi.spyOn(menuBtnWrapper.element, 'getBoundingClientRect').mockReturnValue(new DOMRect(50, 50, 0, 0))
+
+		window.dispatchEvent(new Event('resize'))
+		await wrapper.vm.$nextTick()
+
+		let renderStyle = wrapper.find('.menu-wrapper').attributes('style')
+		expect(renderStyle).toContain('left: 50px; top: 50px;')
+
+		vi.spyOn(menuBtnWrapper.element, 'getBoundingClientRect').mockReturnValue(new DOMRect(40, 60, 0, 0))
+
+		window.dispatchEvent(new Event('resize'))
+		await wrapper.vm.$nextTick()
+
+		renderStyle = wrapper.find('.menu-wrapper').attributes('style')
+		expect(renderStyle).toContain('left: 40px; top: 60px;')
+
+		wrapper.unmount()
+	})
+})