@eturnity/eturnity_reusable_components 7.39.1 → 7.39.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eturnity/eturnity_reusable_components",
-  "version": "7.39.1",
+  "version": "7.39.2",
   "files": [
     "dist",
     "src"

package/src/components/banner/actionBanner/ActionBanner.stories.js

@@ -0,0 +1,45 @@
+import ActionBanner from './index.vue'
+import theme from '@/assets/theme'
+export default {
+  title: 'ActionBanner',
+  component: ActionBanner,
+  tags: ['autodocs'],
+}
+
+// <RCActionBanner
+//   :isOpen="true"
+//   @on-close="handleClose"
+// >
+//   <template #title>Sample title</template>
+//   <template #body>Sample body</template>
+//   <template #buttons>
+//     <button>Sample button </button>
+//   </template>
+// </RCActionBanner>
+
+export const Default = {
+  args: {
+    isOpen: false,
+  },
+}
+
+export const OpenedActionBanner = {
+  args: {
+    isOpen: true,
+  },
+  render: (args) => ({
+    components: { ActionBanner },
+    setup() {
+      return { args }
+    },
+    template: `
+      <ActionBanner v-bind="args">
+        <template #title>Sample title</template>
+        <template #body>Sample body</template>
+        <template #buttons>
+          <button>Sample button </button>
+        </template>
+      </ActionBanner>
+    `,
+  }),
+}

package/src/components/banner/actionBanner/actionBanner.spec.js

@@ -0,0 +1,76 @@
+/* eslint-disable */
+import { h } from 'vue'
+import { mount } from '@vue/test-utils'
+import ActionBanner from '@/components/banner/actionBanner'
+import theme from '@/assets/theme'
+
+describe('Action Banner Component', () => {
+  it('action banner is shown when isOpen props is true', async () => {
+    const wrapper = mount(ActionBanner, {
+      props: {
+        isOpen: false,
+      },
+      global: {
+        provide: {
+          theme,
+        },
+      },
+    })
+
+    const bannerWrapper = wrapper.find('[data-test-id="action_banner_wrapper"]')
+    expect(bannerWrapper.exists()).toBe(true)
+    expect(bannerWrapper.classes()).not.toContain('visible')
+    expect(bannerWrapper.classes()).toContain('hidden')
+    await wrapper.setProps({ isOpen: true })
+    expect(bannerWrapper.classes()).toContain('visible')
+    expect(bannerWrapper.classes()).not.toContain('hidden')
+  })
+
+  it('action banner slots is display when user passed slots content', async () => {
+    const titleText = 'Sample title'
+    const bodyText = 'Sample body text'
+    const buttonText = 'Sample button'
+
+    const wrapper = mount(ActionBanner, {
+      props: {
+        isOpen: false,
+      },
+      slots: {
+        title: titleText,
+        body: bodyText,
+        buttons: h('button', {}, buttonText),
+      },
+      global: {
+        provide: {
+          theme,
+        },
+      },
+    })
+
+    const modalTitleEl = wrapper.find('[data-test-id="modal_title"]')
+    expect(modalTitleEl.text()).toBe(titleText)
+    const modalBodyEl = wrapper.find('[data-test-id="modal_body"]')
+    expect(modalBodyEl.text()).toBe(bodyText)
+    const modalButtonsEl = wrapper.find('[data-test-id="modal_buttons"]')
+    expect(modalButtonsEl.text()).toBe(buttonText)
+  })
+
+  it('action banner on-close event is emitted when modal close button is clicked', async () => {
+    const wrapper = mount(ActionBanner, {
+      props: {
+        isOpen: true,
+      },
+      global: {
+        provide: {
+          theme,
+        },
+      },
+    })
+
+    const modalCloseButton = wrapper.find('.close')
+    await modalCloseButton.trigger('click')
+    expect(wrapper.emitted('on-close')).toBeTruthy()
+    const emittedEvent = wrapper.emitted('on-close')
+    expect(emittedEvent).toHaveLength(1)
+  })
+})

package/src/components/banner/actionBanner/index.vue

@@ -1,21 +1,37 @@
 <template>
-  <Modal :is-open="isOpen" @on-close="closeModal">
+  <Modal
+    :is-open="isOpen"
+    data-test-id="action_banner_wrapper"
+    @on-close="closeModal"
+  >
     <ModalContainer>
-      <ModalTitle v-if="$slots.title">
+      <ModalTitle v-if="$slots.title" data-test-id="modal_title">
         <slot name="title"></slot>
       </ModalTitle>
-      <TextContainer v-if="$slots.body">
+      <TextContainer v-if="$slots.body" data-test-id="modal_body">
         <slot name="body"></slot>
       </TextContainer>
-      <ButtonContainer v-if="$slots.buttons">
+      <ButtonContainer v-if="$slots.buttons" data-test-id="modal_buttons">
         <slot name="buttons"></slot>
       </ButtonContainer>
     </ModalContainer>
   </Modal>
 </template>
 <script>
+  // import RCBanner from "@eturnity/eturnity_reusable_components/src/components/banner/actionBanner"
+  // <RCActionBanner
+  //   :isOpen="true"
+  //   @on-close="handleClose"
+  // >
+  //   <template #title>Sample title</template>
+  //   <template #body>Sample body</template>
+  //   <template #buttons>
+  //     <button>Sample button </button>
+  //   </template>
+  // </RCActionBanner>
+
   import styled from 'vue3-styled-components'
-  import Modal from '../modal'
+  import Modal from '@/components/modals/modal'
   const ModalContainer = styled.div`
     width: 450px;
     min-height: 205px;
@@ -23,7 +39,7 @@
   `
   const ModalTitle = styled.div`
     color: ${(props) => props.theme.colors.black};
-    font-family: ${(props) => props.theme.fonts.mainFont};
+    font-family: inherit;
     font-size: 18px;
     font-style: normal;
     font-weight: 700;
@@ -37,7 +53,7 @@
   `
   const TextContainer = styled.div`
     color: ${(props) => props.theme.colors.black};
-    font-family: ${(props) => props.theme.fonts.mainFont};
+    font-family: inherit;
     font-size: 13px;
     font-style: normal;
     font-weight: 400;
@@ -45,6 +61,7 @@
     padding: 30px 0px;
     white-space: pre-wrap;
   `
+
   export default {
     name: 'ActionModal',
     components: {
@@ -54,7 +71,12 @@
       ButtonContainer,
       TextContainer,
     },
-    props: ['isOpen'],
+    props: {
+      isOpen: {
+        type: Boolean,
+        default: false,
+      },
+    },
     methods: {
       closeModal() {
         this.$emit('on-close')

package/src/components/banner/banner/Banner.stories.js

@@ -0,0 +1,64 @@
+import Banner from './index.vue'
+import theme from '@/assets/theme'
+
+export default {
+  title: 'Banner',
+  component: Banner,
+  tags: ['autodocs'],
+}
+
+// To use:
+// <RCBanner
+//   backdrop="white" // white, dark
+//   :hideClose="true"
+//   :isLoading="true"
+//   :isOpen="true"
+//   position="fixed"
+//   stopPropagation="false"
+//   @on-close="handleClose"
+// />
+
+export const Default = {
+  args: {
+    isOpen: false,
+    isLoading: false,
+    hideClose: false,
+    backdrop: 'white',
+    position: 'fixed',
+    stopPropagation: true,
+  },
+}
+
+export const OpenedBanner = {
+  args: {
+    isOpen: true,
+  },
+}
+
+export const LoadingBanner = {
+  args: {
+    isOpen: true,
+    isLoading: true,
+  },
+}
+
+export const HiddenCloseButton = {
+  args: {
+    isOpen: true,
+    hideClose: true,
+  },
+}
+
+export const DarkBackdrop = {
+  args: {
+    isOpen: true,
+    backdrop: 'dark',
+  },
+}
+
+export const AbsolutePositionBanner = {
+  args: {
+    isOpen: true,
+    position: 'absolute',
+  },
+}

package/src/components/banner/banner/banner.spec.js

@@ -0,0 +1,149 @@
+/* eslint-disable */
+import { mount } from '@vue/test-utils'
+import Banner from '@/components/banner/banner'
+import theme from '@/assets/theme'
+
+describe('Banner Component', () => {
+  it('banner is shown when isOpen props is true', async () => {
+    // Start with isOpen as false
+    const wrapper = mount(Banner, {
+      props: {
+        isOpen: false,
+        isLoading: false,
+      },
+      global: {
+        provide: {
+          theme,
+        },
+      },
+    })
+
+    const bannerWrapper = wrapper.find('[data-test-id="banner_wrapper"]')
+    // check that the element exists with correct props
+    expect(bannerWrapper.exists()).toBe(true)
+    // Check if wrapper doesnt have the 'visible' class, and have 'hidden' class
+    expect(bannerWrapper.classes()).not.toContain('visible')
+    expect(bannerWrapper.classes()).toContain('hidden')
+    // Now, set isOpen to true
+    await wrapper.setProps({ isOpen: true })
+    // Check if the 'visible' class is applied and 'hidden' class is not applied
+    expect(bannerWrapper.classes()).toContain('visible')
+    expect(bannerWrapper.classes()).not.toContain('hidden')
+  })
+
+  it('banner spinner is shown when user set isLoading props is true', async () => {
+    // Start with isLoading is false
+    const wrapper = mount(Banner, {
+      props: {
+        isOpen: true,
+        isLoading: false,
+      },
+      global: {
+        provide: {
+          theme,
+        },
+      },
+    })
+
+    const bannerWrapper = wrapper.find('[data-test-id="banner_wrapper"]')
+    // Initial check, spinner should not exist
+    let spinnerElement = bannerWrapper.find('[data-test-id="banner_spinner"]')
+    expect(spinnerElement.exists()).toBe(false)
+    // Set isLoading to true
+    await wrapper.setProps({ isLoading: true })
+    await wrapper.vm.$nextTick()
+    // Find the spinner element again after updating the prop and check if it exsit
+    spinnerElement = bannerWrapper.find('[data-test-id="banner_spinner"]')
+    expect(spinnerElement.exists()).toBe(true)
+  })
+
+  it('banner close button is not shown when hideClose props is true', async () => {
+    // Set hideClose to false
+    const wrapper = mount(Banner, {
+      props: {
+        isOpen: true,
+        hideClose: false,
+      },
+      global: {
+        provide: {
+          theme,
+        },
+      },
+    })
+
+    const bannerWrapper = wrapper.find('[data-test-id="banner_wrapper"]')
+
+    // Initial check, closeButton should exist
+    let closeButton = bannerWrapper.find('[data-test-id="banner_close_button"]')
+    expect(closeButton.exists()).toBe(true)
+    // Set isLoading to true
+    await wrapper.setProps({ hideClose: true })
+    await wrapper.vm.$nextTick()
+    // Find the closeButton element again after updating the prop
+    closeButton = bannerWrapper.find('[data-test-id="banner_close_button"]')
+    // Check if closeButton does not exist now
+    expect(closeButton.exists()).toBe(false)
+  })
+
+  it('banner on-close event is emitted when close button is clicked', async () => {
+    const wrapper = mount(Banner, {
+      props: {
+        isOpen: true,
+      },
+      global: {
+        provide: {
+          theme,
+        },
+      },
+    })
+
+    const bannerWrapper = wrapper.find('[data-test-id="banner_wrapper"]')
+    // Find the close button element
+    const closeButton = bannerWrapper.find(
+      '[data-test-id="banner_close_button"]'
+    )
+    // Simulate a click and check if the component emmitted a on-close event
+    await closeButton.trigger('click')
+    expect(wrapper.emitted('on-close')).toBeTruthy()
+    const emittedEvent = wrapper.emitted('on-close')
+    expect(emittedEvent).toHaveLength(1)
+  })
+
+  it('event.stopPropagation is called when stopPropagation prop is true and banner wrapper is clicked', async () => {
+    const wrapper = mount(Banner, {
+      props: {
+        isOpen: true,
+        stopPropagation: true,
+      },
+      global: {
+        provide: {
+          theme,
+        },
+      },
+    })
+
+    const bannerWrapper = wrapper.find('[data-test-id="banner_wrapper"]')
+    let modalWrapper = bannerWrapper.find('[data-test-id="modal-container"]')
+    // Mock for event.stopPropagation
+    const stopPropagationMock = jest.fn()
+    // Simulate a click event with the mocked stopPropagation function
+    await modalWrapper.trigger('click', {
+      stopPropagation: stopPropagationMock,
+    })
+    // Check if stopPropagation was called
+    expect(stopPropagationMock).toHaveBeenCalled()
+
+    // Set stopPropagation props to false and wait for the DOM to update
+    await wrapper.setProps({ stopPropagation: false })
+    await wrapper.vm.$nextTick()
+
+    // Create new mock for event.stopPropagation that should not be called
+    const stopPropagationNotCalledMock = jest.fn()
+    // Simulate againma click event
+    await modalWrapper.trigger('click', {
+      stopPropagation: stopPropagationNotCalledMock,
+    })
+    // Check if stopPropagation was NOT called
+    expect(stopPropagationNotCalledMock).not.toHaveBeenCalled()
+  })
+})

package/src/components/banner/banner/index.vue

@@ -2,29 +2,45 @@
   <PageWrapper
     :backdrop="backdrop"
     :class="{ visible: isOpen, hidden: !isOpen }"
+    data-test-id="banner_wrapper"
     :is-open="isOpen"
     :position="position"
   >
-    <ModalContainer @click="onClickModalContainer">
-      <Spinner v-if="isLoading" :limited-to-modal="true" size="50px" />
+    <ModalContainer
+      data-test-id="modal-container"
+      @click="onClickModalContainer"
+    >
+      <Spinner
+        v-if="isLoading"
+        data-test-id="banner_spinner"
+        :limited-to-modal="true"
+        size="50px"
+      />
       <ContentContainer :visible="!isLoading">
         <slot></slot>
       </ContentContainer>
-      <CloseButton v-if="!hideClose" class="close" @click="onCloseModal()" />
+      <CloseButton
+        v-if="!hideClose"
+        class="close"
+        data-test-id="banner_close_button"
+        @click="onCloseModal()"
+      />
     </ModalContainer>
   </PageWrapper>
 </template>
 
 <script>
-  // Rules: (as defined in https://e-turnity.atlassian.net/browse/EPDM-9694)
-  // 1. On clicking the “escape” key, close the modal onCloseModal()
-  // 2. Always prevent outside close
-  // import Modal from "@eturnity/eturnity_reusable_components/src/components/modals/modal"
-  // This is a more flexible modal box, where the parent can decide how the body of the modal looks
   // To use:
-  // <modal :isOpen="isOpen" @on-close="$emit('on-close-summary')" :isLoading="true" :hideClose="true" :stopPropagation="false">
-  //   <div>Data....</div>
-  // </modal>
+  // import RCBanner from "@eturnity/eturnity_reusable_components/src/components/banner/banner"
+  // <RCBanner
+  //   backdrop="white" // white, dark
+  //   :hideClose="true"
+  //   :isLoading="true"
+  //   :isOpen="true"
+  //   position="fixed"
+  //   stopPropagation="false"
+  //   @on-close="handleClose"
+  // />
 
   import styled from 'vue3-styled-components'
   import CloseButton from '../../buttons/closeButton'
@@ -33,6 +49,7 @@
   const contentAttrs = { visible: Boolean }
   const ContentContainer = styled('div', contentAttrs)`
     visibility: ${(props) => (props.visible ? 'inherit' : 'hidden')};
+    color: red;
   `
 
   const pageAttrs = { isOpen: Boolean, backdrop: String, position: String }
@@ -129,23 +146,23 @@
     },
     props: {
       isOpen: {
-        required: true,
+        type: Boolean,
         default: false,
       },
       isLoading: {
-        required: false,
+        type: Boolean,
         default: false,
       },
       hideClose: {
-        required: false,
+        type: Boolean,
         default: false,
       },
       backdrop: {
-        required: false,
+        type: String,
         default: 'white',
       },
       position: {
-        required: false,
+        type: String,
         default: 'fixed',
       },
       stopPropagation: {