178

How can I detect a click outside my element? I'm using Vue.js so it's gonna be outside my templates element. I know how to do it in Vanilla JS, but I'm not sure if there's a more proper way to do it, when I'm using Vue.js?

This is the solution for Vanilla JS: Javascript Detect Click event outside of div

I guess I can use a better way to access the element?

Community
  • 1
  • 1
  • Vue components are isolated. so detecting outside changes is out of question and anti pattern is used. – Raj Kamal Mar 23 '16 at 06:09
  • Thanks. I'm not sure though how to implement it in a Vue component. There must still be some best practices for the anti-pattern? –  Mar 23 '16 at 06:23
  • Vue.js component are isolated, thats true, but there are different methods for parent-child communication. So, instead of asking to detect an event outside of an element, you should specify if you want to detect elements inside a component, from the parent component, from some child, or whatever relation is between components – Yerko Palma Mar 23 '16 at 11:50
  • Thanks for the feedback. Do you have some examples or links I can follow up on? –  Mar 23 '16 at 13:13
  • https://github.com/simplesmiler/vue-clickaway can simplify your job – Raj Kamal Apr 06 '16 at 09:15
  • there beautiful plugin there vue click outside -> https://www.npmjs.com/package/v-click-outside – Sandesh Mankar Oct 08 '21 at 02:39

33 Answers33

243

There is the solution I used, which is based on Linus Borg answer and works fine with vue.js 2.0.

Vue.directive('click-outside', {
  bind: function (el, binding, vnode) {
    el.clickOutsideEvent = function (event) {
      // here I check that click was outside the el and his children
      if (!(el == event.target || el.contains(event.target))) {
        // and if it did, call method provided in attribute value
        vnode.context[binding.expression](event);
      }
    };
    document.body.addEventListener('click', el.clickOutsideEvent)
  },
  unbind: function (el) {
    document.body.removeEventListener('click', el.clickOutsideEvent)
  },
});

You bind to it using v-click-outside:

<div v-click-outside="doStuff">

Here's a small demo

You can find some more info about custom directives and what el, binding, vnode means in https://vuejs.org/v2/guide/custom-directive.html#Directive-Hook-Arguments

benams
  • 3,868
  • 9
  • 29
  • 71
MadisonTrash
  • 5,126
  • 3
  • 20
  • 25
  • 12
    Worked, but in Vue 2.0 directives no longer have an instance, so this is undefined. https://vuejs.org/v2/guide/migration.html#Custom-Directives-simplified . I have no clue why this fiddle works or when this simplification has been done. (To solve, replace "this" with "el" to bind the event to the element) – Busata Apr 28 '17 at 06:36
  • 4
    It works probably because the window passed as "this". I've fixed the answer. Thank you for pointing out this bug. – MadisonTrash Apr 28 '17 at 06:59
  • thanks for this response. And what if you want to detect left and right click outside the element? do you add a listener on contextmenu as well ? – Bénédicte Lagouge Aug 30 '17 at 09:29
  • I believe `click` is both left and right? https://stackoverflow.com/questions/2405771/is-right-click-a-javascript-event –  Sep 17 '17 at 21:53
  • hi @MadisonTrash. i have implemented your answer in this webpackBin: https://stackoverflow.com/questions/36170425/detect-click-outside-element can you help understand why the function `clickOutside` is being called when clicking on the button, before the component is even mounted? – LiranC Oct 02 '17 at 10:08
  • 10
    Is there a way to exclude specific element outside? For example, I have one button outside which has to open this element and because it triggers both methods nothing happens. – Žilvinas Apr 21 '18 at 16:27
  • What is el.event ? – Sainath S.R May 10 '18 at 10:48
  • 6
    Can you please explain vnode.context[binding.expression](event); ? – Sainath S.R May 10 '18 at 11:06
  • This works only partially for me (not sure if it's browser related but i'm using I.E. 11 and I can't test other browsers atm). The problem is that it doesn't work on white-space that is below the closing body tag. So I used vue-clickaway mentioned by @JulienLeCoupanec instead. – matrix4use Jul 26 '18 at 22:49
  • 1
    how to change this so that an expression can be used instead of a method within the v-click-outside is triggered? – sigmaxf Aug 15 '18 at 00:11
  • How can I use this from within a Vue component (I'm using Vue CLI 3)? – Clifton Labrum May 19 '19 at 04:33
  • 1
    `el == event.target` is superfluous. `el.contains(event.target)` checks whether the given node (event.target) is the node itself (el) or one of its children. Other than that, great solution. – Maksim Ivanov Aug 09 '19 at 20:21
  • 1
    This is working perfectly. But when I'm using plugins like vue-datepicker, on selecting a date, the outside click is triggering. Any solution for this? – Rijosh Apr 01 '20 at 06:49
  • If you want a button or something external to the menu to *not* trigger the directive callback, you can do something like `if (event.target.id !== 'myButton' && !(el == event.target || el.contains(event.target))) { ... }` – d512 Jul 22 '20 at 22:02
  • 1
    This answer should be removed as it no longer works. You are doing SO users a disservice by leaving broken code as an answer. – Hybrid web dev Sep 23 '20 at 01:19
  • @Hybridwebdev, If you think entire world is using the latest version of vue, I have some news for you. – Mat J Jun 10 '21 at 06:05
  • @Žilvinas Yeah, just do `event.stopPropagation()` on the toggle button – Sw0ut Jul 08 '21 at 07:50
  • 1
    It doesn't work for absolute positioned children of the element. – Jarvis Nov 17 '21 at 20:13
  • this derivative code need to be added in main.js file – Tarun Jain May 12 '22 at 13:30
134

Keep in attention that this solution only works with Vue 1.

Can be solved nicely by setting up a custom directive once:

Vue.directive('click-outside', {
  bind () {
      this.event = event => this.vm.$emit(this.expression, event)
      this.el.addEventListener('click', this.stopProp)
      document.body.addEventListener('click', this.event)
  },   
  unbind() {
    this.el.removeEventListener('click', this.stopProp)
    document.body.removeEventListener('click', this.event)
  },

  stopProp(event) { event.stopPropagation() }
})

Usage:

<div v-click-outside="nameOfCustomEventToCall">
  Some content
</div>

In the component:

events: {
  nameOfCustomEventToCall: function (event) {
    // do something - probably hide the dropdown menu / modal etc.
  }
}

Working Demo on JSFiddle with additional info about caveats:

https://jsfiddle.net/Linusborg/yzm8t8jq/

Ivo Pereira
  • 3,301
  • 1
  • 18
  • 24
Linus Borg
  • 22,308
  • 7
  • 60
  • 48
  • 3
    I did use the vue clickaway, but I think your solution is more or less the same. Thanks. –  May 27 '16 at 04:11
  • 69
    This approach doesn't work anymore in Vue.js 2. The self.vm.$emit call gives an error message. – northernman Dec 26 '16 at 07:56
  • 5
    Using @blur is also an option and makes it way easier giving the same result: where hide: function() { this.isActive = false; } – Craws Dec 12 '18 at 15:03
  • 7
    The answer should be edited to state that i'ts only for Vue.js 1 – Stéphane Gerber Mar 26 '20 at 15:30
  • Tried this on vue 1, it fires the event even if you click on the component itself: I used it to close a dropdown and even when I click to focus, the event is fired and it closes immediately. I know it's been a while but do we have any solution for this? – Fabio R. May 17 '22 at 11:07
133

Add tabindex attribute to your component so that it can be focused and do the following:

<template>
    <div
        @focus="handleFocus"
        @focusout="handleFocusOut"
        tabindex="0"
    >
      SOME CONTENT HERE
    </div>
</template>

<script>
export default {    
    methods: {
        handleFocus() {
            // do something here
        },
        handleFocusOut() {
            // do something here
        }
    }
}
</script>
G'ofur N
  • 2,124
  • 3
  • 12
  • 20
  • 10
    Whoa! I find this as the shortest and most clean solution. Also the only one that worked in my case. – Matt Komarnicki Jan 12 '19 at 03:40
  • 5
    Just to add onto this, setting a tabindex of -1 will stop the highlight box from appearing when you click on the element, but it will still allow the div to be focusable. – Colin Apr 29 '19 at 19:28
  • 2
    For some reason tabindex of -1 doesn't hide the outline for me, so I just added `outline: none;` on focus for the element. – Art3mix Aug 06 '19 at 20:36
  • 1
    how can we apply this to an off-canvas side nav that slides onto the screen? I am unable to give the sidenav focus unless it is clicked, – Charles Okwuagwu Oct 18 '19 at 22:48
  • 1
    This is the most powerful way absolutely. Thank you! :) – Canet Robern Jul 02 '20 at 13:12
  • you can use `tabindex="-1"`, if you don't want to focus when you press `Tab`. – Akshdeep Singh Aug 02 '20 at 21:36
  • 1
    OHHHHHHHHHH! This should be the first answer. – Bruja Sep 04 '20 at 23:21
  • 1
    This is the real MVP. – SimonDepelchin Apr 13 '21 at 09:07
  • This works, but in my case focusout is only calling when I first trigger @focus. Any solution for that? – Keyur May 19 '21 at 15:43
  • 1
    Excellent solution. Works with Vue 3, easy to implement. – Siniša Oct 01 '21 at 06:49
  • @Keyur when you show the component, you can trigger focus programatically. In my case I had a popup menu as a component, activated by another component on a click. When menu would have it's method show() called, it would also call focus() on it's root div element. This would then make focusout called when user clicks anywhere on the screen outside of the root div element. – Siniša Oct 01 '21 at 06:51
  • Awesome solution, so simple! – James Stewart Oct 05 '21 at 08:28
  • 1
    Brilliant. You can add a ref `
    ` and then give it focus `mounted(){this.$refs.menuOptions.focus();}` so it will capture when you click outside without requiring to focus on it first
    – daniel p Feb 15 '22 at 15:17
31

There are two packages available in the community for this task (both are maintained):

Julien Le Coupanec
  • 7,195
  • 6
  • 47
  • 60
  • 10
    `vue-clickaway` package solved my issue perfectly. Thanks – Abdalla Arbab Jun 09 '18 at 14:31
  • 1
    What about lots of items? Every item with outside click event will fire event on each click. It's nice when you make dialog and terrible when you create gallery. In non-component era we are listening click from document and check what element was clicked. But now it's a pain. – br. Feb 21 '19 at 23:38
  • @Julien Le Coupanec I have found this solution the best by far! Thanks a lot for sharing it! – Manuel Abascal Aug 16 '19 at 16:35
30

For Vue 3:

This answer is based on MadisonTrash's great answer above but updated to use new Vue 3 syntax.

Vue 3 now uses beforeMount instead of bind, and unmounted instead of unbind (src).

const clickOutside = {
  beforeMount: (el, binding) => {
    el.clickOutsideEvent = event => {
      // here I check that click was outside the el and his children
      if (!(el == event.target || el.contains(event.target))) {
        // and if it did, call method provided in attribute value
        binding.value();
      }
    };
    document.addEventListener("click", el.clickOutsideEvent);
  },
  unmounted: el => {
    document.removeEventListener("click", el.clickOutsideEvent);
  },
};

createApp(App)
  .directive("click-outside", clickOutside)
  .mount("#app");
LukeP
  • 10,366
  • 6
  • 27
  • 46
fredrivett
  • 3,456
  • 28
  • 35
  • 1
    Thanks. Works great. I've edited your answer to attach the listener to the document instead of the body (to work everywhere in window on tall screens for example) – LukeP Dec 27 '20 at 19:09
  • This works fine! I'm using this directive to close modals and menus, that wasn't mounted initially. And this directive fire "close" event even before the modal was opened, and it doesn't shows up. So I added this code inside modal component to make it work: mounted: function() { setTimeout(() => { this.opened = true; }, 10); }, unmounted: function() { this.opened = false; }, methods: { clickOutside: function() { if (this.opened) { this.$emit("close"); } },} – MAZ Apr 27 '21 at 06:22
15

I did it a slightly different way using a function within created().

  created() {
      window.addEventListener('click', (e) => {
        if (!this.$el.contains(e.target)){
          this.showMobileNav = false
        }
      })
  },

This way, if someone clicks outside of the element, then in my case, the mobile nav is hidden.

Nimantha
  • 5,793
  • 5
  • 23
  • 56
Brad Ahrens
  • 4,307
  • 4
  • 32
  • 40
  • Note: this solution does NOT unbind, which will present memory leaks and other issues in often non-obvious ways. Choose a solution with unbinding/unmounting for future proofing and stabilising your code. – Matthew Spence Sep 16 '21 at 11:10
9

This Worked for me with Vue.js 2.5.2 :

/**
 * Call a function when a click is detected outside of the
 * current DOM node ( AND its children )
 *
 * Example :
 *
 * <template>
 *   <div v-click-outside="onClickOutside">Hello</div>
 * </template>
 *
 * <script>
 * import clickOutside from '../../../../directives/clickOutside'
 * export default {
 *   directives: {
 *     clickOutside
 *   },
 *   data () {
 *     return {
         showDatePicker: false
 *     }
 *   },
 *   methods: {
 *     onClickOutside (event) {
 *       this.showDatePicker = false
 *     }
 *   }
 * }
 * </script>
 */
export default {
  bind: function (el, binding, vNode) {
    el.__vueClickOutside__ = event => {
      if (!el.contains(event.target)) {
        // call method provided in v-click-outside value
        vNode.context[binding.expression](event)
        event.stopPropagation()
      }
    }
    document.body.addEventListener('click', el.__vueClickOutside__)
  },
  unbind: function (el, binding, vNode) {
    // Remove Event Listeners
    document.body.removeEventListener('click', el.__vueClickOutside__)
    el.__vueClickOutside__ = null
  }
}
yann_yinn
  • 134
  • 2
  • 9
  • 1
    Thank you for this example. Checked this on vue 2.6. There is some fix, in the unbind method you must to fix some issue by this (you forgot the body property in the unbind method): document.body.removeEventListener('click', el.__vueClickOutside__); if not - it will cause the multiple event listeners creation after every component recreation (page refresh); – Alexey Shabramov Jul 12 '20 at 09:00
9

I have combined all answers (including a line from vue-clickaway) and came up with this solution that works for me:

Vue.directive('click-outside', {
    bind(el, binding, vnode) {
        var vm = vnode.context;
        var callback = binding.value;

        el.clickOutsideEvent = function (event) {
            if (!(el == event.target || el.contains(event.target))) {
                return callback.call(vm, event);
            }
        };
        document.body.addEventListener('click', el.clickOutsideEvent);
    },
    unbind(el) {
        document.body.removeEventListener('click', el.clickOutsideEvent);
    }
});

Use in component:

<li v-click-outside="closeSearch">
  <!-- your component here -->
</li>
retrovertigo
  • 430
  • 8
  • 17
BogdanG
  • 101
  • 1
  • 3
8

If you're specifically looking for a click outside the element but still within the parent, you can use

<div class="parent" @click.self="onParentClick">
  <div class="child"></div>
</div>

I use this for modals.

Andres Holguin
  • 113
  • 1
  • 5
8

Vue 3 has breaking changes in directives, all of <Vue3 methods were changed/updated. If you wonder, how to do it in Vue 3, Here's the snippet. For information please go through this link

<div v-click-outside="methodToInvoke"></div>

click-outside.js

export default {
  beforeMount: function (el, binding, vnode) {
    binding.event = function (event) {
      if (!(el === event.target || el.contains(event.target))) {
        if (binding.value instanceof Function) {
          binding.value(event)
        }
      }
    }
    document.body.addEventListener('click', binding.event)
  },
  unmounted: function (el, binding, vnode) {
    document.body.removeEventListener('click', binding.event)
  }
}

and In main.js add the following

// Directives
import ClickOutside from './click-outside'

createApp(App)
 .directive('click-outside', ClickOutside)
 .use(IfAnyModules)
 .mount('#app')
Naren
  • 3,562
  • 3
  • 12
  • 25
7

I have updated MadisonTrash's answer to support Mobile Safari (which does not have click event, touchend must be used instead). This also incorporates a check so that the event isn't triggered by dragging on mobile devices.

Vue.directive('click-outside', {
    bind: function (el, binding, vnode) {
        el.eventSetDrag = function () {
            el.setAttribute('data-dragging', 'yes');
        }
        el.eventClearDrag = function () {
            el.removeAttribute('data-dragging');
        }
        el.eventOnClick = function (event) {
            var dragging = el.getAttribute('data-dragging');
            // Check that the click was outside the el and its children, and wasn't a drag
            if (!(el == event.target || el.contains(event.target)) && !dragging) {
                // call method provided in attribute value
                vnode.context[binding.expression](event);
            }
        };
        document.addEventListener('touchstart', el.eventClearDrag);
        document.addEventListener('touchmove', el.eventSetDrag);
        document.addEventListener('click', el.eventOnClick);
        document.addEventListener('touchend', el.eventOnClick);
    }, unbind: function (el) {
        document.removeEventListener('touchstart', el.eventClearDrag);
        document.removeEventListener('touchmove', el.eventSetDrag);
        document.removeEventListener('click', el.eventOnClick);
        document.removeEventListener('touchend', el.eventOnClick);
        el.removeAttribute('data-dragging');
    },
});
benrwb
  • 813
  • 7
  • 15
7
export default {
  bind: function (el, binding, vNode) {
    // Provided expression must evaluate to a function.
    if (typeof binding.value !== 'function') {
      const compName = vNode.context.name
      let warn = `[Vue-click-outside:] provided expression '${binding.expression}' is not a function, but has to be`
      if (compName) { warn += `Found in component '${compName}'` }

      console.warn(warn)
    }
    // Define Handler and cache it on the element
    const bubble = binding.modifiers.bubble
    const handler = (e) => {
      if (bubble || (!el.contains(e.target) && el !== e.target)) {
        binding.value(e)
      }
    }
    el.__vueClickOutside__ = handler

    // add Event Listeners
    document.addEventListener('click', handler)
  },

  unbind: function (el, binding) {
    // Remove Event Listeners
    document.removeEventListener('click', el.__vueClickOutside__)
    el.__vueClickOutside__ = null

  }
}
xiaoyu2er
  • 647
  • 7
  • 6
6

Complete case for vue 3

This is a complete solution based on MadisonTrash answer, and benrwb and fredrivett tweaks for safari compatibility and vue 3 api changes.

Edit:

The solution proposed below is still useful, and the how to use is still valid, but I changed it to use document.elementsFromPoint instead of event.contains because it doesn't recognise as children some elements like the <path> tags inside svgs. So the right directive is this one:

export default {
    beforeMount: (el, binding) => {
        el.eventSetDrag = () => {
            el.setAttribute("data-dragging", "yes");
        };
        el.eventClearDrag = () => {
            el.removeAttribute("data-dragging");
        };
        el.eventOnClick = event => {
            const dragging = el.getAttribute("data-dragging");
            // Check that the click was outside the el and its children, and wasn't a drag
            console.log(document.elementsFromPoint(event.clientX, event.clientY))
            if (!document.elementsFromPoint(event.clientX, event.clientY).includes(el) && !dragging) {
                // call method provided in attribute value
                binding.value(event);
            }
        };
        document.addEventListener("touchstart", el.eventClearDrag);
        document.addEventListener("touchmove", el.eventSetDrag);
        document.addEventListener("click", el.eventOnClick);
        document.addEventListener("touchend", el.eventOnClick);
    },
    unmounted: el => {
        document.removeEventListener("touchstart", el.eventClearDrag);
        document.removeEventListener("touchmove", el.eventSetDrag);
        document.removeEventListener("click", el.eventOnClick);
        document.removeEventListener("touchend", el.eventOnClick);
        el.removeAttribute("data-dragging");
    },
};

Old answer:

Directive

const clickOutside = {
    beforeMount: (el, binding) => {
        el.eventSetDrag = () => {
            el.setAttribute("data-dragging", "yes");
        };
        el.eventClearDrag = () => {
            el.removeAttribute("data-dragging");
        };
        el.eventOnClick = event => {
            const dragging = el.getAttribute("data-dragging");  
            // Check that the click was outside the el and its children, and wasn't a drag
            if (!(el == event.target || el.contains(event.target)) && !dragging) {
                // call method provided in attribute value
                binding.value(event);
            }
        };
        document.addEventListener("touchstart", el.eventClearDrag);
        document.addEventListener("touchmove", el.eventSetDrag);
        document.addEventListener("click", el.eventOnClick);
        document.addEventListener("touchend", el.eventOnClick);
    },
    unmounted: el => {
        document.removeEventListener("touchstart", el.eventClearDrag);
        document.removeEventListener("touchmove", el.eventSetDrag);
        document.removeEventListener("click", el.eventOnClick);
        document.removeEventListener("touchend", el.eventOnClick);
        el.removeAttribute("data-dragging");
    },
}

createApp(App)
  .directive("click-outside", clickOutside)
  .mount("#app");

This solution watch the element and the element's children of the component where the directive is applied to check if the event.target element is also a child. If that's the case it will not trigger, because it's inside the component.

How to use it

You only have to use as any directive, with a method reference to handle the trigger:

<template>
    <div v-click-outside="myMethod">
        <div class="handle" @click="doAnotherThing($event)">
            <div>Any content</div>
        </div>
    </div>
</template>
5

I create a div at the end of the body like that:

<div v-if="isPopup" class="outside" v-on:click="away()"></div>

Where .outside is :

.outside {
  width: 100vw;
  height: 100vh;
  position: fixed;
  top: 0px;
  left: 0px;
}

And away() is a method in Vue instance :

away() {
 this.isPopup = false;
}
Nimantha
  • 5,793
  • 5
  • 23
  • 56
Arnaud LiDz
  • 261
  • 3
  • 10
4

I use this code:

show-hide button

 <a @click.stop="visualSwitch()"> show hide </a>

show-hide element

<div class="dialog-popup" v-if="visualState" @click.stop=""></div>

script

data () { return {
    visualState: false,
}},
methods: {
    visualSwitch() {
        this.visualState = !this.visualState;
        if (this.visualState)
            document.addEventListener('click', this.visualState);
        else
            document.removeEventListener('click', this.visualState);
    },
},

Update: remove watch; add stop propagation

4

There are already many answers to this question, and most of them are based on the similar custom directive idea. The problem with this approach is that one have to pass a method function to the directive, and cannot directly write code as in other events.

I created a new package vue-on-clickout that is different. Check it out at:

It allows one to write v-on:clickout just like any other events. For example, you can write

<div v-on:clickout="myField=value" v-on:click="myField=otherValue">...</div>

and it works.

Update

vue-on-clickout now supports Vue 3!

Update 2

vue-on-clickout is now replaced by a new package Clickout-Event which works for any front-end framework (or vanilla)!

Mu-Tsun Tsai
  • 2,154
  • 1
  • 9
  • 24
  • Just a question on how to implement this; do I need to load the Javascript file (``) completely or can I use `import`? –  Oct 12 '20 at 09:32
  • Clickout-Event does not really export anything, so I didn't design it in a way that can be imported as modules. You directly add the script to your page, preferably in the `` section. Is there a particular reason why you want to use `import` instead? – Mu-Tsun Tsai Oct 12 '20 at 10:01
  • I don't need it on each page and because it's in the node_modules directory, it's not available in the public directory by default, so I still need to copy the file manually –  Oct 12 '20 at 12:50
  • Yes; I hope that's not too much of a trouble. – Mu-Tsun Tsai Oct 12 '20 at 14:23
  • It's not, but an import would be nice. especially when the package is updated it makes life easier. –  Oct 13 '20 at 06:27
  • OK, I shall take that as a feature request; thanks for your feedback :) – Mu-Tsun Tsai Oct 13 '20 at 12:53
  • You can now use `import 'clickout-event';` to add it to your project – Mu-Tsun Tsai Aug 18 '21 at 03:20
  • This is a really awesome package ... saved me a lot of headaches – Kolawole Emmanuel Izzy May 22 '22 at 17:17
4

I hate additional functions so... here is an awesome vue solution without an additional vue methods, only var

  1. create html element, set controls and directive
    <p @click="popup = !popup" v-out="popup">

    <div v-if="popup">
       My awesome popup
    </div>
  1. create a var in data like
data:{
   popup: false,
}
  1. add vue directive. its
Vue.directive('out', {

    bind: function (el, binding, vNode) {
        const handler = (e) => {
            if (!el.contains(e.target) && el !== e.target) {
                //and here is you toggle var. thats it
                vNode.context[binding.expression] = false
            }
        }
        el.out = handler
        document.addEventListener('click', handler)
    },

    unbind: function (el, binding) {
        document.removeEventListener('click', el.out)
        el.out = null
    }
})
Martin Prestone
  • 3,491
  • 2
  • 7
  • 8
3

You can register two event listeners for click event like this

document.getElementById("some-area")
        .addEventListener("click", function(e){
        alert("You clicked on the area!");
        e.stopPropagation();// this will stop propagation of this event to upper level
     }
);

document.body.addEventListener("click", 
   function(e) {
           alert("You clicked outside the area!");
         }
);
saravanakumar
  • 1,727
  • 4
  • 20
  • 35
3

The short answer: This should be done with Custom Directives.

There are a lot of great answers here that also say this, but most of the answers I have seen break down when you start using outside-click extensively (especially layered or with multiple excludes). I have written an article on medium talking about the nuances of Custom Directives and specifically implementation of this one. It may not cover all edge cases but it has covered everything I have thought up.

This will account for multiple bindings, multiple levels of other element exclusions and allow your handler to only manage the "business logic".

Here's the code for at least the definition portion of it, check out the article for full explanation.

var handleOutsideClick={}
const OutsideClick = {
  // this directive is run on the bind and unbind hooks
  bind (el, binding, vnode) {
    // Define the function to be called on click, filter the excludes and call the handler
    handleOutsideClick[el.id] = e => {
      e.stopPropagation()
      // extract the handler and exclude from the binding value
      const { handler, exclude } = binding.value
      // set variable to keep track of if the clicked element is in the exclude list
      let clickedOnExcludedEl = false
      // if the target element has no classes, it won't be in the exclude list skip the check
      if (e.target._prevClass !== undefined) {
        // for each exclude name check if it matches any of the target element's classes
        for (const className of exclude) {
          clickedOnExcludedEl = e.target._prevClass.includes(className)
          if (clickedOnExcludedEl) {
            break // once we have found one match, stop looking
          }
        }
      }
      // don't call the handler if our directive element contains the target element
      // or if the element was in the exclude list
      if (!(el.contains(e.target) || clickedOnExcludedEl)) {
        handler()
      }
    }
    // Register our outsideClick handler on the click/touchstart listeners
    document.addEventListener('click', handleOutsideClick[el.id])
    document.addEventListener('touchstart', handleOutsideClick[el.id])
    document.onkeydown = e => {
      //this is an option but may not work right with multiple handlers
      if (e.keyCode === 27) {
        // TODO: there are minor issues when escape is clicked right after open keeping the old target
        handleOutsideClick[el.id](e)
      }
    }
  },
  unbind () {
    // If the element that has v-outside-click is removed, unbind it from listeners
    document.removeEventListener('click', handleOutsideClick[el.id])
    document.removeEventListener('touchstart', handleOutsideClick[el.id])
    document.onkeydown = null //Note that this may not work with multiple listeners
  }
}
export default OutsideClick
3

For those using Vue 3.

Vue3 has changed the syntax for Directive Hooks:

  • Bind -> beforeMount
  • Unbind -> unmounted

To detect a click outside an element in Vue 3:

click-outside.js

export default function directive(app) {
  // you can name the directive whatever you want. -> click-outside
  app.directive('click-outside', {
    beforeMount(el, binding) {
      el.clickOutsideEvent = (evt) => {
        evt.stopPropagation();
        if (!(el === evt.target || el.contains(evt.target))) {
          binding.value(evt, el);
        }
      };
      window.requestAnimationFrame(() => {
        document.addEventListener("click", el.clickOutsideEvent);
      });
    },
    unmounted(el) {
      document.removeEventListener("click", el.clickOutsideEvent);
    },
  })
}

Register directive:

main.js

import { createApp } from "vue";
import App from "./App.vue";

// Import your directive, in order to register it.
import clickOutside from "./directives/click-outside.js"

createApp(App).use(clickOutside).mount("#app");

Usage:

<template>
  <div class="dropdown" v-click-outside="() => hideDropdown()"></div>
</template>
<script setup>
  function hideDropdown() {
    console.log("close dropdown")
  }
</script>

### OR 

<script>
  methods: {
    hideDropdown() {
      console.log("close dropdown")
    }
  }
</script> 
Martin Seydo
  • 398
  • 3
  • 9
2

You can emit custom native javascript event from a directive. Create a directive that dispatches an event from the node, using node.dispatchEvent

let handleOutsideClick;
Vue.directive('out-click', {
    bind (el, binding, vnode) {

        handleOutsideClick = (e) => {
            e.stopPropagation()
            const handler = binding.value

            if (el.contains(e.target)) {
                el.dispatchEvent(new Event('out-click')) <-- HERE
            }
        }

        document.addEventListener('click', handleOutsideClick)
        document.addEventListener('touchstart', handleOutsideClick)
    },
    unbind () {
        document.removeEventListener('click', handleOutsideClick)
        document.removeEventListener('touchstart', handleOutsideClick)
    }
})

Which can be used like this

h3( v-out-click @click="$emit('show')" @out-click="$emit('hide')" )
2

If you have a component with multiple elements inside of the root element you can use this It just works™ solution with a boolean.

<template>
  <div @click="clickInside"></div>
<template>
<script>
export default {
  name: "MyComponent",
  methods: {
    clickInside() {
      this.inside = true;
      setTimeout(() => (this.inside = false), 0);
    },
    clickOutside() {
      if (this.inside) return;
      // handle outside state from here
    }
  },
  created() {
    this.__handlerRef__ = this.clickOutside.bind(this);
    document.body.addEventListener("click", this.__handlerRef__);
  },
  destroyed() {
    document.body.removeEventListener("click", this.__handlerRef__);
  },
};
</script>
A1rPun
  • 15,440
  • 6
  • 55
  • 87
2
  <button 
    class="dropdown"
    @click.prevent="toggle"
    ref="toggle"
    :class="{'is-active': isActiveEl}"
  >
    Click me
  </button>

  data() {
   return {
     isActiveEl: false
   }
  }, 
  created() {
    window.addEventListener('click', this.close);
  },
  beforeDestroy() {
    window.removeEventListener('click', this.close);
  },
  methods: {
    toggle: function() {
      this.isActiveEl = !this.isActiveEl;
    },
    close(e) {
      if (!this.$refs.toggle.contains(e.target)) {
        this.isActiveEl = false;
      }
    },
  },
Dmytro Lishtvan
  • 780
  • 8
  • 12
1

Frequently people want to know if user leave root component (works with any level components)

Vue({
  data: {},
  methods: {
    unfocused : function() {
      alert('good bye');
    }
  }
})
<template>
  <div tabindex="1" @blur="unfocused">Content inside</div>
</template>
Nimantha
  • 5,793
  • 5
  • 23
  • 56
0

Just if anyone is looking how to hide modal when clicking outside the modal. Since modal usually has its wrapper with class of modal-wrap or anything you named it, you can put @click="closeModal" on the wrapper. Using event handling stated in vuejs documentation, you can check if the clicked target is either on the wrapper or on the modal.

methods: {
  closeModal(e) {
    this.event = function(event) {
      if (event.target.className == 'modal-wrap') {
        // close modal here
        this.$store.commit("catalog/hideModal");
        document.body.removeEventListener("click", this.event);
      }
    }.bind(this);
    document.body.addEventListener("click", this.event);
  },
}
<div class="modal-wrap" @click="closeModal">
  <div class="modal">
    ...
  </div>
<div>
jedi
  • 143
  • 1
  • 1
  • 8
0

I am using this package : https://www.npmjs.com/package/vue-click-outside

It works fine for me

HTML :

<div class="__card-content" v-click-outside="hide" v-if="cardContentVisible">
    <div class="card-header">
        <input class="subject-input" placeholder="Subject" name=""/>
    </div>
    <div class="card-body">
        <textarea class="conversation-textarea" placeholder="Start a conversation"></textarea>
    </div>
</div>

My script codes :

import ClickOutside from 'vue-click-outside'
export default
{
    data(){
        return {
            cardContentVisible:false
        }
    },
    created()
    {
    },
    methods:
        {
            openCardContent()
            {
                this.cardContentVisible = true;
            }, hide () {
            this.cardContentVisible = false
                }
        },
    directives: {
            ClickOutside
    }
}
Zoe stands with Ukraine
  • 25,310
  • 18
  • 114
  • 149
Murad Shukurlu
  • 344
  • 5
  • 10
0

@Denis Danilenko solutions works for me, here's what I did: By the way I'm using VueJS CLI3 and NuxtJS here and with Bootstrap4, but it will work on VueJS without NuxtJS also:

<div
    class="dropdown ml-auto"
    :class="showDropdown ? null : 'show'">
    <a 
        href="#" 
        class="nav-link" 
        role="button" 
        id="dropdownMenuLink" 
        data-toggle="dropdown" 
        aria-haspopup="true" 
        aria-expanded="false"
        @click="showDropdown = !showDropdown"
        @blur="unfocused">
        <i class="fas fa-bars"></i>
    </a>
    <div 
        class="dropdown-menu dropdown-menu-right" 
        aria-labelledby="dropdownMenuLink"
        :class="showDropdown ? null : 'show'">
        <nuxt-link class="dropdown-item" to="/contact">Contact</nuxt-link>
        <nuxt-link class="dropdown-item" to="/faq">FAQ</nuxt-link>
    </div>
</div>
export default {
    data() {
        return {
            showDropdown: true
        }
    },
    methods: {
    unfocused() {
        this.showDropdown = !this.showDropdown;
    }
  }
}
0

Use this package vue-click-outside

It's simple and reliable, currently used by many other packages. You can also reduce your javascript bundle size by calling the package only in the required components (see example below).

npm install vue-click-outside

Usage :

<template>
  <div>
    <div v-click-outside="hide" @click="toggle">Toggle</div>
    <div v-show="opened">Popup item</div>
  </div>
</template>

<script>
import ClickOutside from 'vue-click-outside'

export default {
  data () {
    return {
      opened: false
    }
  },

  methods: {
    toggle () {
      this.opened = true
    },

    hide () {
      this.opened = false
    }
  },

  mounted () {
    // prevent click outside event with popupItem.
    this.popupItem = this.$el
  },

  // do not forget this section
  directives: {
    ClickOutside
  }
}
</script>
Smit Patel
  • 1,568
  • 13
  • 20
0

Don't reinvent the wheel, use this package v-click-outside

snehanshu.js
  • 127
  • 1
  • 11
0

You can create new component which handle outside click

Vue.component('click-outside', {
  created: function () {
    document.body.addEventListener('click', (e) => {
       if (!this.$el.contains(e.target)) {
            this.$emit('clickOutside');
           
        })
  },
  template: `
    <template>
        <div>
            <slot/>
        </div>
    </template>
`
})

And use this component:

<template>
    <click-outside @clickOutside="console.log('Click outside Worked!')">
      <div> Your code...</div>
    </click-outside>
</template>
0

I'm not sure if someone will ever see this answer but here it is. The idea here is to simply detect if any click was done outside the element itself.

I first start by giving an id to the main div of my "dropdown".

<template>
  <div class="relative" id="dropdown">
    <div @click="openDropdown = !openDropdown" class="cursor-pointer">
      <slot name="trigger" />
    </div>

    <div
      class="absolute mt-2 w-48 origin-top-right right-0 text-red  bg-tertiary text-sm text-black"
      v-show="openDropdown"
      @click="openDropdown = false"
    >
      <slot name="content" />
    </div>
  </div>
</template>

And then I just loop thru the path of the mouse event and see if the div with my id "dropdown" is there. If it is, then we good, if it is no, then we close the dropdown.

<script>
export default {
  data() {
    return {
      openDropdown: false,
    };
  },
  created() {
    document.addEventListener("click", (e) => {
      let me = false;
      for (let index = 0; index < e.path.length; index++) {
        const element = e.path[index];

        if (element.id == "dropdown") {
          me = true;
          return;
        }
      }

      if (!me) this.openDropdown = false;
    });
  }
};
</script>

I'm pretty sure this can bring performance issues if you have many nested elements, but I found this as the most lazy-friendly way of doing it.

-1

I have a solution for handling toggle dropdown menu:

export default {
data() {
  return {
    dropdownOpen: false,
  }
},
methods: {
      showDropdown() {
        console.log('clicked...')
        this.dropdownOpen = !this.dropdownOpen
        // this will control show or hide the menu
        $(document).one('click.status', (e)=> {
          this.dropdownOpen = false
        })
      },
}
Nicolas S.Xu
  • 12,570
  • 27
  • 76
  • 122
-1

Now you should use the vue-click-outside plugin for this.

  1. you can run an event when you click outside that's div.

    NPM Plugin: https://www.npmjs.com/package/v-click-outside

Sandesh Mankar
  • 700
  • 4
  • 15