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