Skip to content

Commit 3b4c61d

Browse files
committed
Update readme, examples and example deps
1 parent e8f4bf3 commit 3b4c61d

File tree

3 files changed

+1147
-729
lines changed

3 files changed

+1147
-729
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5ca72a2dd2044278918b45ea1eba122e)](https://www.codacy.com/app/ndelvalle/v-click-outside?utm_source=github.com&utm_medium=referral&utm_content=ndelvalle/v-click-outside&utm_campaign=Badge_Grade)
88
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-green)](https://github.com/prettier/prettier)
99

10-
Vue directive to react on clicks outside an element without stopping the event propagation. Great for closing dialogues, menus among other things.
10+
Vue directive to react on clicks outside an element without stopping the event propagation.
11+
Great for closing dialogues and menus among other things.
1112

1213
## Install
1314

@@ -39,7 +40,7 @@ Vue.use(vClickOutside)
3940
// Note: The default value is true, but in case you want to activate / deactivate
4041
// this directive dynamically use this attribute.
4142
isActive: true,
42-
// Note: The default value is true. See detecting "Detecting Iframe Clicks" section
43+
// Note: The default value is true. See "Detecting Iframe Clicks" section
4344
// to understand why this behaviour is behind a flag.
4445
detectIFrame: true
4546
}
@@ -145,17 +146,11 @@ export default {
145146

146147
See [#220](https://github.com/ndelvalle/v-click-outside/issues/220) for details or [check-out this demo](https://codesandbox.io/s/v-click-outside-programatic-usage-o9drq)
147148

149+
148150
## Example
149151

150152
[![Edit v-click-outside](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/zx7mx8y1ol?module=%2Fsrc%2Fcomponents%2FHelloWorld.vue)
151153

152-
## Migrate from version 1
153-
154-
The `notouch` modifier is no longer supported, same functionality can be achieved using a middleware function
155-
156-
## Migrate from version 2
157-
158-
The HTML `el` is not sent in the handler function argument any more. Review [this issue](https://github.com/ndelvalle/v-click-outside/issues/137) for more details.
159154

160155
## Detecting Iframe Clicks
161156

@@ -170,6 +165,15 @@ Clicks on iframes moves `focus` to its contents’ `window` but don't `bubble` u
170165
Because of these reasons, the detection mechansim is behind the `detectIframe` flag that you can optionally set to `false` if you find it conflicting with your use-case.
171166
Any improvements or suggestions to this are welcomed.
172167

168+
169+
## Migrate from version 1
170+
171+
The `notouch` modifier is no longer supported, same functionality can be achieved using a middleware function
172+
173+
## Migrate from version 2
174+
175+
The HTML `el` is not sent in the handler function argument any more. Review [this issue](https://github.com/ndelvalle/v-click-outside/issues/137) for more details.
176+
173177
## License
174178

175179
[MIT License](https://github.com/ndelvalle/v-click-outside/blob/master/LICENSE)

0 commit comments

Comments
 (0)