From ab24d57f8fbb9872450075ec19f497583ce1529e Mon Sep 17 00:00:00 2001
From: Mike Lebeau <mike.lebeau@prestashop.com>
Date: Fri, 20 Oct 2023 11:35:20 +0200
Subject: [PATCH] fix: update snackbar behavior -> remove stackable behavior

---
 packages/components/snackbar/src/notify.ts    | 70 ++++++++-----------
 packages/components/snackbar/src/snackbar.ts  |  6 ++
 packages/components/snackbar/src/snackbar.vue |  4 ++
 .../snackbar/stories/snackbar-use.stories.mdx |  1 +
 .../snackbar/stories/snackbar.stories.ts      | 31 ++++++++
 .../components/snackbar/test/snackbar.spec.ts | 10 ++-
 6 files changed, 78 insertions(+), 44 deletions(-)

diff --git a/packages/components/snackbar/src/notify.ts b/packages/components/snackbar/src/notify.ts
index c86e94da..99182381 100644
--- a/packages/components/snackbar/src/notify.ts
+++ b/packages/components/snackbar/src/notify.ts
@@ -1,65 +1,51 @@
-import { createVNode, render, type AppContext, type VNode } from 'vue'
+import {
+  createVNode,
+  render,
+  type AppContext,
+  type VNode,
+  ref,
+  type Ref,
+} from 'vue'
 import Snackbar from './snackbar.vue'
 import type { PuikSnackbarOptions } from './snackbar'
 
-const notifications: VNode[] = []
-
-const GAP = 16
-
-let seed = 1
+const currentNotification: Ref<VNode | null> = ref(null)
+const PUIK_SNACKBAR_ID = 'puik-snackbar-id'
 
 const notify = (
   options: PuikSnackbarOptions,
   context: AppContext | null = null
 ) => {
-  const id = `puik-snackbar_${seed++}`
   const customOnClose = options.onClose
-  let offset = options.offset || 32
+  const offset = options.offset || 32
 
-  notifications.forEach(({ el }) => {
-    offset += (el?.offsetHeight || 0) + GAP
-  })
-  const appendTo: HTMLElement | null = document.body
+  const documentBody: HTMLElement | null = document.body
 
   const props = {
     ...options,
     offset,
-    id,
-    onClose: () => close(id, customOnClose),
+    id: PUIK_SNACKBAR_ID,
+    onClose: () => {
+      currentNotification.value = null
+      return customOnClose
+    },
   }
 
-  const notification = createVNode(Snackbar, props)
-  notification.appContext = context ?? notify._context
-  const container = document.createElement('div')
-
-  notification.props!.onDestroy = () => render(null, container)
-
-  render(notification, container)
-  notifications.push(notification)
-  appendTo.appendChild(container.firstElementChild!)
-
-  const close = (id: string, customClose?: () => void) => {
-    const idx = notifications.findIndex(({ props }) => props?.id === id)
-    if (idx === -1) return
+  const newNotification = createVNode(Snackbar, props)
+  newNotification.appContext = context ?? notify._context
 
-    const { el } = notifications[idx]
-    if (!el) return
-
-    customClose?.()
-
-    const removedHeight = el?.offsetHeight
-
-    notifications.splice(idx, 1)
-    const len = notifications.length
+  const container = document.createElement('div')
 
-    if (len < 1) return
+  newNotification.props!.onDestroy = () => render(null, container)
+  render(newNotification, container)
+  documentBody.appendChild(container.firstElementChild!)
 
-    for (let i = idx; i < len; i++) {
-      const { el, component } = notifications[i]
-      const pos = parseInt(el?.style.bottom, 10) - removedHeight - GAP
-      component!.props.offset = pos
-    }
+  if (currentNotification.value) {
+    const curNot = document.getElementById(PUIK_SNACKBAR_ID)
+    curNot?.remove()
   }
+
+  currentNotification.value = newNotification
 }
 
 notify._context = null
diff --git a/packages/components/snackbar/src/snackbar.ts b/packages/components/snackbar/src/snackbar.ts
index 46e51e64..9b9bccb4 100644
--- a/packages/components/snackbar/src/snackbar.ts
+++ b/packages/components/snackbar/src/snackbar.ts
@@ -16,6 +16,7 @@ export interface PuikSnackbarOptions {
   action?: SnackbarAction
   duration?: number
   offset?: number
+  hasCloseButton?: boolean
   onClose?: () => void
 }
 
@@ -49,6 +50,11 @@ export const snackbarProps = buildProps({
     required: false,
     default: 0,
   },
+  hasCloseButton: {
+    type: Boolean,
+    required: false,
+    default: true,
+  },
   onClose: {
     type: Function,
     required: false,
diff --git a/packages/components/snackbar/src/snackbar.vue b/packages/components/snackbar/src/snackbar.vue
index 50d5cc60..97db7ece 100644
--- a/packages/components/snackbar/src/snackbar.vue
+++ b/packages/components/snackbar/src/snackbar.vue
@@ -7,6 +7,7 @@
   >
     <div
       v-show="visible"
+      :id="props.id"
       class="puik-snackbar"
       :class="`puik-snackbar--${variant}`"
       :style="position"
@@ -24,6 +25,7 @@
         {{ action.label }}
       </button>
       <button
+        v-if="hasCloseButton"
         class="puik-snackbar__close-button"
         :aria-label="t('puik.snackbar.closeBtnLabel')"
         @click="close"
@@ -40,9 +42,11 @@ import { useTimeoutFn, useEventListener } from '@vueuse/core'
 import { useLocale } from '@puik/hooks'
 import { snackbarProps } from './snackbar'
 import type { CSSProperties } from 'vue'
+
 defineOptions({
   name: 'PuikSnackbar',
 })
+
 const { t } = useLocale()
 let timer: (() => void) | undefined
 
diff --git a/packages/components/snackbar/stories/snackbar-use.stories.mdx b/packages/components/snackbar/stories/snackbar-use.stories.mdx
index 699243cf..bff40580 100644
--- a/packages/components/snackbar/stories/snackbar-use.stories.mdx
+++ b/packages/components/snackbar/stories/snackbar-use.stories.mdx
@@ -20,6 +20,7 @@ interface PuikSnackbarOptions {
   action?: SnackbarAction
   duration?: number
   offset?: number
+  hasCloseButton?: boolean
   onClose?: () => void
 }
 ```
diff --git a/packages/components/snackbar/stories/snackbar.stories.ts b/packages/components/snackbar/stories/snackbar.stories.ts
index ad7967cf..8fbc1f1f 100644
--- a/packages/components/snackbar/stories/snackbar.stories.ts
+++ b/packages/components/snackbar/stories/snackbar.stories.ts
@@ -72,6 +72,18 @@ export default {
         },
       },
     },
+    isClosable: {
+      description: 'Display a close button or not',
+      control: 'boolean',
+      table: {
+        type: {
+          summary: 'boolean',
+        },
+        defaultValue: {
+          summary: false,
+        },
+      },
+    },
     onClose: {
       description: 'Set the function to call when the snackbar has been closed',
       table: {
@@ -105,6 +117,25 @@ export const Default = {
   },
 }
 
+const HasNoCloseButtonTemplate: StoryFn = (args: Args) => ({
+  components: {
+    PuikButton,
+  },
+  setup() {
+    const open = () => PuikSnackbar(args as PuikSnackbarOptions)
+    return { args, open }
+  },
+  template: `<puik-button @click="open">Display Snackbar</puik-button>`,
+})
+
+export const HasNoCloseButton = {
+  render: HasNoCloseButtonTemplate,
+  args: {
+    text: 'New category added.',
+    hasCloseButton: false,
+  },
+}
+
 const WithoutActionTemplate: StoryFn = () => ({
   components: {
     PuikButton,
diff --git a/packages/components/snackbar/test/snackbar.spec.ts b/packages/components/snackbar/test/snackbar.spec.ts
index afa5abf5..f54f7a9a 100644
--- a/packages/components/snackbar/test/snackbar.spec.ts
+++ b/packages/components/snackbar/test/snackbar.spec.ts
@@ -2,7 +2,7 @@ import { mount } from '@vue/test-utils'
 import { describe, it, expect, vi } from 'vitest'
 import { faker } from '@faker-js/faker'
 import PuikSnackbar from '../src/snackbar.vue'
-import type { SnackbarOptions } from '../src/snackbar'
+import type { PuikSnackbarOptions } from '../src/snackbar'
 import type { MountingOptions, VueWrapper } from '@vue/test-utils'
 describe('Snackbar tests', () => {
   let wrapper: VueWrapper<any>
@@ -13,7 +13,7 @@ describe('Snackbar tests', () => {
   const findCloseButton = () => wrapper.find('.puik-snackbar__close-button')
 
   const factory = (
-    propsData: SnackbarOptions,
+    propsData: PuikSnackbarOptions,
     options: MountingOptions<any> = {}
   ) => {
     wrapper = mount(PuikSnackbar, {
@@ -39,6 +39,12 @@ describe('Snackbar tests', () => {
     expect(findAction().exists()).toBeFalsy()
   })
 
+  it('should be a snackbar without close button', () => {
+    const text = faker.lorem.sentence()
+    factory({ text, hasCloseButton: false })
+    expect(findCloseButton().exists()).toBeFalsy()
+  })
+
   it('should be a default snackbar with action', async () => {
     const text = faker.lorem.sentence()
     const label = faker.lorem.word()