@vueuse/metadata 8.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.cjs ADDED
@@ -0,0 +1,1927 @@
1
+ 'use strict';
2
+
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+
5
+ var packages$1 = {
6
+ shared: {
7
+ name: "shared",
8
+ display: "Shared utilities",
9
+ dir: "packages/shared"
10
+ },
11
+ core: {
12
+ name: "core",
13
+ display: "VueUse",
14
+ description: "Collection of essential Vue Composition Utilities",
15
+ dir: "packages/core"
16
+ },
17
+ components: {
18
+ name: "components",
19
+ display: "Components",
20
+ description: "Renderless components for VueUse",
21
+ author: "Jacob Clevenger<https://github.com/wheatjs>",
22
+ external: [
23
+ "@vueuse/core",
24
+ "@vueuse/shared"
25
+ ],
26
+ dir: "packages/components"
27
+ },
28
+ router: {
29
+ name: "router",
30
+ display: "Router",
31
+ description: "Utilities for vue-router",
32
+ addon: true,
33
+ external: [
34
+ "vue-router"
35
+ ],
36
+ globals: {
37
+ "vue-router": "VueRouter"
38
+ },
39
+ dir: "packages/router",
40
+ docs: "https://vueuse.org/router/README.html"
41
+ },
42
+ integrations: {
43
+ name: "integrations",
44
+ display: "Integrations",
45
+ description: "Integration wrappers for utility libraries",
46
+ addon: true,
47
+ submodules: true,
48
+ external: [
49
+ "axios",
50
+ "universal-cookie",
51
+ "qrcode",
52
+ "http",
53
+ "nprogress",
54
+ "jwt-decode",
55
+ "focus-trap",
56
+ "drauu",
57
+ "@vueuse/core",
58
+ "@vueuse/shared",
59
+ "fuse.js"
60
+ ],
61
+ globals: {
62
+ axios: "axios",
63
+ "universal-cookie": "UniversalCookie",
64
+ qrcode: "QRCode",
65
+ nprogress: "nprogress",
66
+ "jwt-decode": "jwt_decode",
67
+ "focus-trap": "focusTrap",
68
+ drauu: "Drauu",
69
+ "fuse.js": "Fuse"
70
+ },
71
+ dir: "packages/integrations",
72
+ docs: "https://vueuse.org/integrations/README.html"
73
+ },
74
+ rxjs: {
75
+ name: "rxjs",
76
+ display: "RxJS",
77
+ description: "Enables RxJS reactive functions in Vue",
78
+ addon: true,
79
+ external: [
80
+ "rxjs",
81
+ "rxjs/operators"
82
+ ],
83
+ globals: {
84
+ rxjs: "rxjs",
85
+ "rxjs/operators": "rxjs.operator"
86
+ },
87
+ dir: "packages/rxjs",
88
+ docs: "https://vueuse.org/rxjs/README.html"
89
+ },
90
+ firebase: {
91
+ name: "firebase",
92
+ display: "Firebase",
93
+ description: "Enables realtime bindings for Firebase",
94
+ addon: true,
95
+ submodules: true,
96
+ external: [
97
+ "firebase",
98
+ "firebase/app"
99
+ ],
100
+ globals: {
101
+ firebase: "firebase",
102
+ "firebase/app": "firebase"
103
+ },
104
+ dir: "packages/firebase",
105
+ docs: "https://vueuse.org/firebase/README.html"
106
+ },
107
+ electron: {
108
+ name: "electron",
109
+ display: "Electron",
110
+ description: "Electron renderer process modules for VueUse",
111
+ author: "Archer Gu<https://github.com/ArcherGu>",
112
+ addon: true,
113
+ external: [
114
+ "electron"
115
+ ],
116
+ iife: false,
117
+ dir: "packages/electron",
118
+ docs: "https://vueuse.org/electron/README.html"
119
+ }
120
+ };
121
+ var categories$1 = [
122
+ "Animation",
123
+ "Browser",
124
+ "Component",
125
+ "Elements",
126
+ "Misc",
127
+ "Network",
128
+ "Sensors",
129
+ "State",
130
+ "Utilities",
131
+ "Watch",
132
+ "@Electron",
133
+ "@Firebase",
134
+ "@Head",
135
+ "@Integrations",
136
+ "@Motion",
137
+ "@Router",
138
+ "@RxJS",
139
+ "@Sound"
140
+ ];
141
+ var functions$1 = [
142
+ {
143
+ name: "computedAsync",
144
+ "package": "core",
145
+ lastUpdated: 1645958070000,
146
+ docs: "https://vueuse.org/core/computedAsync/",
147
+ category: "Utilities",
148
+ description: "computed for async functions",
149
+ alias: [
150
+ "asyncComputed"
151
+ ]
152
+ },
153
+ {
154
+ name: "computedEager",
155
+ "package": "shared",
156
+ lastUpdated: 1645956777000,
157
+ docs: "https://vueuse.org/shared/computedEager/",
158
+ category: "Utilities",
159
+ description: "eager computed without lazy evaluation",
160
+ alias: [
161
+ "eagerComputed"
162
+ ]
163
+ },
164
+ {
165
+ name: "computedInject",
166
+ "package": "core",
167
+ lastUpdated: 1639442454000,
168
+ docs: "https://vueuse.org/core/computedInject/",
169
+ category: "Component",
170
+ description: "combine computed and inject"
171
+ },
172
+ {
173
+ name: "computedWithControl",
174
+ "package": "shared",
175
+ lastUpdated: 1645956777000,
176
+ docs: "https://vueuse.org/shared/computedWithControl/",
177
+ category: "Utilities",
178
+ description: "explicitly define the deps of computed",
179
+ alias: [
180
+ "controlledComputed"
181
+ ],
182
+ related: [
183
+ "refWithControl"
184
+ ]
185
+ },
186
+ {
187
+ name: "createEventHook",
188
+ "package": "shared",
189
+ lastUpdated: 1621876156000,
190
+ docs: "https://vueuse.org/shared/createEventHook/",
191
+ category: "Utilities",
192
+ description: "utility for creating event hooks"
193
+ },
194
+ {
195
+ name: "createGlobalState",
196
+ "package": "shared",
197
+ lastUpdated: 1625749207000,
198
+ docs: "https://vueuse.org/shared/createGlobalState/",
199
+ category: "State",
200
+ description: "keep states in the global scope to be reusable across Vue instances"
201
+ },
202
+ {
203
+ name: "createHead",
204
+ "package": "head",
205
+ description: "create the head manager instance.",
206
+ category: "@Head",
207
+ external: "https://github.com/vueuse/head#api"
208
+ },
209
+ {
210
+ name: "createSharedComposable",
211
+ "package": "shared",
212
+ lastUpdated: 1639442454000,
213
+ docs: "https://vueuse.org/shared/createSharedComposable/",
214
+ category: "State",
215
+ description: "make a composable function usable with multiple Vue instances"
216
+ },
217
+ {
218
+ name: "createUnrefFn",
219
+ "package": "core",
220
+ lastUpdated: 1639442454000,
221
+ docs: "https://vueuse.org/core/createUnrefFn/",
222
+ category: "Utilities",
223
+ description: "make a plain function accepting ref and raw values as arguments",
224
+ related: [
225
+ "reactify"
226
+ ]
227
+ },
228
+ {
229
+ name: "extendRef",
230
+ "package": "shared",
231
+ lastUpdated: 1639442454000,
232
+ docs: "https://vueuse.org/shared/extendRef/",
233
+ category: "Utilities",
234
+ description: "add extra attributes to Ref"
235
+ },
236
+ {
237
+ name: "from",
238
+ "package": "rxjs",
239
+ lastUpdated: 1640930012000,
240
+ docs: "https://vueuse.org/rxjs/from/",
241
+ category: "@RxJS",
242
+ description: "/ fromEvent"
243
+ },
244
+ {
245
+ name: "get",
246
+ "package": "shared",
247
+ lastUpdated: 1639442454000,
248
+ docs: "https://vueuse.org/shared/get/",
249
+ category: "Utilities",
250
+ description: "shorthand for accessing `ref.value`"
251
+ },
252
+ {
253
+ name: "isDefined",
254
+ "package": "shared",
255
+ lastUpdated: 1639442454000,
256
+ docs: "https://vueuse.org/shared/isDefined/",
257
+ category: "Utilities",
258
+ description: "non-nullish checking type guard for Ref"
259
+ },
260
+ {
261
+ name: "logicAnd",
262
+ "package": "shared",
263
+ lastUpdated: 1646037429000,
264
+ docs: "https://vueuse.org/shared/logicAnd/",
265
+ category: "Utilities",
266
+ description: "`AND` condition for refs",
267
+ alias: [
268
+ "and"
269
+ ],
270
+ related: [
271
+ "logicNot",
272
+ "logicOr"
273
+ ]
274
+ },
275
+ {
276
+ name: "logicNot",
277
+ "package": "shared",
278
+ lastUpdated: 1646037429000,
279
+ docs: "https://vueuse.org/shared/logicNot/",
280
+ category: "Utilities",
281
+ description: "`NOT` condition for ref",
282
+ alias: [
283
+ "note"
284
+ ],
285
+ related: [
286
+ "logicAnd",
287
+ "logicOr"
288
+ ]
289
+ },
290
+ {
291
+ name: "logicOr",
292
+ "package": "shared",
293
+ lastUpdated: 1646037429000,
294
+ docs: "https://vueuse.org/shared/logicOr/",
295
+ category: "Utilities",
296
+ description: "`OR` conditions for refs",
297
+ alias: [
298
+ "or"
299
+ ],
300
+ related: [
301
+ "logicAnd",
302
+ "logicNot"
303
+ ]
304
+ },
305
+ {
306
+ name: "makeDestructurable",
307
+ "package": "shared",
308
+ lastUpdated: 1642756441000,
309
+ docs: "https://vueuse.org/shared/makeDestructurable/",
310
+ category: "Utilities",
311
+ description: "make isomorphic destructurable for object and array at the same time"
312
+ },
313
+ {
314
+ name: "onClickOutside",
315
+ "package": "core",
316
+ lastUpdated: 1644285140000,
317
+ component: true,
318
+ directive: true,
319
+ docs: "https://vueuse.org/core/onClickOutside/",
320
+ category: "Sensors",
321
+ description: "listen for clicks outside of an element"
322
+ },
323
+ {
324
+ name: "onKeyStroke",
325
+ "package": "core",
326
+ lastUpdated: 1642756441000,
327
+ directive: true,
328
+ docs: "https://vueuse.org/core/onKeyStroke/",
329
+ category: "Sensors",
330
+ description: "listen for keyboard key being stroked"
331
+ },
332
+ {
333
+ name: "onLongPress",
334
+ "package": "core",
335
+ lastUpdated: 1644416339000,
336
+ component: true,
337
+ directive: true,
338
+ docs: "https://vueuse.org/core/onLongPress/",
339
+ category: "Sensors",
340
+ description: "listen for a long press on an element"
341
+ },
342
+ {
343
+ name: "onStartTyping",
344
+ "package": "core",
345
+ lastUpdated: 1639442454000,
346
+ docs: "https://vueuse.org/core/onStartTyping/",
347
+ category: "Sensors",
348
+ description: "fires when users start typing on non-editable elements"
349
+ },
350
+ {
351
+ name: "reactify",
352
+ "package": "shared",
353
+ lastUpdated: 1645956777000,
354
+ docs: "https://vueuse.org/shared/reactify/",
355
+ category: "Utilities",
356
+ description: "converts plain functions into reactive functions",
357
+ alias: [
358
+ "createReactiveFn"
359
+ ],
360
+ related: [
361
+ "createUnrefFn"
362
+ ]
363
+ },
364
+ {
365
+ name: "reactifyObject",
366
+ "package": "shared",
367
+ lastUpdated: 1642756441000,
368
+ docs: "https://vueuse.org/shared/reactifyObject/",
369
+ category: "Utilities",
370
+ description: "apply `reactify` to an object"
371
+ },
372
+ {
373
+ name: "reactiveComputed",
374
+ "package": "shared",
375
+ lastUpdated: 1645876129000,
376
+ docs: "https://vueuse.org/shared/reactiveComputed/",
377
+ category: "Utilities",
378
+ description: "computed reactive object"
379
+ },
380
+ {
381
+ name: "reactiveOmit",
382
+ "package": "shared",
383
+ lastUpdated: 1645876129000,
384
+ docs: "https://vueuse.org/shared/reactiveOmit/",
385
+ category: "Utilities",
386
+ description: "reactively omit fields from a reactive object"
387
+ },
388
+ {
389
+ name: "reactivePick",
390
+ "package": "shared",
391
+ lastUpdated: 1639442454000,
392
+ docs: "https://vueuse.org/shared/reactivePick/",
393
+ category: "Utilities",
394
+ description: "reactively pick fields from a reactive object"
395
+ },
396
+ {
397
+ name: "refAutoReset",
398
+ "package": "shared",
399
+ lastUpdated: 1646037705000,
400
+ docs: "https://vueuse.org/shared/refAutoReset/",
401
+ category: "Utilities",
402
+ description: "a ref which will be reset to the default value after some time",
403
+ alias: [
404
+ "autoResetRef"
405
+ ]
406
+ },
407
+ {
408
+ name: "refDebounced",
409
+ "package": "shared",
410
+ lastUpdated: 1645956777000,
411
+ docs: "https://vueuse.org/shared/refDebounced/",
412
+ category: "Utilities",
413
+ description: "debounce execution of a ref value",
414
+ alias: [
415
+ "useDebounce",
416
+ "debouncedRef"
417
+ ]
418
+ },
419
+ {
420
+ name: "refDefault",
421
+ "package": "shared",
422
+ lastUpdated: 1639442454000,
423
+ docs: "https://vueuse.org/shared/refDefault/",
424
+ category: "Utilities",
425
+ description: "apply default value to a ref"
426
+ },
427
+ {
428
+ name: "refThrottled",
429
+ "package": "shared",
430
+ lastUpdated: 1645956777000,
431
+ docs: "https://vueuse.org/shared/refThrottled/",
432
+ category: "Utilities",
433
+ description: "throttle changing of a ref value",
434
+ alias: [
435
+ "useThrottle",
436
+ "throttledRef"
437
+ ]
438
+ },
439
+ {
440
+ name: "refWithControl",
441
+ "package": "shared",
442
+ lastUpdated: 1645956154000,
443
+ docs: "https://vueuse.org/shared/refWithControl/",
444
+ category: "Utilities",
445
+ description: "fine-grained controls over ref and its reactivity",
446
+ alias: [
447
+ "controlledRef"
448
+ ],
449
+ related: [
450
+ "computedWithControl"
451
+ ]
452
+ },
453
+ {
454
+ name: "set",
455
+ "package": "shared",
456
+ lastUpdated: 1642756441000,
457
+ docs: "https://vueuse.org/shared/set/",
458
+ category: "Utilities",
459
+ description: "shorthand for `ref.value = x`"
460
+ },
461
+ {
462
+ name: "syncRef",
463
+ "package": "shared",
464
+ lastUpdated: 1645952177000,
465
+ docs: "https://vueuse.org/shared/syncRef/",
466
+ category: "Utilities",
467
+ description: "two-way refs synchronization",
468
+ related: [
469
+ "syncRefs"
470
+ ]
471
+ },
472
+ {
473
+ name: "syncRefs",
474
+ "package": "shared",
475
+ lastUpdated: 1645952177000,
476
+ docs: "https://vueuse.org/shared/syncRefs/",
477
+ category: "Utilities",
478
+ description: "keep target refs in sync with a source ref",
479
+ related: [
480
+ "syncRef"
481
+ ]
482
+ },
483
+ {
484
+ name: "templateRef",
485
+ "package": "core",
486
+ lastUpdated: 1640933217000,
487
+ docs: "https://vueuse.org/core/templateRef/",
488
+ category: "Component",
489
+ description: "shorthand for binding ref to template element"
490
+ },
491
+ {
492
+ name: "toObserver",
493
+ "package": "rxjs",
494
+ lastUpdated: 1631130736000,
495
+ docs: "https://vueuse.org/rxjs/toObserver/",
496
+ category: "@RxJS",
497
+ description: "sugar function to convert a ref in an observer"
498
+ },
499
+ {
500
+ name: "toReactive",
501
+ "package": "shared",
502
+ lastUpdated: 1645878866000,
503
+ docs: "https://vueuse.org/shared/toReactive/",
504
+ category: "Utilities",
505
+ description: "converts ref to reactive"
506
+ },
507
+ {
508
+ name: "toRefs",
509
+ "package": "shared",
510
+ lastUpdated: 1639818708000,
511
+ docs: "https://vueuse.org/shared/toRefs/",
512
+ category: "Utilities",
513
+ description: "extended [`toRefs`](https://v3.vuejs.org/api/refs-api.html#torefs) that also accepts refs of an object"
514
+ },
515
+ {
516
+ name: "tryOnBeforeUnmount",
517
+ "package": "shared",
518
+ lastUpdated: 1639442454000,
519
+ docs: "https://vueuse.org/shared/tryOnBeforeUnmount/",
520
+ category: "Component",
521
+ description: "safe `onBeforeUnmount`"
522
+ },
523
+ {
524
+ name: "tryOnMounted",
525
+ "package": "shared",
526
+ lastUpdated: 1640933217000,
527
+ docs: "https://vueuse.org/shared/tryOnMounted/",
528
+ category: "Component",
529
+ description: "safe `onMounted`"
530
+ },
531
+ {
532
+ name: "tryOnScopeDispose",
533
+ "package": "shared",
534
+ lastUpdated: 1639442454000,
535
+ docs: "https://vueuse.org/shared/tryOnScopeDispose/",
536
+ category: "Component",
537
+ description: "safe `onScopeDispose`"
538
+ },
539
+ {
540
+ name: "tryOnUnmounted",
541
+ "package": "shared",
542
+ lastUpdated: 1640933217000,
543
+ docs: "https://vueuse.org/shared/tryOnUnmounted/",
544
+ category: "Component",
545
+ description: "safe `onUnmounted`"
546
+ },
547
+ {
548
+ name: "unrefElement",
549
+ "package": "core",
550
+ lastUpdated: 1639442454000,
551
+ docs: "https://vueuse.org/core/unrefElement/",
552
+ category: "Component",
553
+ description: "unref for dom element"
554
+ },
555
+ {
556
+ name: "until",
557
+ "package": "shared",
558
+ lastUpdated: 1639818708000,
559
+ docs: "https://vueuse.org/shared/until/",
560
+ category: "Watch",
561
+ description: "promised one-time watch for changes"
562
+ },
563
+ {
564
+ name: "useActiveElement",
565
+ "package": "core",
566
+ lastUpdated: 1639442454000,
567
+ component: true,
568
+ docs: "https://vueuse.org/core/useActiveElement/",
569
+ category: "Elements",
570
+ description: "reactive `document.activeElement`"
571
+ },
572
+ {
573
+ name: "useAsyncQueue",
574
+ "package": "core",
575
+ lastUpdated: 1639818708000,
576
+ docs: "https://vueuse.org/core/useAsyncQueue/",
577
+ category: "Utilities",
578
+ description: "executes each asynchronous task sequentially and passed the current task result to the next task"
579
+ },
580
+ {
581
+ name: "useAsyncState",
582
+ "package": "core",
583
+ lastUpdated: 1642756441000,
584
+ docs: "https://vueuse.org/core/useAsyncState/",
585
+ category: "State",
586
+ description: "reactive async state"
587
+ },
588
+ {
589
+ name: "useAuth",
590
+ "package": "firebase",
591
+ lastUpdated: 1639442454000,
592
+ docs: "https://vueuse.org/firebase/useAuth/",
593
+ category: "@Firebase",
594
+ description: "reactive [Firebase Auth](https://firebase.google.com/docs/auth) binding"
595
+ },
596
+ {
597
+ name: "useAxios",
598
+ "package": "integrations",
599
+ lastUpdated: 1646467020000,
600
+ docs: "https://vueuse.org/integrations/useAxios/",
601
+ category: "@Integrations",
602
+ description: "wrapper for [`axios`](https://github.com/axios/axios)"
603
+ },
604
+ {
605
+ name: "useBase64",
606
+ "package": "core",
607
+ lastUpdated: 1639442454000,
608
+ docs: "https://vueuse.org/core/useBase64/",
609
+ category: "Utilities",
610
+ description: "reactive base64 transforming"
611
+ },
612
+ {
613
+ name: "useBattery",
614
+ "package": "core",
615
+ lastUpdated: 1639442454000,
616
+ component: true,
617
+ docs: "https://vueuse.org/core/useBattery/",
618
+ category: "Sensors",
619
+ description: "reactive [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery_Status_API)"
620
+ },
621
+ {
622
+ name: "useBreakpoints",
623
+ "package": "core",
624
+ lastUpdated: 1645877163000,
625
+ docs: "https://vueuse.org/core/useBreakpoints/",
626
+ category: "Browser",
627
+ description: "reactive viewport breakpoints"
628
+ },
629
+ {
630
+ name: "useBroadcastChannel",
631
+ "package": "core",
632
+ lastUpdated: 1640932168000,
633
+ docs: "https://vueuse.org/core/useBroadcastChannel/",
634
+ category: "Browser",
635
+ description: "reactive [BroadcastChannel API](https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel)"
636
+ },
637
+ {
638
+ name: "useBrowserLocation",
639
+ "package": "core",
640
+ lastUpdated: 1639442454000,
641
+ component: true,
642
+ docs: "https://vueuse.org/core/useBrowserLocation/",
643
+ category: "Browser",
644
+ description: "reactive browser location"
645
+ },
646
+ {
647
+ name: "useCached",
648
+ "package": "core",
649
+ lastUpdated: 1644284136000,
650
+ docs: "https://vueuse.org/core/useCached/",
651
+ category: "Utilities",
652
+ description: "cache a ref with a custom comparator"
653
+ },
654
+ {
655
+ name: "useClamp",
656
+ "package": "core",
657
+ lastUpdated: 1645872829000,
658
+ docs: "https://vueuse.org/core/useClamp/",
659
+ category: "Utilities",
660
+ description: "reactively clamp a value between two other values"
661
+ },
662
+ {
663
+ name: "useClipboard",
664
+ "package": "core",
665
+ lastUpdated: 1639442454000,
666
+ docs: "https://vueuse.org/core/useClipboard/",
667
+ category: "Browser",
668
+ description: "reactive [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API)"
669
+ },
670
+ {
671
+ name: "useColorMode",
672
+ "package": "core",
673
+ lastUpdated: 1641376353000,
674
+ component: true,
675
+ docs: "https://vueuse.org/core/useColorMode/",
676
+ category: "Browser",
677
+ description: "reactive color mode (dark / light / customs) with auto data persistence",
678
+ related: [
679
+ "useDark",
680
+ "usePreferredDark",
681
+ "useStorage"
682
+ ]
683
+ },
684
+ {
685
+ name: "useConfirmDialog",
686
+ "package": "core",
687
+ lastUpdated: 1642756441000,
688
+ docs: "https://vueuse.org/core/useConfirmDialog/",
689
+ category: "Utilities",
690
+ description: "creates event hooks to support modals and confirmation dialog chains"
691
+ },
692
+ {
693
+ name: "useCookies",
694
+ "package": "integrations",
695
+ lastUpdated: 1642756753000,
696
+ docs: "https://vueuse.org/integrations/useCookies/",
697
+ category: "@Integrations",
698
+ description: "wrapper for [`universal-cookie`](https://www.npmjs.com/package/universal-cookie)"
699
+ },
700
+ {
701
+ name: "useCounter",
702
+ "package": "shared",
703
+ lastUpdated: 1637326497000,
704
+ docs: "https://vueuse.org/shared/useCounter/",
705
+ category: "Utilities",
706
+ description: "basic counter with utility functions"
707
+ },
708
+ {
709
+ name: "useCssVar",
710
+ "package": "core",
711
+ lastUpdated: 1644734137000,
712
+ docs: "https://vueuse.org/core/useCssVar/",
713
+ category: "Browser",
714
+ description: "manipulate CSS variables"
715
+ },
716
+ {
717
+ name: "useCycleList",
718
+ "package": "core",
719
+ lastUpdated: 1645016530000,
720
+ docs: "https://vueuse.org/core/useCycleList/",
721
+ category: "Utilities",
722
+ description: "cycle through a list of items"
723
+ },
724
+ {
725
+ name: "useDark",
726
+ "package": "core",
727
+ lastUpdated: 1639442454000,
728
+ component: true,
729
+ docs: "https://vueuse.org/core/useDark/",
730
+ category: "Browser",
731
+ description: "reactive dark mode with auto data persistence",
732
+ related: [
733
+ "useColorMode",
734
+ "usePreferredDark",
735
+ "useStorage"
736
+ ]
737
+ },
738
+ {
739
+ name: "useDateFormat",
740
+ "package": "shared",
741
+ lastUpdated: 1646467330000,
742
+ docs: "https://vueuse.org/shared/useDateFormat/",
743
+ category: "Utilities",
744
+ description: "get the formatted date according to the string of tokens passed in"
745
+ },
746
+ {
747
+ name: "useDebouncedRefHistory",
748
+ "package": "core",
749
+ lastUpdated: 1639442454000,
750
+ docs: "https://vueuse.org/core/useDebouncedRefHistory/",
751
+ category: "State",
752
+ description: "shorthand for `useRefHistory` with debounced filter",
753
+ related: [
754
+ "useRefHistory",
755
+ "useThrottledRefHistory"
756
+ ]
757
+ },
758
+ {
759
+ name: "useDebounceFn",
760
+ "package": "shared",
761
+ lastUpdated: 1639818708000,
762
+ docs: "https://vueuse.org/shared/useDebounceFn/",
763
+ category: "Utilities",
764
+ description: "debounce execution of a function"
765
+ },
766
+ {
767
+ name: "useDeviceMotion",
768
+ "package": "core",
769
+ lastUpdated: 1639442454000,
770
+ component: true,
771
+ docs: "https://vueuse.org/core/useDeviceMotion/",
772
+ category: "Sensors",
773
+ description: "reactive [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent)"
774
+ },
775
+ {
776
+ name: "useDeviceOrientation",
777
+ "package": "core",
778
+ lastUpdated: 1639442454000,
779
+ component: true,
780
+ docs: "https://vueuse.org/core/useDeviceOrientation/",
781
+ category: "Sensors",
782
+ description: "reactive [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent)"
783
+ },
784
+ {
785
+ name: "useDevicePixelRatio",
786
+ "package": "core",
787
+ lastUpdated: 1639442454000,
788
+ component: true,
789
+ docs: "https://vueuse.org/core/useDevicePixelRatio/",
790
+ category: "Sensors",
791
+ description: "reactively track [`window.devicePixelRatio`](https://developer.mozilla.org/ru/docs/Web/API/Window/devicePixelRatio)"
792
+ },
793
+ {
794
+ name: "useDevicesList",
795
+ "package": "core",
796
+ lastUpdated: 1639442454000,
797
+ component: true,
798
+ docs: "https://vueuse.org/core/useDevicesList/",
799
+ category: "Sensors",
800
+ description: "reactive [enumerateDevices](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/enumerateDevices) listing avaliable input/output devices"
801
+ },
802
+ {
803
+ name: "useDisplayMedia",
804
+ "package": "core",
805
+ lastUpdated: 1639818708000,
806
+ docs: "https://vueuse.org/core/useDisplayMedia/",
807
+ category: "Sensors",
808
+ description: "reactive [`mediaDevices.getDisplayMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia) streaming",
809
+ related: [
810
+ "useUserMedia"
811
+ ]
812
+ },
813
+ {
814
+ name: "useDocumentVisibility",
815
+ "package": "core",
816
+ lastUpdated: 1646168589000,
817
+ component: true,
818
+ docs: "https://vueuse.org/core/useDocumentVisibility/",
819
+ category: "Elements",
820
+ description: "reactively track [`document.visibilityState`](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState)"
821
+ },
822
+ {
823
+ name: "useDraggable",
824
+ "package": "core",
825
+ lastUpdated: 1642754143000,
826
+ component: true,
827
+ docs: "https://vueuse.org/core/useDraggable/",
828
+ category: "Elements",
829
+ description: "make elements draggable"
830
+ },
831
+ {
832
+ name: "useDrauu",
833
+ "package": "integrations",
834
+ lastUpdated: 1640682127000,
835
+ docs: "https://vueuse.org/integrations/useDrauu/",
836
+ category: "@Integrations",
837
+ description: "reactive instance for [drauu](https://github.com/antfu/drauu)"
838
+ },
839
+ {
840
+ name: "useElementBounding",
841
+ "package": "core",
842
+ lastUpdated: 1644734103000,
843
+ component: true,
844
+ docs: "https://vueuse.org/core/useElementBounding/",
845
+ category: "Elements",
846
+ description: "reactive [bounding box](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect) of an HTML element"
847
+ },
848
+ {
849
+ name: "useElementByPoint",
850
+ "package": "core",
851
+ lastUpdated: 1640682127000,
852
+ docs: "https://vueuse.org/core/useElementByPoint/",
853
+ category: "Sensors",
854
+ description: "reactive element by point"
855
+ },
856
+ {
857
+ name: "useElementHover",
858
+ "package": "core",
859
+ lastUpdated: 1639442454000,
860
+ directive: true,
861
+ docs: "https://vueuse.org/core/useElementHover/",
862
+ category: "Sensors",
863
+ description: "reactive element's hover state"
864
+ },
865
+ {
866
+ name: "useElementSize",
867
+ "package": "core",
868
+ lastUpdated: 1644734119000,
869
+ component: true,
870
+ docs: "https://vueuse.org/core/useElementSize/",
871
+ category: "Elements",
872
+ description: "reactive size of an HTML element"
873
+ },
874
+ {
875
+ "package": "motion",
876
+ category: "@Motion",
877
+ name: "useElementStyle",
878
+ description: "sync a reactive object to a target element CSS styling",
879
+ external: "https://motion.vueuse.org/api/use-element-style.html"
880
+ },
881
+ {
882
+ "package": "motion",
883
+ category: "@Motion",
884
+ name: "useElementTransform",
885
+ description: "sync a reactive object to a target element CSS transform.",
886
+ external: "https://motion.vueuse.org/api/use-element-transform.html"
887
+ },
888
+ {
889
+ name: "useElementVisibility",
890
+ "package": "core",
891
+ lastUpdated: 1639442454000,
892
+ component: true,
893
+ docs: "https://vueuse.org/core/useElementVisibility/",
894
+ category: "Elements",
895
+ description: "tracks the visibility of an element within the viewport"
896
+ },
897
+ {
898
+ name: "useEventBus",
899
+ "package": "core",
900
+ lastUpdated: 1645877200000,
901
+ docs: "https://vueuse.org/core/useEventBus/",
902
+ category: "Utilities",
903
+ description: "a basic event bus"
904
+ },
905
+ {
906
+ name: "useEventListener",
907
+ "package": "core",
908
+ lastUpdated: 1642756441000,
909
+ docs: "https://vueuse.org/core/useEventListener/",
910
+ category: "Browser",
911
+ description: "use EventListener with ease"
912
+ },
913
+ {
914
+ name: "useEventSource",
915
+ "package": "core",
916
+ lastUpdated: 1639442454000,
917
+ docs: "https://vueuse.org/core/useEventSource/",
918
+ category: "Network",
919
+ description: "an [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) or [Server-Sent-Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) instance opens a persistent connection to an HTTP server"
920
+ },
921
+ {
922
+ name: "useEyeDropper",
923
+ "package": "core",
924
+ lastUpdated: 1637943423000,
925
+ component: true,
926
+ docs: "https://vueuse.org/core/useEyeDropper/",
927
+ category: "Browser",
928
+ description: "reactive [EyeDropper API](https://developer.mozilla.org/en-US/docs/Web/API/EyeDropper_API)"
929
+ },
930
+ {
931
+ name: "useFavicon",
932
+ "package": "core",
933
+ lastUpdated: 1639818708000,
934
+ docs: "https://vueuse.org/core/useFavicon/",
935
+ category: "Browser",
936
+ description: "reactive favicon"
937
+ },
938
+ {
939
+ name: "useFetch",
940
+ "package": "core",
941
+ lastUpdated: 1646234044000,
942
+ docs: "https://vueuse.org/core/useFetch/",
943
+ category: "Network",
944
+ description: "reactive [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) provides the ability to abort requests"
945
+ },
946
+ {
947
+ name: "useFirestore",
948
+ "package": "firebase",
949
+ lastUpdated: 1639442454000,
950
+ docs: "https://vueuse.org/firebase/useFirestore/",
951
+ category: "@Firebase",
952
+ description: "reactive [Firestore](https://firebase.google.com/docs/firestore) binding"
953
+ },
954
+ {
955
+ name: "useFocus",
956
+ "package": "core",
957
+ lastUpdated: 1645994965000,
958
+ docs: "https://vueuse.org/core/useFocus/",
959
+ category: "Sensors",
960
+ description: "reactive utility to track or set the focus state of a DOM element"
961
+ },
962
+ {
963
+ name: "useFocusTrap",
964
+ "package": "integrations",
965
+ lastUpdated: 1639818708000,
966
+ component: true,
967
+ docs: "https://vueuse.org/integrations/useFocusTrap/",
968
+ category: "@Integrations",
969
+ description: "reactive wrapper for [`focus-trap`](https://github.com/focus-trap/focus-trap)"
970
+ },
971
+ {
972
+ name: "useFocusWithin",
973
+ "package": "core",
974
+ lastUpdated: 1639442454000,
975
+ docs: "https://vueuse.org/core/useFocusWithin/",
976
+ category: "Sensors",
977
+ description: "reactive utility to track if an element or one of its decendants has focus"
978
+ },
979
+ {
980
+ name: "useFps",
981
+ "package": "core",
982
+ lastUpdated: 1644734082000,
983
+ docs: "https://vueuse.org/core/useFps/",
984
+ category: "Sensors",
985
+ description: "reactive FPS (frames per second)"
986
+ },
987
+ {
988
+ name: "useFullscreen",
989
+ "package": "core",
990
+ lastUpdated: 1645877181000,
991
+ component: true,
992
+ docs: "https://vueuse.org/core/useFullscreen/",
993
+ category: "Browser",
994
+ description: "reactive [Fullscreen API](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API)"
995
+ },
996
+ {
997
+ name: "useFuse",
998
+ "package": "integrations",
999
+ lastUpdated: 1642756441000,
1000
+ docs: "https://vueuse.org/integrations/useFuse/",
1001
+ category: "@Integrations",
1002
+ description: "easily implement fuzzy search using a composable on top of the zero-dependency library [Fuse.js](https://github.com/krisk/fuse)"
1003
+ },
1004
+ {
1005
+ name: "useGamepad",
1006
+ "package": "core",
1007
+ lastUpdated: 1646467161000,
1008
+ docs: "https://vueuse.org/core/useGamepad/",
1009
+ category: "Browser",
1010
+ description: "provides reactive bindings for the [Gamepad API](https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API)"
1011
+ },
1012
+ {
1013
+ name: "useGeolocation",
1014
+ "package": "core",
1015
+ lastUpdated: 1639442454000,
1016
+ component: true,
1017
+ docs: "https://vueuse.org/core/useGeolocation/",
1018
+ category: "Sensors",
1019
+ description: "reactive [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API)"
1020
+ },
1021
+ {
1022
+ name: "useHead",
1023
+ "package": "head",
1024
+ description: "update head meta tags reactively.",
1025
+ category: "@Head",
1026
+ external: "https://github.com/vueuse/head#api"
1027
+ },
1028
+ {
1029
+ name: "useIdle",
1030
+ "package": "core",
1031
+ lastUpdated: 1639442454000,
1032
+ component: true,
1033
+ docs: "https://vueuse.org/core/useIdle/",
1034
+ category: "Sensors",
1035
+ description: "tracks whether the user is being inactive"
1036
+ },
1037
+ {
1038
+ name: "useInfiniteScroll",
1039
+ "package": "core",
1040
+ lastUpdated: 1644314143000,
1041
+ directive: true,
1042
+ docs: "https://vueuse.org/core/useInfiniteScroll/",
1043
+ category: "Sensors",
1044
+ description: "infinite scrolling of the element"
1045
+ },
1046
+ {
1047
+ name: "useIntersectionObserver",
1048
+ "package": "core",
1049
+ lastUpdated: 1639442454000,
1050
+ directive: true,
1051
+ docs: "https://vueuse.org/core/useIntersectionObserver/",
1052
+ category: "Elements",
1053
+ description: "detects that a target element's visibility"
1054
+ },
1055
+ {
1056
+ name: "useInterval",
1057
+ "package": "shared",
1058
+ lastUpdated: 1644285131000,
1059
+ docs: "https://vueuse.org/shared/useInterval/",
1060
+ category: "Animation",
1061
+ description: "reactive counter increases on every interval"
1062
+ },
1063
+ {
1064
+ name: "useIntervalFn",
1065
+ "package": "shared",
1066
+ lastUpdated: 1644285131000,
1067
+ docs: "https://vueuse.org/shared/useIntervalFn/",
1068
+ category: "Animation",
1069
+ description: "wrapper for `setInterval` with controls"
1070
+ },
1071
+ {
1072
+ name: "useIpcRenderer",
1073
+ "package": "electron",
1074
+ lastUpdated: 1639442454000,
1075
+ docs: "https://vueuse.org/electron/useIpcRenderer/",
1076
+ category: "@Electron",
1077
+ description: "provides [ipcRenderer](https://www.electronjs.org/docs/api/ipc-renderer) and it's all APIs"
1078
+ },
1079
+ {
1080
+ name: "useIpcRendererInvoke",
1081
+ "package": "electron",
1082
+ lastUpdated: 1639442454000,
1083
+ docs: "https://vueuse.org/electron/useIpcRendererInvoke/",
1084
+ category: "@Electron",
1085
+ description: "reactive [ipcRenderer.invoke API](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args) result"
1086
+ },
1087
+ {
1088
+ name: "useIpcRendererOn",
1089
+ "package": "electron",
1090
+ lastUpdated: 1639442454000,
1091
+ docs: "https://vueuse.org/electron/useIpcRendererOn/",
1092
+ category: "@Electron",
1093
+ description: "use [ipcRenderer.on](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener) with ease and [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted"
1094
+ },
1095
+ {
1096
+ name: "useJwt",
1097
+ "package": "integrations",
1098
+ lastUpdated: 1642756441000,
1099
+ docs: "https://vueuse.org/integrations/useJwt/",
1100
+ category: "@Integrations",
1101
+ description: "wrapper for [`jwt-decode`](https://github.com/auth0/jwt-decode)"
1102
+ },
1103
+ {
1104
+ name: "useKeyModifier",
1105
+ "package": "core",
1106
+ lastUpdated: 1639442454000,
1107
+ docs: "https://vueuse.org/core/useKeyModifier/",
1108
+ category: "Sensors",
1109
+ description: "reactive [Modifier State](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/getModifierState)"
1110
+ },
1111
+ {
1112
+ name: "useLastChanged",
1113
+ "package": "shared",
1114
+ lastUpdated: 1642756441000,
1115
+ docs: "https://vueuse.org/shared/useLastChanged/",
1116
+ category: "Utilities",
1117
+ description: "records the timestamp of the last change"
1118
+ },
1119
+ {
1120
+ name: "useLocalStorage",
1121
+ "package": "core",
1122
+ lastUpdated: 1639442454000,
1123
+ docs: "https://vueuse.org/core/useLocalStorage/",
1124
+ category: "State",
1125
+ description: "reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)"
1126
+ },
1127
+ {
1128
+ name: "useMagicKeys",
1129
+ "package": "core",
1130
+ lastUpdated: 1644592765000,
1131
+ docs: "https://vueuse.org/core/useMagicKeys/",
1132
+ category: "Sensors",
1133
+ description: "reactive keys pressed state"
1134
+ },
1135
+ {
1136
+ name: "useManualRefHistory",
1137
+ "package": "core",
1138
+ lastUpdated: 1639818708000,
1139
+ docs: "https://vueuse.org/core/useManualRefHistory/",
1140
+ category: "State",
1141
+ description: "manually track the change history of a ref when the using calls `commit()`"
1142
+ },
1143
+ {
1144
+ name: "useMediaControls",
1145
+ "package": "core",
1146
+ lastUpdated: 1646036662000,
1147
+ docs: "https://vueuse.org/core/useMediaControls/",
1148
+ category: "Browser",
1149
+ description: "reactive media controls for both `audio` and `video` elements"
1150
+ },
1151
+ {
1152
+ name: "useMediaQuery",
1153
+ "package": "core",
1154
+ lastUpdated: 1642756441000,
1155
+ docs: "https://vueuse.org/core/useMediaQuery/",
1156
+ category: "Browser",
1157
+ description: "reactive [Media Query](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Testing_media_queries)"
1158
+ },
1159
+ {
1160
+ name: "useMemoize",
1161
+ "package": "core",
1162
+ lastUpdated: 1640929614000,
1163
+ docs: "https://vueuse.org/core/useMemoize/",
1164
+ category: "Utilities",
1165
+ description: "cache results of functions depending on arguments and keep it reactive"
1166
+ },
1167
+ {
1168
+ name: "useMemory",
1169
+ "package": "core",
1170
+ lastUpdated: 1644734082000,
1171
+ docs: "https://vueuse.org/core/useMemory/",
1172
+ category: "Browser",
1173
+ description: "reactive Memory Info"
1174
+ },
1175
+ {
1176
+ "package": "motion",
1177
+ category: "@Motion",
1178
+ name: "useMotion",
1179
+ description: "putting your components in motion.",
1180
+ external: "https://motion.vueuse.org/api/use-motion.html"
1181
+ },
1182
+ {
1183
+ "package": "motion",
1184
+ category: "@Motion",
1185
+ name: "useMotionProperties",
1186
+ description: "access Motion Properties for a target element.",
1187
+ external: "https://motion.vueuse.org/api/use-motion-properties.html"
1188
+ },
1189
+ {
1190
+ "package": "motion",
1191
+ category: "@Motion",
1192
+ name: "useMotionVariants",
1193
+ description: "handle the Variants state and selection.",
1194
+ external: "https://motion.vueuse.org/api/use-motion-variants.html"
1195
+ },
1196
+ {
1197
+ name: "useMounted",
1198
+ "package": "core",
1199
+ lastUpdated: 1640933217000,
1200
+ docs: "https://vueuse.org/core/useMounted/",
1201
+ category: "Component",
1202
+ description: "mounted state in ref"
1203
+ },
1204
+ {
1205
+ name: "useMouse",
1206
+ "package": "core",
1207
+ lastUpdated: 1644822501000,
1208
+ component: true,
1209
+ docs: "https://vueuse.org/core/useMouse/",
1210
+ category: "Sensors",
1211
+ description: "reactive mouse position"
1212
+ },
1213
+ {
1214
+ name: "useMouseInElement",
1215
+ "package": "core",
1216
+ lastUpdated: 1639442454000,
1217
+ component: true,
1218
+ docs: "https://vueuse.org/core/useMouseInElement/",
1219
+ category: "Elements",
1220
+ description: "reactive mouse position related to an element"
1221
+ },
1222
+ {
1223
+ name: "useMousePressed",
1224
+ "package": "core",
1225
+ lastUpdated: 1639818708000,
1226
+ component: true,
1227
+ docs: "https://vueuse.org/core/useMousePressed/",
1228
+ category: "Sensors",
1229
+ description: "reactive mouse pressing state"
1230
+ },
1231
+ {
1232
+ name: "useMutationObserver",
1233
+ "package": "core",
1234
+ lastUpdated: 1639442454000,
1235
+ docs: "https://vueuse.org/core/useMutationObserver/",
1236
+ category: "Elements",
1237
+ description: "watch for changes being made to the DOM tree"
1238
+ },
1239
+ {
1240
+ name: "useNavigatorLanguage",
1241
+ "package": "core",
1242
+ lastUpdated: 1639442454000,
1243
+ docs: "https://vueuse.org/core/useNavigatorLanguage/",
1244
+ category: "Sensors",
1245
+ description: "watch for changes being made to the navigator language preference by the user"
1246
+ },
1247
+ {
1248
+ name: "useNetwork",
1249
+ "package": "core",
1250
+ lastUpdated: 1639442454000,
1251
+ component: true,
1252
+ docs: "https://vueuse.org/core/useNetwork/",
1253
+ category: "Sensors",
1254
+ description: "reactive [Network status](https://developer.mozilla.org/en-US/docs/Web/API/Network_Information_API)"
1255
+ },
1256
+ {
1257
+ name: "useNow",
1258
+ "package": "core",
1259
+ lastUpdated: 1639442454000,
1260
+ component: true,
1261
+ docs: "https://vueuse.org/core/useNow/",
1262
+ category: "Animation",
1263
+ description: "reactive current Date instance"
1264
+ },
1265
+ {
1266
+ name: "useNProgress",
1267
+ "package": "integrations",
1268
+ lastUpdated: 1639818708000,
1269
+ docs: "https://vueuse.org/integrations/useNProgress/",
1270
+ category: "@Integrations",
1271
+ description: "reactive wrapper for [`nprogress`](https://github.com/rstacruz/nprogress)"
1272
+ },
1273
+ {
1274
+ name: "useObservable",
1275
+ "package": "rxjs",
1276
+ lastUpdated: 1639442454000,
1277
+ docs: "https://vueuse.org/rxjs/useObservable/",
1278
+ category: "@RxJS",
1279
+ description: "use an Observable"
1280
+ },
1281
+ {
1282
+ name: "useOffsetPagination",
1283
+ "package": "core",
1284
+ lastUpdated: 1645952780000,
1285
+ component: true,
1286
+ docs: "https://vueuse.org/core/useOffsetPagination/",
1287
+ category: "Utilities",
1288
+ description: "reactive offset pagination"
1289
+ },
1290
+ {
1291
+ name: "useOnline",
1292
+ "package": "core",
1293
+ lastUpdated: 1639442454000,
1294
+ component: true,
1295
+ docs: "https://vueuse.org/core/useOnline/",
1296
+ category: "Sensors",
1297
+ description: "reactive online state"
1298
+ },
1299
+ {
1300
+ name: "usePageLeave",
1301
+ "package": "core",
1302
+ lastUpdated: 1642756441000,
1303
+ component: true,
1304
+ docs: "https://vueuse.org/core/usePageLeave/",
1305
+ category: "Sensors",
1306
+ description: "reactive state to show whether the mouse leaves the page"
1307
+ },
1308
+ {
1309
+ name: "useParallax",
1310
+ "package": "core",
1311
+ lastUpdated: 1639442454000,
1312
+ docs: "https://vueuse.org/core/useParallax/",
1313
+ category: "Sensors",
1314
+ description: "create parallax effect easily"
1315
+ },
1316
+ {
1317
+ name: "usePermission",
1318
+ "package": "core",
1319
+ lastUpdated: 1639442454000,
1320
+ docs: "https://vueuse.org/core/usePermission/",
1321
+ category: "Browser",
1322
+ description: "reactive [Permissions API](https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API)"
1323
+ },
1324
+ {
1325
+ name: "usePointer",
1326
+ "package": "core",
1327
+ lastUpdated: 1639442454000,
1328
+ component: true,
1329
+ docs: "https://vueuse.org/core/usePointer/",
1330
+ category: "Sensors",
1331
+ description: "reactive [pointer state](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_events)"
1332
+ },
1333
+ {
1334
+ name: "usePointerSwipe",
1335
+ "package": "core",
1336
+ lastUpdated: 1639442454000,
1337
+ docs: "https://vueuse.org/core/usePointerSwipe/",
1338
+ category: "Sensors",
1339
+ description: "reactive swipe detection based on [PointerEvents](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent)"
1340
+ },
1341
+ {
1342
+ name: "usePreferredColorScheme",
1343
+ "package": "core",
1344
+ lastUpdated: 1639442454000,
1345
+ component: true,
1346
+ docs: "https://vueuse.org/core/usePreferredColorScheme/",
1347
+ category: "Browser",
1348
+ description: "reactive [prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) media query"
1349
+ },
1350
+ {
1351
+ name: "usePreferredDark",
1352
+ "package": "core",
1353
+ lastUpdated: 1639442454000,
1354
+ component: true,
1355
+ docs: "https://vueuse.org/core/usePreferredDark/",
1356
+ category: "Browser",
1357
+ description: "reactive dark theme preference",
1358
+ related: [
1359
+ "useColorMode",
1360
+ "useDark"
1361
+ ]
1362
+ },
1363
+ {
1364
+ name: "usePreferredLanguages",
1365
+ "package": "core",
1366
+ lastUpdated: 1639442454000,
1367
+ component: true,
1368
+ docs: "https://vueuse.org/core/usePreferredLanguages/",
1369
+ category: "Browser",
1370
+ description: "reactive [Navigator Languages](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorLanguage/languages)"
1371
+ },
1372
+ {
1373
+ name: "useQRCode",
1374
+ "package": "integrations",
1375
+ lastUpdated: 1639442454000,
1376
+ docs: "https://vueuse.org/integrations/useQRCode/",
1377
+ category: "@Integrations",
1378
+ description: "wrapper for [`qrcode`](https://github.com/soldair/node-qrcode)"
1379
+ },
1380
+ {
1381
+ name: "useRafFn",
1382
+ "package": "core",
1383
+ lastUpdated: 1639818708000,
1384
+ docs: "https://vueuse.org/core/useRafFn/",
1385
+ category: "Animation",
1386
+ description: "call function on every `requestAnimationFrame`"
1387
+ },
1388
+ {
1389
+ name: "useRefHistory",
1390
+ "package": "core",
1391
+ lastUpdated: 1646036662000,
1392
+ docs: "https://vueuse.org/core/useRefHistory/",
1393
+ category: "State",
1394
+ description: "track the change history of a ref",
1395
+ related: [
1396
+ "useDebouncedRefHistory"
1397
+ ]
1398
+ },
1399
+ {
1400
+ name: "useResizeObserver",
1401
+ "package": "core",
1402
+ lastUpdated: 1640682127000,
1403
+ docs: "https://vueuse.org/core/useResizeObserver/",
1404
+ category: "Elements",
1405
+ description: "reports changes to the dimensions of an Element's content or the border-box"
1406
+ },
1407
+ {
1408
+ name: "useRouteHash",
1409
+ "package": "router",
1410
+ lastUpdated: 1639442454000,
1411
+ docs: "https://vueuse.org/router/useRouteHash/",
1412
+ category: "@Router",
1413
+ description: "shorthand for reactive route.hash"
1414
+ },
1415
+ {
1416
+ name: "useRouteQuery",
1417
+ "package": "router",
1418
+ lastUpdated: 1639442454000,
1419
+ docs: "https://vueuse.org/router/useRouteQuery/",
1420
+ category: "@Router",
1421
+ description: "shorthand for reactive route.query"
1422
+ },
1423
+ {
1424
+ name: "useRTDB",
1425
+ "package": "firebase",
1426
+ lastUpdated: 1639442454000,
1427
+ docs: "https://vueuse.org/firebase/useRTDB/",
1428
+ category: "@Firebase",
1429
+ description: "reactive [Firebase Realtime Database](https://firebase.google.com/docs/database) binding"
1430
+ },
1431
+ {
1432
+ name: "useScreenSafeArea",
1433
+ "package": "core",
1434
+ lastUpdated: 1640682127000,
1435
+ component: true,
1436
+ docs: "https://vueuse.org/core/useScreenSafeArea/",
1437
+ category: "Browser",
1438
+ description: "reactive `env(safe-area-inset-*)`"
1439
+ },
1440
+ {
1441
+ name: "useScriptTag",
1442
+ "package": "core",
1443
+ lastUpdated: 1644470897000,
1444
+ docs: "https://vueuse.org/core/useScriptTag/",
1445
+ category: "Browser",
1446
+ description: "script tag injecting"
1447
+ },
1448
+ {
1449
+ name: "useScroll",
1450
+ "package": "core",
1451
+ lastUpdated: 1639818708000,
1452
+ directive: true,
1453
+ docs: "https://vueuse.org/core/useScroll/",
1454
+ category: "Sensors",
1455
+ description: "reactive scroll position and state"
1456
+ },
1457
+ {
1458
+ name: "useScrollLock",
1459
+ "package": "core",
1460
+ lastUpdated: 1646237369000,
1461
+ directive: true,
1462
+ docs: "https://vueuse.org/core/useScrollLock/",
1463
+ category: "Sensors",
1464
+ description: "lock scrolling of the element"
1465
+ },
1466
+ {
1467
+ name: "useSessionStorage",
1468
+ "package": "core",
1469
+ lastUpdated: 1639442454000,
1470
+ docs: "https://vueuse.org/core/useSessionStorage/",
1471
+ category: "State",
1472
+ description: "reactive [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)"
1473
+ },
1474
+ {
1475
+ name: "useShare",
1476
+ "package": "core",
1477
+ lastUpdated: 1639442454000,
1478
+ docs: "https://vueuse.org/core/useShare/",
1479
+ category: "Browser",
1480
+ description: "reactive [Web Share API](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/share)"
1481
+ },
1482
+ {
1483
+ name: "useSound",
1484
+ "package": "sound",
1485
+ description: "play sound effects reactively.",
1486
+ category: "@Sound",
1487
+ external: "https://github.com/vueuse/sound#examples"
1488
+ },
1489
+ {
1490
+ name: "useSpeechRecognition",
1491
+ "package": "core",
1492
+ lastUpdated: 1639818708000,
1493
+ docs: "https://vueuse.org/core/useSpeechRecognition/",
1494
+ category: "Sensors",
1495
+ description: "reactive [SpeechRecognition](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition)"
1496
+ },
1497
+ {
1498
+ name: "useSpeechSynthesis",
1499
+ "package": "core",
1500
+ lastUpdated: 1639818708000,
1501
+ docs: "https://vueuse.org/core/useSpeechSynthesis/",
1502
+ category: "Sensors",
1503
+ description: "reactive [SpeechSynthesis](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis)"
1504
+ },
1505
+ {
1506
+ "package": "motion",
1507
+ category: "@Motion",
1508
+ name: "useSpring",
1509
+ description: "spring animations.",
1510
+ external: "https://motion.vueuse.org/api/use-spring.html"
1511
+ },
1512
+ {
1513
+ name: "useStorage",
1514
+ "package": "core",
1515
+ lastUpdated: 1643314821000,
1516
+ docs: "https://vueuse.org/core/useStorage/",
1517
+ category: "State",
1518
+ description: "reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)/[SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)",
1519
+ related: [
1520
+ "useColorMode",
1521
+ "useDark"
1522
+ ]
1523
+ },
1524
+ {
1525
+ name: "useStorageAsync",
1526
+ "package": "core",
1527
+ lastUpdated: 1641376353000,
1528
+ docs: "https://vueuse.org/core/useStorageAsync/",
1529
+ category: "State",
1530
+ description: "reactive Storage in with async support"
1531
+ },
1532
+ {
1533
+ name: "useStyleTag",
1534
+ "package": "core",
1535
+ lastUpdated: 1643124348000,
1536
+ docs: "https://vueuse.org/core/useStyleTag/",
1537
+ category: "Browser",
1538
+ description: "inject reactive `style` element in head"
1539
+ },
1540
+ {
1541
+ name: "useSubject",
1542
+ "package": "rxjs",
1543
+ lastUpdated: 1639442454000,
1544
+ docs: "https://vueuse.org/rxjs/useSubject/",
1545
+ category: "@RxJS",
1546
+ description: "bind Subject to ref and propagate value changes both ways"
1547
+ },
1548
+ {
1549
+ name: "useSubscription",
1550
+ "package": "rxjs",
1551
+ lastUpdated: 1628521945000,
1552
+ docs: "https://vueuse.org/rxjs/useSubscription/",
1553
+ category: "@RxJS",
1554
+ description: "uses subscriptions without worry about unsubscribing to it or memory leaks"
1555
+ },
1556
+ {
1557
+ name: "useSwipe",
1558
+ "package": "core",
1559
+ lastUpdated: 1639442454000,
1560
+ docs: "https://vueuse.org/core/useSwipe/",
1561
+ category: "Sensors",
1562
+ description: "reactive swipe detection based on [`TouchEvents`](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent)"
1563
+ },
1564
+ {
1565
+ name: "useTemplateRefsList",
1566
+ "package": "core",
1567
+ lastUpdated: 1639442454000,
1568
+ docs: "https://vueuse.org/core/useTemplateRefsList/",
1569
+ category: "Component",
1570
+ description: "shorthand for binding refs to template elements and components inside `v-for`"
1571
+ },
1572
+ {
1573
+ name: "useTextSelection",
1574
+ "package": "core",
1575
+ lastUpdated: 1646469737000,
1576
+ docs: "https://vueuse.org/core/useTextSelection/",
1577
+ category: "Sensors",
1578
+ description: "reactively track user text selection based on [`Window.getSelection`](https://developer.mozilla.org/en-US/docs/Web/API/Window/getSelection)"
1579
+ },
1580
+ {
1581
+ name: "useThrottledRefHistory",
1582
+ "package": "core",
1583
+ lastUpdated: 1639442454000,
1584
+ docs: "https://vueuse.org/core/useThrottledRefHistory/",
1585
+ category: "State",
1586
+ description: "shorthand for `useRefHistory` with throttled filter",
1587
+ related: [
1588
+ "useDebouncedRefHistory"
1589
+ ]
1590
+ },
1591
+ {
1592
+ name: "useThrottleFn",
1593
+ "package": "shared",
1594
+ lastUpdated: 1639442454000,
1595
+ docs: "https://vueuse.org/shared/useThrottleFn/",
1596
+ category: "Utilities",
1597
+ description: "throttle execution of a function"
1598
+ },
1599
+ {
1600
+ name: "useTimeAgo",
1601
+ "package": "core",
1602
+ lastUpdated: 1639442454000,
1603
+ component: true,
1604
+ docs: "https://vueuse.org/core/useTimeAgo/",
1605
+ category: "Misc",
1606
+ description: "reactive time ago"
1607
+ },
1608
+ {
1609
+ name: "useTimeout",
1610
+ "package": "shared",
1611
+ lastUpdated: 1639442454000,
1612
+ docs: "https://vueuse.org/shared/useTimeout/",
1613
+ category: "Animation",
1614
+ description: "update value after a given time with controls"
1615
+ },
1616
+ {
1617
+ name: "useTimeoutFn",
1618
+ "package": "shared",
1619
+ lastUpdated: 1642756441000,
1620
+ docs: "https://vueuse.org/shared/useTimeoutFn/",
1621
+ category: "Animation",
1622
+ description: "wrapper for `setTimeout` with controls"
1623
+ },
1624
+ {
1625
+ name: "useTimeoutPoll",
1626
+ "package": "core",
1627
+ lastUpdated: 1646467705000,
1628
+ docs: "https://vueuse.org/core/useTimeoutPoll/",
1629
+ category: "Utilities",
1630
+ description: "use timeout to poll something"
1631
+ },
1632
+ {
1633
+ name: "useTimestamp",
1634
+ "package": "core",
1635
+ lastUpdated: 1639442454000,
1636
+ component: true,
1637
+ docs: "https://vueuse.org/core/useTimestamp/",
1638
+ category: "Animation",
1639
+ description: "reactive current timestamp"
1640
+ },
1641
+ {
1642
+ name: "useTitle",
1643
+ "package": "core",
1644
+ lastUpdated: 1640175570000,
1645
+ docs: "https://vueuse.org/core/useTitle/",
1646
+ category: "Browser",
1647
+ description: "reactive document title"
1648
+ },
1649
+ {
1650
+ name: "useToggle",
1651
+ "package": "shared",
1652
+ lastUpdated: 1644734054000,
1653
+ docs: "https://vueuse.org/shared/useToggle/",
1654
+ category: "Utilities",
1655
+ description: "a boolean switcher with utility functions"
1656
+ },
1657
+ {
1658
+ name: "useTransition",
1659
+ "package": "core",
1660
+ lastUpdated: 1642756441000,
1661
+ docs: "https://vueuse.org/core/useTransition/",
1662
+ category: "Animation",
1663
+ description: "transition between values"
1664
+ },
1665
+ {
1666
+ name: "useUrlSearchParams",
1667
+ "package": "core",
1668
+ lastUpdated: 1639442454000,
1669
+ docs: "https://vueuse.org/core/useUrlSearchParams/",
1670
+ category: "Browser",
1671
+ description: "reactive [URLSearchParams](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams)"
1672
+ },
1673
+ {
1674
+ name: "useUserMedia",
1675
+ "package": "core",
1676
+ lastUpdated: 1639818708000,
1677
+ docs: "https://vueuse.org/core/useUserMedia/",
1678
+ category: "Sensors",
1679
+ description: "reactive [`mediaDevices.getUserMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) streaming",
1680
+ related: [
1681
+ "useDisplayMedia"
1682
+ ]
1683
+ },
1684
+ {
1685
+ name: "useVibrate",
1686
+ "package": "core",
1687
+ lastUpdated: 1640932230000,
1688
+ docs: "https://vueuse.org/core/useVibrate/",
1689
+ category: "Browser",
1690
+ description: "reactive [Vibration API](https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API)"
1691
+ },
1692
+ {
1693
+ name: "useVirtualList",
1694
+ "package": "core",
1695
+ lastUpdated: 1642756441000,
1696
+ component: true,
1697
+ docs: "https://vueuse.org/core/useVirtualList/",
1698
+ category: "Component",
1699
+ description: "create virtual lists with ease"
1700
+ },
1701
+ {
1702
+ name: "useVModel",
1703
+ "package": "core",
1704
+ lastUpdated: 1639442454000,
1705
+ docs: "https://vueuse.org/core/useVModel/",
1706
+ category: "Component",
1707
+ description: "shorthand for v-model binding"
1708
+ },
1709
+ {
1710
+ name: "useVModels",
1711
+ "package": "core",
1712
+ lastUpdated: 1639442454000,
1713
+ docs: "https://vueuse.org/core/useVModels/",
1714
+ category: "Component",
1715
+ description: "shorthand for props v-model binding"
1716
+ },
1717
+ {
1718
+ name: "useWakeLock",
1719
+ "package": "core",
1720
+ lastUpdated: 1640682127000,
1721
+ docs: "https://vueuse.org/core/useWakeLock/",
1722
+ category: "Browser",
1723
+ description: "reactive [Screen Wake Lock API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API) provides a way to prevent devices from dimming or locking the screen when an application needs to keep running"
1724
+ },
1725
+ {
1726
+ name: "useWebNotification",
1727
+ "package": "core",
1728
+ lastUpdated: 1640933217000,
1729
+ docs: "https://vueuse.org/core/useWebNotification/",
1730
+ category: "Browser",
1731
+ description: "reactive [Notification](https://developer.mozilla.org/en-US/docs/Web/API/notification)"
1732
+ },
1733
+ {
1734
+ name: "useWebSocket",
1735
+ "package": "core",
1736
+ lastUpdated: 1641985525000,
1737
+ docs: "https://vueuse.org/core/useWebSocket/",
1738
+ category: "Network",
1739
+ description: "reactive [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket) client"
1740
+ },
1741
+ {
1742
+ name: "useWebWorker",
1743
+ "package": "core",
1744
+ lastUpdated: 1639442454000,
1745
+ docs: "https://vueuse.org/core/useWebWorker/",
1746
+ category: "Misc",
1747
+ description: "simple [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) registration and communication"
1748
+ },
1749
+ {
1750
+ name: "useWebWorkerFn",
1751
+ "package": "core",
1752
+ lastUpdated: 1639442454000,
1753
+ docs: "https://vueuse.org/core/useWebWorkerFn/",
1754
+ category: "Misc",
1755
+ description: "run expensive functions without blocking the UI"
1756
+ },
1757
+ {
1758
+ name: "useWindowFocus",
1759
+ "package": "core",
1760
+ lastUpdated: 1639442454000,
1761
+ component: true,
1762
+ docs: "https://vueuse.org/core/useWindowFocus/",
1763
+ category: "Elements",
1764
+ description: "reactively track window focus with `window.onfocus` and `window.onblur` events"
1765
+ },
1766
+ {
1767
+ name: "useWindowScroll",
1768
+ "package": "core",
1769
+ lastUpdated: 1639442454000,
1770
+ docs: "https://vueuse.org/core/useWindowScroll/",
1771
+ category: "Elements",
1772
+ description: "reactive window scroll"
1773
+ },
1774
+ {
1775
+ name: "useWindowSize",
1776
+ "package": "core",
1777
+ lastUpdated: 1639442454000,
1778
+ component: true,
1779
+ docs: "https://vueuse.org/core/useWindowSize/",
1780
+ category: "Elements",
1781
+ description: "reactive window size"
1782
+ },
1783
+ {
1784
+ name: "useZoomFactor",
1785
+ "package": "electron",
1786
+ lastUpdated: 1639442454000,
1787
+ docs: "https://vueuse.org/electron/useZoomFactor/",
1788
+ category: "@Electron",
1789
+ description: "reactive [WebFrame](https://www.electronjs.org/docs/api/web-frame#webframe) zoom factor"
1790
+ },
1791
+ {
1792
+ name: "useZoomLevel",
1793
+ "package": "electron",
1794
+ lastUpdated: 1639442454000,
1795
+ docs: "https://vueuse.org/electron/useZoomLevel/",
1796
+ category: "@Electron",
1797
+ description: "reactive [WebFrame](https://www.electronjs.org/docs/api/web-frame#webframe) zoom level"
1798
+ },
1799
+ {
1800
+ name: "utils",
1801
+ "package": "shared",
1802
+ lastUpdated: 1631121093000,
1803
+ internal: true
1804
+ },
1805
+ {
1806
+ name: "watchAtMost",
1807
+ "package": "shared",
1808
+ lastUpdated: 1643036457000,
1809
+ docs: "https://vueuse.org/shared/watchAtMost/",
1810
+ category: "Watch",
1811
+ description: "`watch` with the number of times triggered"
1812
+ },
1813
+ {
1814
+ name: "watchDebounced",
1815
+ "package": "shared",
1816
+ lastUpdated: 1646036693000,
1817
+ docs: "https://vueuse.org/shared/watchDebounced/",
1818
+ category: "Watch",
1819
+ description: "debounced watch",
1820
+ alias: [
1821
+ "debouncedWatch"
1822
+ ]
1823
+ },
1824
+ {
1825
+ name: "watchIgnorable",
1826
+ "package": "shared",
1827
+ lastUpdated: 1646036662000,
1828
+ docs: "https://vueuse.org/shared/watchIgnorable/",
1829
+ category: "Watch",
1830
+ description: "ignorable watch",
1831
+ alias: [
1832
+ "ignorableWatch"
1833
+ ]
1834
+ },
1835
+ {
1836
+ name: "watchOnce",
1837
+ "package": "shared",
1838
+ lastUpdated: 1643036457000,
1839
+ docs: "https://vueuse.org/shared/watchOnce/",
1840
+ category: "Watch",
1841
+ description: "`watch` that only triggers once"
1842
+ },
1843
+ {
1844
+ name: "watchPausable",
1845
+ "package": "shared",
1846
+ lastUpdated: 1645958231000,
1847
+ docs: "https://vueuse.org/shared/watchPausable/",
1848
+ category: "Watch",
1849
+ description: "pausable watch",
1850
+ alias: [
1851
+ "pausableWatch"
1852
+ ]
1853
+ },
1854
+ {
1855
+ name: "watchThrottled",
1856
+ "package": "shared",
1857
+ lastUpdated: 1646036722000,
1858
+ docs: "https://vueuse.org/shared/watchThrottled/",
1859
+ category: "Watch",
1860
+ description: "throttled watch",
1861
+ alias: [
1862
+ "throttledWatch"
1863
+ ]
1864
+ },
1865
+ {
1866
+ name: "watchWithFilter",
1867
+ "package": "shared",
1868
+ lastUpdated: 1639818708000,
1869
+ docs: "https://vueuse.org/shared/watchWithFilter/",
1870
+ category: "Watch",
1871
+ description: "`watch` with additional EventFilter control"
1872
+ },
1873
+ {
1874
+ name: "whenever",
1875
+ "package": "shared",
1876
+ lastUpdated: 1644664454000,
1877
+ docs: "https://vueuse.org/shared/whenever/",
1878
+ category: "Watch",
1879
+ description: "shorthand for watching value to be truthy"
1880
+ }
1881
+ ];
1882
+ var _metadata = {
1883
+ packages: packages$1,
1884
+ categories: categories$1,
1885
+ functions: functions$1
1886
+ };
1887
+
1888
+ const categoriesOrder = [
1889
+ "Browser",
1890
+ "Sensors",
1891
+ "Animation",
1892
+ "State",
1893
+ "Elements",
1894
+ "Component",
1895
+ "Watch",
1896
+ "Network",
1897
+ "Utilities",
1898
+ "Misc"
1899
+ ];
1900
+ const metadata = _metadata;
1901
+ const functions = functions$1;
1902
+ const packages = packages$1;
1903
+ const categories = categories$1;
1904
+ const functionNames = functions.map((f) => f.name);
1905
+ const categoryNames = Array.from(categories).sort((a, b) => categoriesOrder.indexOf(a) - categoriesOrder.indexOf(b)).sort((a, b) => a.startsWith("@") ? 1 : b.startsWith("@") ? -1 : 0);
1906
+ const coreCategoryNames = categoryNames.filter((f) => !f.startsWith("@"));
1907
+ const addonCategoryNames = categoryNames.filter((f) => f.startsWith("@"));
1908
+ const getFunction = (name) => metadata.functions.find((f) => f.name === name);
1909
+
1910
+ function getCategories(functions) {
1911
+ return uniq(functions.filter((i) => !i.internal).map((i) => i.category).filter(Boolean)).sort((a, b) => a.startsWith("@") && !b.startsWith("@") ? 1 : b.startsWith("@") && !a.startsWith("@") ? -1 : a.localeCompare(b));
1912
+ }
1913
+ function uniq(a) {
1914
+ return Array.from(new Set(a));
1915
+ }
1916
+
1917
+ exports.addonCategoryNames = addonCategoryNames;
1918
+ exports.categories = categories;
1919
+ exports.categoryNames = categoryNames;
1920
+ exports.coreCategoryNames = coreCategoryNames;
1921
+ exports.functionNames = functionNames;
1922
+ exports.functions = functions;
1923
+ exports.getCategories = getCategories;
1924
+ exports.getFunction = getFunction;
1925
+ exports.metadata = metadata;
1926
+ exports.packages = packages;
1927
+ exports.uniq = uniq;