useToggle

类别

工具

导出大小

224 B

最后更改

5 天前

一个带有实用函数的布尔值切换器。

演示

源代码

值: 关闭

用法

import { useToggle } from '@vueuse/core'

const [value, toggle] = useToggle()

当你传递一个 ref 时，useToggle 将返回一个简单的切换函数

import { useDark, useToggle } from '@vueuse/core'

const isDark = useDark()
const toggleDark = useToggle(isDark)

注意：请注意，切换函数接受第一个参数作为覆盖值。你可能需要避免直接将该函数传递给模板中的事件，因为事件对象会被传入。

html

<!-- caution: $event will be pass in -->
<button @click="toggleDark" />
<!-- recommended to do this -->
<button @click="toggleDark()" />

类型声明

typescript

export interface UseToggleOptions<Truthy, Falsy> {
  truthyValue?: MaybeRefOrGetter<Truthy>
  falsyValue?: MaybeRefOrGetter<Falsy>
}
export declare function useToggle<Truthy, Falsy, T = Truthy | Falsy>(
  initialValue: Ref<T>,
  options?: UseToggleOptions<Truthy, Falsy>,
): (value?: T) => T
export declare function useToggle<
  Truthy = true,
  Falsy = false,
  T = Truthy | Falsy,
>(
  initialValue?: T,
  options?: UseToggleOptions<Truthy, Falsy>,
): [ShallowRef<T>, (value?: T) => T]