import{o as a,a as n,y as t}from"./vue-libs.b44bc779.js";const l={class:"van-doc-markdown-body"},e=t(`

useToggle

Intro

Used to switch between true and false.

Usage

Basic Usage

import { useToggle } from '@vant/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
  },
};

Default Value

import { useToggle } from '@vant/use';

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

API

Type Declarations

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

Params

NameDescriptionTypeDefault Value
defaultValueDefault valuebooleanfalse

Return Value

NameDescriptionType
stateStateRef<boolean>
toggleFunction to switch state(newValue?: boolean) => void
`,9),p=[e],r={__name:"use-toggle.en-US",setup(c,{expose:s}){return s({frontmatter:{}}),(d,i)=>(a(),n("div",l,p))}};export{r as default};