docs(useToggle): note about events in template (#2279)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>
vueuse · Oct 16, 2022 · fd4e699 · fd4e699
1 parent 66f56d2
commit fd4e699
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/packages/shared/useToggle/index.md b/packages/shared/useToggle/index.md
@@ -22,3 +22,12 @@ import { useDark, useToggle } from '@vueuse/core'
 const isDark = useDark()
 const toggleDark = useToggle(isDark)
 ```
+
+Note: be aware that the toggle function accepts the first argument as the override value. You might want to avoid directly passing the function to events in the template, as the event object will pass in.
+
+```html
+<!-- caution: $event will be pass in -->
+<button @click="toggleDark" />
+<!-- recommended to do this -->
+<button @click="toggleDark()" />
+```