useToggle

用于在 true 和 false 之间进行切换。

基本用法

import { useToggle } from '@ryxon/use'

export default {
  setup() {
    const [state, toggle] = useToggle()

    toggle(true)
    console.log(state.value) // -> true

    toggle(false)
    console.log(state.value) // -> false

    toggle()
    console.log(state.value) // -> true
  }
}

设置默认值

import { useToggle } from '@ryxon/use'

export default {
  setup() {
    const [state, toggle] = useToggle(true)
    console.log(state.value) // -> true
  }
}

API

类型定义

function useToggle(
  defaultValue: boolean
): [Ref<boolean>, (newValue: boolean) => void]

参数

参数	说明	类型	默认值
defaultValue	默认值	boolean	false

返回值

参数	说明	类型
state	状态值	Ref\<boolean>
toggle	切换状态值的函数	(newValue?: boolean) => void