Feat: Add support for initialization onBeforeMount ✨ (#37)

* feat: Add support for initialization onBeforeMount ✨

- If onBeforeMount is true, initialization occurs onBeforeMount.
- Otherwise, the composable initializes onMounted

* Minor refactor. Also replaces relative imports

Author: nickap

README.md

@@ -1,17 +1,24 @@
 # Enhance User Engagement with Exit Intent Detection.
+
 ### A composable to show your modal when a user is about to leave the page or another threshold reached.
+
 [Demo](https://vue-exit-intent.netlify.app/)
 
 The very first version of this package created in favor of [this](https://dev.to/nickap/exit-intent-pop-up-how-to-publish-on-npm-vue-3-3bhm) old guide. [Here](https://dev.to/nickap/use-vue-exit-intent-a-vue-composable-to-power-your-exit-intent-content-4hlh) is an updated article regarding the latest version.
 
 # Usage
+
 ### Import the composable and show your content according to the value of `isShowing`.
+
 ## Add the package
+
 ```
 npm i vue-exit-intent
 ```
+
 ## Use the composable
-``` javascript
+
+```javascript
 <sript setup lang="ts">
 import { useVueExitIntent } from 'vue-exit-intent'
 
@@ -22,15 +29,18 @@ const options = {
 
 const { isShowing, close } = useVueExitIntent(options);
 </script>
-```  
-``` html
+```
+
+```html
 <template>
   <yourModalPopUp v-if="isShowing" @close="close"></yourModalPopUp>
 </template>
-```  
+```
 
 ## Available helpers
+
 If you use all available helpers your code would look like this:
+
 ```javascript
 const {
   isShowing,
@@ -41,76 +51,87 @@ const {
   unsubscribe
 } = useVueExitIntent(options);
 ```
+
 `isShowing`: a reactive boolean ref that tracks whether the exit intent popup is currently visible.  
 `isAllowedToGetTriggered`: a reactive boolean ref that tracks whether the exit intent popup is allowed to trigger.  
 `isUnsubscribed`: a reactive boolean ref that tracks whether the user has unsubscribed from the exit intent popup.  
 `close`: a function that closes the exit intent popup and resets any related states (e.g. the isShowing ref).  
 `resetState`: a function that resets all state related to the exit intent popup (e.g. isShowing, isAllowedToGetTriggered, isUnsubscribed).  
-`unsubscribe`: a function that unsubscribes the user from the exit intent popup.  
+`unsubscribe`: a function that unsubscribes the user from the exit intent popup.
+
 ## Options
-| Key | Default Value | Type | Required |
-| --- | --- | --- | --- |
-| **repeatAfterDays** | 7 | Number | false |
-| **scrollPercentageToTrigger** | 0 | Number | false |
-| **delaySecondsAndTrigger** | 0 | Number | false |
-| **triggerOnExitIntent** | true | Boolean | false |
-| **touchDeviceSensitivity** | 15 | Number  | false |
-| **scrollDebounceMillis** | 300 | Number | false |
-| **triggerOnPageLoad** | false | Boolean | false |
-| **handleScrollBars** | false | Boolean | false |
-| **LSItemKey** | 'vue-exit-intent' | String  | false |
+
+| Key                           | Default Value     | Type    | Required |
+| ----------------------------- | ----------------- | ------- | -------- |
+| **repeatAfterDays**           | 7                 | Number  | false    |
+| **scrollPercentageToTrigger** | 0                 | Number  | false    |
+| **delaySecondsAndTrigger**    | 0                 | Number  | false    |
+| **triggerOnExitIntent**       | true              | Boolean | false    |
+| **touchDeviceSensitivity**    | 15                | Number  | false    |
+| **scrollDebounceMillis**      | 300               | Number  | false    |
+| **triggerOnPageLoad**         | false             | Boolean | false    |
+| **handleScrollBars**          | false             | Boolean | false    |
+| **LSItemKey**                 | 'vue-exit-intent' | String  | false    |
+| **setupBeforeMount**          | false             | Boolean | false    |
 
 ### Options Description
+
 - **repeatAfterDays**  
-After how many days you want the popup to get triggered again.  
-When a user gets the popup that exact timestamp is stored in localstorage and its taken into account next time the user will visit your page.  
-Giving a zero, the popup will be shown only once! Until the localstrage of the user gets cleared/resets.  
-**Give 0 to disable.**  
-**This one runs a CHECK before show.**
+  After how many days you want the popup to get triggered again.  
+  When a user gets the popup that exact timestamp is stored in localstorage and its taken into account next time the user will visit your page.  
+  Giving a zero, the popup will be shown only once! Until the localstrage of the user gets cleared/resets.  
+  **Give 0 to disable.**  
+  **This one runs a CHECK before show.**
 
 - **scrollPercentageToTrigger**  
-A scroll percentage that if reached by the user, the pop-up will get triggered.  
-**Give 0 to disable.**  
-**This one TRIGGERS the popup.**
+  A scroll percentage that if reached by the user, the pop-up will get triggered.  
+  **Give 0 to disable.**  
+  **This one TRIGGERS the popup.**
 
 - **delaySecondsAndTrigger**  
-Trigger the pop-up after a short delay in seconds, once the page has loaded.  
-**Give 0 to disable.**  
-**This one TRIGGERS the popup.**
+  Trigger the pop-up after a short delay in seconds, once the page has loaded.  
+  **Give 0 to disable.**  
+  **This one TRIGGERS the popup.**
 
 - **touchDeviceSensitivity**  
-On touch devices where there is no mouseleave event, the popup will get triggered on fast (touch)scroll up.
-The larger the number you will give, the more sesitive will be the pop-up on touch devices.  
-**Give 0 to disable.**  
-**This one TRIGGERS the popup on touch devices.**
+  On touch devices where there is no mouseleave event, the popup will get triggered on fast (touch)scroll up.
+  The larger the number you will give, the more sesitive will be the pop-up on touch devices.  
+  **Give 0 to disable.**  
+  **This one TRIGGERS the popup on touch devices.**
 
 - **triggerOnExitIntent**  
-If false. Mouse out event, and scroll-up-fast for touch devices, will not trigger the pop-up. The user would have to reach delaySecondsAndTrigger or scrollPercentageToTrigger to get the popup.
-If true, your modal pop-up is set to get triggered on user exit-intent.  
-**This one TRIGGERS the popup.**
+  If false. Mouse out event, and scroll-up-fast for touch devices, will not trigger the pop-up. The user would have to reach delaySecondsAndTrigger or scrollPercentageToTrigger to get the popup.
+  If true, your modal pop-up is set to get triggered on user exit-intent.  
+  **This one TRIGGERS the popup.**
 
 - **scrollDebounceMillis**  
-Time in milliseconds to debounce user's scrolling  
+  Time in milliseconds to debounce user's scrolling
 
 - **triggerOnPageLoad**  
-Show your modal pop-up immediately When a user visits your page.  
-**This one TRIGGERS the popup.**
+  Show your modal pop-up immediately When a user visits your page.  
+  **This one TRIGGERS the popup.**
 
 - **handleScrollBars**  
-Composable will handle the value of: `document.body.style.overflowY`.  
-Will be eather `auto` (when isShowing is `false`), or `hidden` (when isShowing is `true`)
+  Composable will handle the value of: `document.body.style.overflowY`.  
+  Will be eather `auto` (when isShowing is `false`), or `hidden` (when isShowing is `true`)
 
 - **LSItemKey**  
-Key of Local Storage item.
-You can use a different key to show multiple pop-ups with different behaviour/content.
+  Key of Local Storage item.
+  You can use a different key to show multiple pop-ups with different behaviour/content.
+
+- **setupBeforeMount**  
+  Determines whether the initialization of the composable occurs during the `onBeforeMount` lifecycle hook instead of the default `onMounted` hook.  
+  This options allows you to set up the exit intent before your component is mounted.
 
 ## Contribute
-Feel free to contribute, message me for your ideas.  
-- Write tests.  
-- Report bugs.  
-- Share this project.  
-- Give a star if you like it.  
-- Improve the documentation.  
+
+Feel free to contribute, message me for your ideas.
+
+- Write tests.
+- Report bugs.
+- Share this project.
+- Give a star if you like it.
+- Improve the documentation.
 - Open an issue if you have any.
 
 # Instructions for Contributors
@@ -138,14 +159,17 @@ npm run build
 ```sh
 npm run lint
 ```
+
 ## Recommended IDE Setup
 
 [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
 
 ## Customize configuration
 
 See [Vite Configuration Reference](https://vitejs.dev/config/).
+
 ## License
+
 ```
 The MIT License (MIT)
 
@@ -156,4 +180,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-```
+```

src/App.vue

@@ -1,6 +1,6 @@
 <script lang="ts" setup>
-import modalPopUp from './components/modalPopUp.vue';
-import { useVueExitIntent } from './composables/useVueExitIntent.js';
+import modalPopUp from '@/components/modalPopUp.vue';
+import { useVueExitIntent } from '@/composables/useVueExitIntent.js';
 
 const LSItemKey = 'demo-vue-exit-intent';
 

src/composables/useVueExitIntent.ts

@@ -1,16 +1,16 @@
-import { ref, onMounted, watch } from 'vue';
+import { ref, onMounted, watch, onBeforeMount } from 'vue';
 import {
   defaultOptions,
   isTouchDevice,
   isLocalStorageExpired,
   mouseHandler,
   scrollHandler,
   touchDeviceHandler
-} from '../utils/';
-import type { IOptions, IUserOptions } from '../types';
+} from '@/utils';
+import type { Options } from '@/types';
 
-export function useVueExitIntent(userOptions: IUserOptions = {}) {
-  const options: IOptions = { ...defaultOptions, ...userOptions };
+export function useVueExitIntent(userOptions: Partial<Options> = {}) {
+  const options: Options = { ...defaultOptions, ...userOptions };
 
   const unsubscribedLSItemKey: string = options.LSItemKey + '-unsubscribed';
 
@@ -54,43 +54,61 @@ export function useVueExitIntent(userOptions: IUserOptions = {}) {
     isAllowedToGetTriggered.value = false;
   }
 
-  onMounted(() => {
+  const setup = () => {
     const unsubscribedValue = localStorage.getItem(unsubscribedLSItemKey);
     isUnsubscribed.value = unsubscribedValue
       ? JSON.parse(unsubscribedValue)
       : false;
 
     isAllowedToGetTriggered.value =
       isLocalStorageExpired(options) && !isUnsubscribed.value;
-  });
+  };
 
-  watch(isAllowedToGetTriggered, (newValue) => {
-    if (newValue) {
-      if (options.triggerOnExitIntent) {
-        if (options.touchDeviceSensitivity && isTouchDevice()) {
-          addTouchListeners();
-        } else {
-          addMouseListener();
-        }
-      }
-      if (options.delaySecondsAndTrigger) {
-        setTimeout(() => {
-          fire();
-        }, options.delaySecondsAndTrigger * 1000);
+  const initialize = () => {
+    if (options.triggerOnExitIntent) {
+      if (options.touchDeviceSensitivity && isTouchDevice()) {
+        addTouchListeners();
+      } else {
+        addMouseListener();
       }
-      if (options.triggerOnPageLoad) {
+    }
+    if (options.delaySecondsAndTrigger) {
+      setTimeout(() => {
         fire();
-      }
-      if (options.scrollPercentageToTrigger) {
-        addScrollListener();
-      }
+      }, options.delaySecondsAndTrigger * 1000);
+    }
+    if (options.triggerOnPageLoad) {
+      fire();
+    }
+    if (options.scrollPercentageToTrigger) {
+      addScrollListener();
+    }
+  };
+
+  const disable = () => {
+    removeMouseLeaveListeners();
+    removeScrollListeners();
+    removeTouchDeviceListeners();
+  };
+
+  watch(isAllowedToGetTriggered, (newValue) => {
+    if (newValue) {
+      initialize();
     } else {
-      removeMouseLeaveListeners();
-      removeScrollListeners();
-      removeTouchDeviceListeners();
+      disable();
     }
   });
 
+  if (options.setupBeforeMount) {
+    onBeforeMount(() => {
+      setup();
+    });
+  } else {
+    onMounted(() => {
+      setup();
+    });
+  }
+
   return {
     isShowing,
     isAllowedToGetTriggered,

src/index.ts

@@ -1 +1 @@
-export { useVueExitIntent } from './composables/useVueExitIntent';
+export { useVueExitIntent } from '@/composables/useVueExitIntent';

src/main.ts

@@ -1,4 +1,4 @@
 import { createApp } from 'vue';
-import App from './App.vue';
+import App from '@/App.vue';
 
 createApp(App).mount('#app');

src/tests/composables/useVueExitIntent/basic.spec.ts

@@ -11,7 +11,6 @@ describe('useVueExitIntent composable basic funcionality', () => {
     const userOptions = { ...defaultOptions };
 
     const App = {
-      // TODO: Fix the need to have a template? Why to have a mounted hook?
       template: `<div></div>`,
       setup() {
         const { isShowing, isAllowedToGetTriggered, isUnsubscribed } =

src/tests/composables/useVueExitIntent/setupBeforeMount.spec.ts

@@ -0,0 +1,40 @@
+import { test, expect, describe, afterEach } from 'vitest';
+import { useVueExitIntent } from '@/composables/useVueExitIntent';
+import { defaultOptions } from '@/utils';
+import { shallowMount } from '@vue/test-utils';
+
+describe('Respects option setupBeforeMount', () => {
+  afterEach(() => {
+    localStorage.clear();
+  });
+
+  test('Initializes correctly when setupBeforeMount is true', async () => {
+    const userOptions = {
+      ...defaultOptions,
+      setupBeforeMount: true,
+      triggerOnPageLoad: true
+    };
+
+    const App = {
+      template: `<div></div>`,
+      setup() {
+        const { isShowing, isAllowedToGetTriggered, isUnsubscribed } =
+          useVueExitIntent(userOptions);
+        return {
+          isShowing,
+          isAllowedToGetTriggered,
+          isUnsubscribed
+        };
+      }
+    };
+
+    const wrapper = await shallowMount(App);
+
+    const { isShowing, isAllowedToGetTriggered, isUnsubscribed } = wrapper.vm;
+
+    expect(isShowing).toBe(true);
+    expect(isAllowedToGetTriggered).toBe(false);
+    expect(isUnsubscribed).toBe(false);
+    expect(localStorage.getItem(userOptions.LSItemKey)).toBeTruthy();
+  });
+});