forked from vueuse/vueuse
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.ts
44 lines (38 loc) · 1.31 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
import type { Ref } from 'vue-demi'
import { isRef, ref, unref } from 'vue-demi'
import type { MaybeRef } from '../utils'
export interface UseToggleOptions<Truly, Falsely> {
trulyValue?: MaybeRef<Truly>
falselyValue?: MaybeRef<Falsely>
}
export function useToggle<Truly, Falsely, T = Truly | Falsely>(initialValue: Ref<T>, options?: UseToggleOptions<Truly, Falsely>): (value?: T) => T
export function useToggle<Truly = true, Falsely = false, T = Truly | Falsely>(initialValue?: T, options?: UseToggleOptions<Truly, Falsely>): [Ref<T>, (value?: T) => T]
/**
* A boolean ref with a toggler
*
* @see https://vueuse.org/useToggle
* @param [initialValue=false]
*/
export function useToggle(initialValue: MaybeRef<boolean> = false, options: UseToggleOptions<true, false> = {}) {
const {
trulyValue = true,
falselyValue = false,
} = options
const valueIsRef = isRef(initialValue)
const innerValue = ref(initialValue) as Ref<boolean>
function toggle(value?: boolean) {
// has arguments
if (arguments.length) {
innerValue.value = value!
return innerValue.value
}
else {
innerValue.value = innerValue.value === unref(trulyValue) ? unref(falselyValue) : unref(trulyValue)
return innerValue.value
}
}
if (valueIsRef)
return toggle
else
return [innerValue, toggle]
}