onClickOutside | VueUse

onClickOutside
​
Category
Sensors
Export Size
893 B
Last Changed
3 weeks ago

Listen for clicks outside of an element. Useful for modal or dropdown.

Demo
​

source

Open ModalToggle Dropdown
Usage
​
html
<template>
  <div ref="target">
    Hello world
  </div>
  <div>
    Outside element
  </div>
</template>

<script>
import { ref } from 'vue'
import { onClickOutside } from '@vueuse/core'

export default {
  setup() {
    const target = ref(null)

    onClickOutside(target, (event) => console.log(event))

    return { target }
  }
}
</script>

This function uses Event.composedPath() which is NOT supported by IE 11, Edge 18 and below. If you are targeting these browsers, we recommend you to include this code snippet on your project.

Component Usage
​

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

html
<OnClickOutside @trigger="count++" :options="{ ignore: [/* ... */] }">
  <div>
    Click Outside of Me
  </div>
</OnClickOutside>
Directive Usage
​

This function also provides a directive version via the @vueuse/components package. Learn more about the usage.

html
<script setup lang="ts">
import { ref } from 'vue'
import { vOnClickOutside } from '@vueuse/components'

const modal = ref(false)
function closeModal() {
  modal.value = false
}

</script>

<template>
  <button @click="modal = true">
    Open Modal
  </button>
  <div v-if="modal" v-on-click-outside="closeModal">
    Hello World
  </div>
</template>

You can also set the handler as an array to set the configuration items of the instruction.

html
<script setup>
import { ref } from 'vue'
import { vOnClickOutside } from '@vueuse/components'

const modal = ref(false)

const ignoreElRef = ref()

const onClickOutsideHandler = [
  (ev) => {
    console.log(ev)
    modal.value = false
  },
  { ignore: [ignoreElRef] }
]

</script>

<template>
  <button @click="modal = true">
    Open Modal
  </button>

  <div ref="ignoreElRef">
    click outside ignore element
  </div>

  <div v-if="modal" v-on-click-outside="onClickOutsideHandler">
    Hello World
  </div>
</template>
Source
​

Source • Demo • Docs

Contributors
​
Anthony Fu
sibbng
wheat
Doctorwu
Rory King
糠帅傅
Chestnut
vaakian X
Fiad
Young
Gavin
webfansplz
Jelf
JserWang
Alex Kozack
Changelog
​
v10.6.0 on 11/9/2023
69851 - fix: adjust shouldListen handling timing (#3503)
v10.3.0 on 7/30/2023
9091e - fix: fix outside click on html element in ios (#3252)
v10.2.0 on 6/16/2023
2c66e - fix: ensure focus on iframe captured in firefox (#3066)
v9.11.0 on 1/17/2023
d5321 - fix(components): mark defineComponent as pure (#2623)
v9.8.0 on 12/20/2022
7b3db - feat: allow selector strings for ignore list (#2439)
12e21 - fix: apply ignore list on keyboard clicks (#2438)
v9.6.0 on 11/22/2022
ff96d - fix: call handler if click event is fired by a keypress (#2426)
v9.5.0 on 11/9/2022
f78c4 - fix: access correct document (#2404)
c913b - feat: support options in component (#2391)
v9.3.0 on 9/26/2022
5a976 - feat: add bubble modifier to directive (#2183)
a3742 - fix: put ignore logic on pointerdown event (#2198)
v9.0.0-beta.1 on 7/20/2022
6b1ff - fix: fix handler type (#1961)
v8.9.2 on 7/12/2022
70160 - feat: add detectIframe option (#1795)
v8.7.0 on 6/16/2022
1988e - fix: avoid calling safari workaround on right click (#1673)