Виявити зовнішній елемент клацання


121

Як я можу виявити клацання поза моїм елементом? Я використовую Vue.js, тому він буде поза моїм елементом шаблонів. Я знаю, як це зробити у Vanilla JS, але я не впевнений, чи є більш правильний спосіб це зробити, коли я використовую Vue.js?

Це рішення для Vanilla JS: Javascript Detect Click подія поза ділом

Я думаю, я можу скористатися кращим способом доступу до елемента?


Компоненти Vue ізольовані. тому виявлення зовнішніх змін не викликає сумнівів, і використовується антидіаграма.
Радж Камаль

Дякую. Я не впевнений, хоча як це реалізувати в компоненті Vue. Досі повинні існувати якісь найкращі практики щодо антитіла?

Компонент Vue.js є ізольованим, правда, але існують різні методи спілкування батько-дитина. Отже, замість того, щоб просити виявити подію поза елементом, вам слід вказати, чи хочете ви виявити елементи всередині компонента, від батьківського компонента, від якоїсь дочірньої системи, або яке б там не було відношення між компонентами
Yerko Palma

Дякуємо за відгук. Чи є у вас приклади чи посилання, на яких я можу перейти?

github.com/simplesmiler/vue-clickaway може спростити роботу
Raj Kamal

Відповіді:


97

Можна вирішити добре, встановивши власну директиву один раз:

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() }
})

Використання:

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

У складі:

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

Робоча демонстрація JSFiddle з додатковою інформацією про застереження:

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


3
Я використовував пробіг Vue, але я думаю, що ваше рішення більш-менш те саме. Дякую.

56
Цей підхід більше не працює у Vue.js 2. Виклик self.vm. $ передає повідомлення про помилку.
північ

3
Використання @blur також є варіантом і полегшує отримання того ж результату: <input @ blur = "сховати"> де hid: function () {this.isActive = false; }
Craws

1
Відповідь слід відредагувати, щоб сказати, що я лише для Vue.js 1
Стефан Гербер

167

Я використовував рішення, яке базується на відповіді Лінуса Борга і прекрасно працює з 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)
  },
});

Ви пов'язуєте з ним за допомогою v-click-outside:

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

Ось невеличка демонстрація

Додаткову інформацію про власні директиви та те , що означає el, прив'язування, vnode, можна знайти на https://vuejs.org/v2/guide/custom-directive.html#Directive-Hook-Arguments


8
Працювали, але в директивах Vue 2.0 більше немає примірника, тому це не визначено. vuejs.org/v2/guide/migration.html#Custom-Directives- спрощено . Я не маю поняття, чому ця скрипка працює або коли це спрощення зроблено. (Щоб вирішити, замініть "це" на "el", щоб прив'язати подію до елемента)
Busata

1
Це працює, ймовірно, тому, що вікно пройшло як "це". Я зафіксував відповідь. Дякуємо, що вказали на цю помилку.
MadisonTrash

8
Чи є спосіб виключити конкретний елемент зовні? Наприклад, у мене є одна кнопка, поза якою потрібно відкрити цей елемент, і тому що він запускає обидва способи, нічого не відбувається.
Žilvinas

5
Чи можете ви пояснити, будь ласка, vnode.context [obvez.expression] (подія); ?
Sainath SR

1
як це змінити, щоб замість методу в v-click-external був використаний вираз?
raphadko

50

Додайте tabindexатрибут до свого компонента, щоб він міг бути зосереджений, і виконайте наступне:

<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>

4
Ого! Я вважаю це найкоротшим і найчистішим рішенням. Також єдиний, хто працював у моєму випадку.
Метт Комарницький

3
Просто додавши до цього, встановлення табіндексу -1 не призведе до появи підсвічуваного вікна при натисканні на елемент, але він все одно дозволить діву бути орієнтованим.
Колін

1
Чомусь tabindex -1 не приховує контури для мене, тому я просто додав outline: none;фокус для елемента.
Art3mix

1
як ми можемо застосувати це до небічного полотна, який ковзає на екран? Я не можу зосередитись на сидені, якщо його не натискають,
Чарльз Окваугву

1
Це абсолютно найпотужніший спосіб. Дякую! :)
Канет Роберн

23

У спільноті для цього завдання доступні два пакети (обидва підтримуються):


8
vue-clickawayпакет вирішив моє питання ідеально. Спасибі
Абдалла Арбаб

1
А як щодо багатьох предметів? Кожен предмет із подіями, що перебувають поза кліком, запускатиме події на кожен клік. Приємно, коли робиш діалог і жахливо, коли створюєш галерею. У некомпонентну епоху ми прослуховуємо клацання з документа і перевіряємо, на який елемент було натиснуто. Але зараз це біль.
бр.

@Julien Le Coupanec Я вважав це рішення найкращим на сьогоднішній день! Дякую велике за те, що поділилися ним!
Мануель Абаскаль

7

Це працювало для мене з 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.removeEventListener('click', el.__vueClickOutside__)
    el.__vueClickOutside__ = null
  }
}

Дякую за цей приклад. Перевірив це на vue 2.6. Існує певне виправлення, в методі від'єднання ви повинні вирішити якусь проблему цим (ви забули властивість тіла в методі відключення): document.body.removeEventListener ('click', el .__ vueClickOutside__); якщо ні - це спричинить створення декількох слухачів подій після кожного компонента відтворення (оновлення сторінки);
Олексій Шабрамов

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

  }
}

5

Я поєднав усі відповіді (включаючи рядок від vue-clickaway) і придумав таке рішення, яке працює для мене:

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);
    }
});

Використання в компоненті:

<li v-click-outside="closeSearch">
  <!-- your component here -->
</li>

Практично такий же , як @MadisonTrash відповідь нижче
retrovertigo

3

Я оновив відповідь MadisonTrash, щоб підтримати Mobile Safari (який не має clickподії, touchendпотрібно використовувати замість цього). Сюди також входить чек, щоб подія не ініціювалась перетягуванням на мобільних пристроях.

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');
    },
});

3

Я використовую цей код:

кнопка показати приховати

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

Показати приховати елемент

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

сценарій

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

Оновлення: зняти годинник; додати зупинку розповсюдження


2

Я ненавиджу додаткові функції, так що ... ось дивовижне рішення vue без додаткових методів vue, тільки var

  1. створити html-елемент, встановити елементи керування та директиву
    <p @click="popup = !popup" v-out="popup">

    <div v-if="popup">
       My awesome popup
    </div>
  1. створити var у таких даних
data:{
   popup: false,
}
  1. додати директиву vue. його
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
    }
})

2

Якщо ви спеціально шукаєте клацання за межами елемента, але все ще в батьківському середовищі, ви можете використовувати

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

Я використовую це для модалів.


1

Ви можете зареєструвати двох слухачів подій для такої події, що працює в кліці

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!");
         }
);

Дякую. Я це знаю, але відчувається, що для Vue.js має бути кращий спосіб зробити це?

ГАРАЗД! нехай якийсь геній vue.js відповість :)
saravanakumar

1
  <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;
      }
    },
  },

Дякую, працюємо на відмінно і якщо вам це знадобиться лише раз, немає потреби в додаткових бібліотеках
Marian Klühspies

1

Коротка відповідь: Це потрібно робити за допомогою спеціальних директив .

Тут є багато чудових відповідей, які також говорять про це, але більшість відповідей, які я бачив, ламаються, коли ви починаєте широко використовувати зовнішній клік (особливо багатошаровий або з декількома виключеннями). Я написав статтю в середовищі, де розповідав про нюанси митних директив та конкретно про імплементацію цієї. Він не може охоплювати всі крайові випадки, але він охоплює все, що я придумав.

Це враховує кілька прив'язок, кілька рівнів виключень інших елементів і дозволить вашому оброблювачеві керувати лише "бізнес-логікою".

Ось код для принаймні частини визначення його, ознайомтеся зі статтею для повного пояснення.

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

1

Я зробив це дещо по-іншому, використовуючи функцію в створеному ().

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

Таким чином, якщо хтось клацає поза елементом, то в моєму випадку мобільний навичок прихований.

Сподіваюся, це допомагає!


1

Відповідей на це питання вже багато, і більшість з них базується на подібній ідеї спеціальної директиви. Проблема такого підходу полягає в тому, що треба передати функцію методу директиві, і він не може безпосередньо записати код, як в інших подіях.

Я створив новий пакет, vue-on-clickoutякий відрізняється. Перевірте це за адресою:

Це дозволяє писати так v-on:clickoutсамо, як і будь-які інші події. Наприклад, можна писати

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

і це працює.

Оновлення

vue-on-clickout тепер підтримує Vue 3!


0

Просто якщо хтось дивиться, як приховати модальний при натисканні поза модальним. Оскільки в модалі зазвичай є своя обгортка з класом modal-wrapабо що-небудь, що ви її назвали, ви можете надіти @click="closeModal"обгортку. Використовуючи обробку подій, вказану в документації на vuejs, ви можете перевірити, чи натиснута ціль знаходиться або на обгортці, або на модальній формі.

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>


0

@ Деніс Даниленко працює на мене, ось що я зробив: до речі, я тут використовую VueJS CLI3 і NuxtJS і з Bootstrap4, але він буде працювати на VueJS без NuxtJS також:

<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

Ви можете випромінювати власні власні події Javascript із директиви. Створіть директиву, яка розсилає подію з вузла, використовуючи 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)
    }
})

Які можна використовувати так

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

0

Я створюю діва в кінці тіла так:

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

Де знаходиться зовні:

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

І away () - метод у екземплярі Vue:

away() {
 this.isPopup = false;
}

Легко, працює добре.


0

Якщо у вас є компонент з декількома елементами всередині кореневого елемента, ви можете використовувати це рішення. Це просто працює ™ 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>

0

Скористайтеся цим пакетом vue-click-out

Це простий і надійний, в даний час використовується багатьма іншими пакетами. Ви також можете зменшити розмір пакета javascript, зателефонувавши в пакет лише в необхідних компонентах (див. Приклад нижче).

npm install vue-click-outside

Використання:

<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>


0

Ви можете створити новий компонент, який обробляє зовнішній клік

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>
`
})

І використовуйте цей компонент:

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

-1

часто люди хочуть знати, чи залишає користувач кореневий компонент (працює з компонентами будь-якого рівня)

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


-1

У мене є рішення для обробки перемикаючого меню:

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
        })
      },
}

-1

Я використовую цей пакет: https://www.npmjs.com/package/vue-click-outside

Це прекрасно працює для мене

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>

Мої сценарії:

import ClickOutside from 'vue-click-outside'
export default
{
    data(){
        return {
            cardContentVisible:false
        }
    },
    created()
    {
    },
    methods:
        {
            openCardContent()
            {
                this.cardContentVisible = true;
            }, hide () {
            this.cardContentVisible = false
                }
        },
    directives: {
            ClickOutside
    }
}
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.