⬅️ Back to Table of Contents

📄 useToggle

📊 Analysis Summary

Metric	Count
🔧 Functions	2
📦 Imports	7
📐 Interfaces	1
📑 Type Aliases	2

📚 Table of Contents

• Imports
• Functions
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/shared/useToggle/index.ts

📦 Imports

Name	Source
MaybeRef	vue
MaybeRefOrGetter	vue
Ref	vue
ShallowRef	vue
isRef	vue
shallowRef	vue
toValue	vue

---

Functions

useToggle(initialValue: Ref<T>, options: UseToggleOptions<Truthy, Falsy>): (value?: T) => T

Parameters:

• initialValue Ref<T>
• options UseToggleOptions<Truthy, Falsy>

Returns: (value?: T) => T

Code

export function useToggle<Truthy, Falsy, T = Truthy | Falsy>(initialValue: Ref<T>, options?: UseToggleOptions<Truthy, Falsy>): (value?: T) => T

Internal helpers

Declared inside another function in this file.

toggle(value: boolean): any

Parameters:

• value boolean

Returns: any

Calls:

• toValue (from vue)

Internal Comments:

// has arguments

Code

function toggle(value?: boolean) {
    // has arguments
    if (arguments.length) {
      _value.value = value!
      return _value.value
    }
    else {
      const truthy = toValue(truthyValue)
      _value.value = _value.value === truthy
        ? toValue(falsyValue)
        : truthy
      return _value.value
    }
  }

---

Interfaces

UseToggleOptions<Truthy, Falsy>

Interface Code

export interface UseToggleOptions<Truthy, Falsy> {
  truthyValue?: MaybeRefOrGetter<Truthy>
  falsyValue?: MaybeRefOrGetter<Falsy>
}

Properties

Name	Type	Optional	Description
truthyValue	MaybeRefOrGetter<Truthy>	✓	not shown
falsyValue	MaybeRefOrGetter<Falsy>	✓	not shown

---

Type Aliases

ToggleFn

type ToggleFn = (value?: boolean) => void;

UseToggleReturn

type UseToggleReturn = [ShallowRef<boolean>, ToggleFn] | ToggleFn;

---

Generated by Syntax Scribe