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