index.json 76 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455
  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. "math": {
  26. "name": "math",
  27. "display": "Math",
  28. "description": "Math functions for VueUse",
  29. "external": [
  30. "@vueuse/shared"
  31. ],
  32. "dir": "packages/math"
  33. },
  34. "router": {
  35. "name": "router",
  36. "display": "Router",
  37. "description": "Utilities for vue-router",
  38. "addon": true,
  39. "external": [
  40. "vue-router"
  41. ],
  42. "globals": {
  43. "vue-router": "VueRouter"
  44. },
  45. "dir": "packages/router",
  46. "docs": "https://vueuse.org/router/README.html"
  47. },
  48. "integrations": {
  49. "name": "integrations",
  50. "display": "Integrations",
  51. "description": "Integration wrappers for utility libraries",
  52. "addon": true,
  53. "submodules": true,
  54. "external": [
  55. "axios",
  56. "universal-cookie",
  57. "qrcode",
  58. "http",
  59. "nprogress",
  60. "jwt-decode",
  61. "focus-trap",
  62. "change-case",
  63. "drauu",
  64. "@vueuse/core",
  65. "@vueuse/shared",
  66. "fuse.js",
  67. "async-validator",
  68. "idb-keyval"
  69. ],
  70. "globals": {
  71. "axios": "axios",
  72. "universal-cookie": "UniversalCookie",
  73. "qrcode": "QRCode",
  74. "nprogress": "nprogress",
  75. "jwt-decode": "jwt_decode",
  76. "focus-trap": "focusTrap",
  77. "drauu": "Drauu",
  78. "fuse.js": "Fuse",
  79. "change-case": "changeCase",
  80. "async-validator": "AsyncValidator",
  81. "idb-keyval": "idbKeyval"
  82. },
  83. "dir": "packages/integrations",
  84. "docs": "https://vueuse.org/integrations/README.html"
  85. },
  86. "rxjs": {
  87. "name": "rxjs",
  88. "display": "RxJS",
  89. "description": "Enables RxJS reactive functions in Vue",
  90. "addon": true,
  91. "external": [
  92. "rxjs",
  93. "rxjs/operators"
  94. ],
  95. "globals": {
  96. "rxjs": "rxjs",
  97. "rxjs/operators": "rxjs.operator"
  98. },
  99. "dir": "packages/rxjs",
  100. "docs": "https://vueuse.org/rxjs/README.html"
  101. },
  102. "firebase": {
  103. "name": "firebase",
  104. "display": "Firebase",
  105. "description": "Enables realtime bindings for Firebase",
  106. "addon": true,
  107. "submodules": true,
  108. "external": [
  109. "firebase",
  110. "firebase/app",
  111. "firebase/database",
  112. "firebase/firestore"
  113. ],
  114. "globals": {
  115. "firebase": "firebase",
  116. "firebase/app": "firebase",
  117. "firebase/database": "firebase",
  118. "firebase/firestore": "firebase"
  119. },
  120. "dir": "packages/firebase",
  121. "docs": "https://vueuse.org/firebase/README.html"
  122. },
  123. "electron": {
  124. "name": "electron",
  125. "display": "Electron",
  126. "description": "Electron renderer process modules for VueUse",
  127. "author": "Archer Gu<https://github.com/ArcherGu>",
  128. "addon": true,
  129. "external": [
  130. "electron"
  131. ],
  132. "iife": false,
  133. "dir": "packages/electron",
  134. "docs": "https://vueuse.org/electron/README.html"
  135. }
  136. },
  137. "categories": [
  138. "Animation",
  139. "Array",
  140. "Browser",
  141. "Component",
  142. "Elements",
  143. "Network",
  144. "Reactivity",
  145. "Sensors",
  146. "State",
  147. "Time",
  148. "Utilities",
  149. "Watch",
  150. "@Electron",
  151. "@Firebase",
  152. "@Head",
  153. "@Integrations",
  154. "@Math",
  155. "@Motion",
  156. "@Router",
  157. "@RxJS",
  158. "@SchemaOrg",
  159. "@Sound"
  160. ],
  161. "functions": [
  162. {
  163. "name": "computedAsync",
  164. "package": "core",
  165. "lastUpdated": 1672940168000,
  166. "docs": "https://vueuse.org/core/computedAsync/",
  167. "category": "Reactivity",
  168. "description": "computed for async functions",
  169. "alias": [
  170. "asyncComputed"
  171. ]
  172. },
  173. {
  174. "name": "computedEager",
  175. "package": "shared",
  176. "lastUpdated": 1645956777000,
  177. "docs": "https://vueuse.org/shared/computedEager/",
  178. "category": "Reactivity",
  179. "description": "eager computed without lazy evaluation",
  180. "alias": [
  181. "eagerComputed"
  182. ]
  183. },
  184. {
  185. "name": "computedInject",
  186. "package": "core",
  187. "lastUpdated": 1662388825000,
  188. "docs": "https://vueuse.org/core/computedInject/",
  189. "category": "Component",
  190. "description": "combine computed and inject"
  191. },
  192. {
  193. "name": "computedWithControl",
  194. "package": "shared",
  195. "lastUpdated": 1657102664000,
  196. "docs": "https://vueuse.org/shared/computedWithControl/",
  197. "category": "Reactivity",
  198. "description": "explicitly define the dependencies of computed",
  199. "alias": [
  200. "controlledComputed"
  201. ],
  202. "related": [
  203. "refWithControl"
  204. ]
  205. },
  206. {
  207. "name": "createEventHook",
  208. "package": "shared",
  209. "lastUpdated": 1671205540000,
  210. "docs": "https://vueuse.org/shared/createEventHook/",
  211. "category": "Utilities",
  212. "description": "utility for creating event hooks"
  213. },
  214. {
  215. "name": "createGenericProjection",
  216. "package": "math",
  217. "lastUpdated": 1667952962000,
  218. "docs": "https://vueuse.org/math/createGenericProjection/",
  219. "category": "@Math",
  220. "description": "generic version of `createProjection`",
  221. "related": [
  222. "createProjection",
  223. "useProjection"
  224. ]
  225. },
  226. {
  227. "name": "createGlobalState",
  228. "package": "shared",
  229. "lastUpdated": 1625749207000,
  230. "docs": "https://vueuse.org/shared/createGlobalState/",
  231. "category": "State",
  232. "description": "keep states in the global scope to be reusable across Vue instances",
  233. "related": [
  234. "createSharedComposable"
  235. ]
  236. },
  237. {
  238. "name": "createHead",
  239. "package": "head",
  240. "description": "create the head manager instance.",
  241. "category": "@Head",
  242. "external": "https://github.com/vueuse/head#api"
  243. },
  244. {
  245. "name": "createInjectionState",
  246. "package": "shared",
  247. "lastUpdated": 1673947341000,
  248. "docs": "https://vueuse.org/shared/createInjectionState/",
  249. "category": "State",
  250. "description": "create global state that can be injected into components"
  251. },
  252. {
  253. "name": "createProjection",
  254. "package": "math",
  255. "lastUpdated": 1657437998000,
  256. "docs": "https://vueuse.org/math/createProjection/",
  257. "category": "@Math",
  258. "description": "reactive numeric projection from one domain to another",
  259. "related": [
  260. "createGenericProjection",
  261. "useProjection"
  262. ]
  263. },
  264. {
  265. "name": "createSchemaOrg",
  266. "package": "schema-org",
  267. "description": "create the schema.org manager instance.",
  268. "category": "@SchemaOrg",
  269. "external": "https://vue-schema-org.netlify.app/api/core/create-schema-org.html"
  270. },
  271. {
  272. "name": "createSharedComposable",
  273. "package": "shared",
  274. "lastUpdated": 1639442454000,
  275. "docs": "https://vueuse.org/shared/createSharedComposable/",
  276. "category": "State",
  277. "description": "make a composable function usable with multiple Vue instances",
  278. "related": [
  279. "createGlobalState"
  280. ]
  281. },
  282. {
  283. "name": "createUnrefFn",
  284. "package": "core",
  285. "lastUpdated": 1651597361000,
  286. "docs": "https://vueuse.org/core/createUnrefFn/",
  287. "category": "Utilities",
  288. "description": "make a plain function accepting ref and raw values as arguments",
  289. "related": [
  290. "reactify"
  291. ]
  292. },
  293. {
  294. "name": "extendRef",
  295. "package": "shared",
  296. "lastUpdated": 1671470212000,
  297. "docs": "https://vueuse.org/shared/extendRef/",
  298. "category": "Reactivity",
  299. "description": "add extra attributes to Ref"
  300. },
  301. {
  302. "name": "from",
  303. "package": "rxjs",
  304. "lastUpdated": 1665003343000,
  305. "docs": "https://vueuse.org/rxjs/from/",
  306. "category": "@RxJS",
  307. "description": "/ fromEvent"
  308. },
  309. {
  310. "name": "get",
  311. "package": "shared",
  312. "lastUpdated": 1639442454000,
  313. "docs": "https://vueuse.org/shared/get/",
  314. "category": "Utilities",
  315. "description": "shorthand for accessing `ref.value`"
  316. },
  317. {
  318. "name": "isDefined",
  319. "package": "shared",
  320. "lastUpdated": 1639442454000,
  321. "docs": "https://vueuse.org/shared/isDefined/",
  322. "category": "Utilities",
  323. "description": "non-nullish checking type guard for Ref"
  324. },
  325. {
  326. "name": "logicAnd",
  327. "package": "math",
  328. "lastUpdated": 1657261466000,
  329. "docs": "https://vueuse.org/math/logicAnd/",
  330. "category": "@Math",
  331. "description": "`AND` condition for refs",
  332. "alias": [
  333. "and"
  334. ],
  335. "related": [
  336. "logicNot",
  337. "logicOr"
  338. ]
  339. },
  340. {
  341. "name": "logicNot",
  342. "package": "math",
  343. "lastUpdated": 1657261466000,
  344. "docs": "https://vueuse.org/math/logicNot/",
  345. "category": "@Math",
  346. "description": "`NOT` condition for ref",
  347. "alias": [
  348. "not"
  349. ],
  350. "related": [
  351. "logicAnd",
  352. "logicOr"
  353. ]
  354. },
  355. {
  356. "name": "logicOr",
  357. "package": "math",
  358. "lastUpdated": 1657261466000,
  359. "docs": "https://vueuse.org/math/logicOr/",
  360. "category": "@Math",
  361. "description": "`OR` conditions for refs",
  362. "alias": [
  363. "or"
  364. ],
  365. "related": [
  366. "logicAnd",
  367. "logicNot"
  368. ]
  369. },
  370. {
  371. "name": "makeDestructurable",
  372. "package": "shared",
  373. "lastUpdated": 1662388825000,
  374. "docs": "https://vueuse.org/shared/makeDestructurable/",
  375. "category": "Utilities",
  376. "description": "make isomorphic destructurable for object and array at the same time"
  377. },
  378. {
  379. "name": "onClickOutside",
  380. "package": "core",
  381. "lastUpdated": 1675466376000,
  382. "component": true,
  383. "directive": true,
  384. "docs": "https://vueuse.org/core/onClickOutside/",
  385. "category": "Sensors",
  386. "description": "listen for clicks outside of an element"
  387. },
  388. {
  389. "name": "onKeyStroke",
  390. "package": "core",
  391. "lastUpdated": 1672754414000,
  392. "directive": true,
  393. "docs": "https://vueuse.org/core/onKeyStroke/",
  394. "category": "Sensors",
  395. "description": "listen for keyboard key being stroked"
  396. },
  397. {
  398. "name": "onLongPress",
  399. "package": "core",
  400. "lastUpdated": 1661746302000,
  401. "component": true,
  402. "directive": true,
  403. "docs": "https://vueuse.org/core/onLongPress/",
  404. "category": "Sensors",
  405. "description": "listen for a long press on an element"
  406. },
  407. {
  408. "name": "onStartTyping",
  409. "package": "core",
  410. "lastUpdated": 1639442454000,
  411. "docs": "https://vueuse.org/core/onStartTyping/",
  412. "category": "Sensors",
  413. "description": "fires when users start typing on non-editable elements"
  414. },
  415. {
  416. "name": "reactify",
  417. "package": "shared",
  418. "lastUpdated": 1657634926000,
  419. "docs": "https://vueuse.org/shared/reactify/",
  420. "category": "Reactivity",
  421. "description": "converts plain functions into reactive functions",
  422. "alias": [
  423. "createReactiveFn"
  424. ],
  425. "related": [
  426. "createUnrefFn"
  427. ]
  428. },
  429. {
  430. "name": "reactifyObject",
  431. "package": "shared",
  432. "lastUpdated": 1667952962000,
  433. "docs": "https://vueuse.org/shared/reactifyObject/",
  434. "category": "Reactivity",
  435. "description": "apply `reactify` to an object"
  436. },
  437. {
  438. "name": "reactiveComputed",
  439. "package": "shared",
  440. "lastUpdated": 1645876129000,
  441. "docs": "https://vueuse.org/shared/reactiveComputed/",
  442. "category": "Reactivity",
  443. "description": "computed reactive object"
  444. },
  445. {
  446. "name": "reactiveOmit",
  447. "package": "shared",
  448. "lastUpdated": 1658645224000,
  449. "docs": "https://vueuse.org/shared/reactiveOmit/",
  450. "category": "Reactivity",
  451. "description": "reactively omit fields from a reactive object"
  452. },
  453. {
  454. "name": "reactivePick",
  455. "package": "shared",
  456. "lastUpdated": 1658645224000,
  457. "docs": "https://vueuse.org/shared/reactivePick/",
  458. "category": "Reactivity",
  459. "description": "reactively pick fields from a reactive object"
  460. },
  461. {
  462. "name": "refAutoReset",
  463. "package": "shared",
  464. "lastUpdated": 1660291797000,
  465. "docs": "https://vueuse.org/shared/refAutoReset/",
  466. "category": "Reactivity",
  467. "description": "a ref which will be reset to the default value after some time",
  468. "alias": [
  469. "autoResetRef"
  470. ]
  471. },
  472. {
  473. "name": "refDebounced",
  474. "package": "shared",
  475. "lastUpdated": 1666676013000,
  476. "docs": "https://vueuse.org/shared/refDebounced/",
  477. "category": "Reactivity",
  478. "description": "debounce execution of a ref value",
  479. "alias": [
  480. "useDebounce",
  481. "debouncedRef"
  482. ],
  483. "related": [
  484. "useThrottleFn"
  485. ]
  486. },
  487. {
  488. "name": "refDefault",
  489. "package": "shared",
  490. "lastUpdated": 1639442454000,
  491. "docs": "https://vueuse.org/shared/refDefault/",
  492. "category": "Reactivity",
  493. "description": "apply default value to a ref"
  494. },
  495. {
  496. "name": "refThrottled",
  497. "package": "shared",
  498. "lastUpdated": 1645956777000,
  499. "docs": "https://vueuse.org/shared/refThrottled/",
  500. "category": "Reactivity",
  501. "description": "throttle changing of a ref value",
  502. "alias": [
  503. "useThrottle",
  504. "throttledRef"
  505. ],
  506. "related": [
  507. "useThrottleFn"
  508. ]
  509. },
  510. {
  511. "name": "refWithControl",
  512. "package": "shared",
  513. "lastUpdated": 1662892188000,
  514. "docs": "https://vueuse.org/shared/refWithControl/",
  515. "category": "Reactivity",
  516. "description": "fine-grained controls over ref and its reactivity",
  517. "alias": [
  518. "controlledRef"
  519. ],
  520. "related": [
  521. "computedWithControl"
  522. ]
  523. },
  524. {
  525. "name": "resolveRef",
  526. "package": "shared",
  527. "lastUpdated": 1672752994000,
  528. "docs": "https://vueuse.org/shared/resolveRef/",
  529. "category": "Reactivity",
  530. "description": "normalize value/ref/getter to `ref` or `computed`",
  531. "related": [
  532. "resolveUnref"
  533. ]
  534. },
  535. {
  536. "name": "resolveUnref",
  537. "package": "shared",
  538. "lastUpdated": 1667054063000,
  539. "docs": "https://vueuse.org/shared/resolveUnref/",
  540. "category": "Reactivity",
  541. "description": "get the value of value/ref/getter",
  542. "related": [
  543. "resolveRef"
  544. ]
  545. },
  546. {
  547. "name": "set",
  548. "package": "shared",
  549. "lastUpdated": 1642756441000,
  550. "docs": "https://vueuse.org/shared/set/",
  551. "category": "Utilities",
  552. "description": "shorthand for `ref.value = x`"
  553. },
  554. {
  555. "name": "syncRef",
  556. "package": "shared",
  557. "lastUpdated": 1658655180000,
  558. "docs": "https://vueuse.org/shared/syncRef/",
  559. "category": "Reactivity",
  560. "description": "two-way refs synchronization",
  561. "related": [
  562. "syncRefs"
  563. ]
  564. },
  565. {
  566. "name": "syncRefs",
  567. "package": "shared",
  568. "lastUpdated": 1645952177000,
  569. "docs": "https://vueuse.org/shared/syncRefs/",
  570. "category": "Reactivity",
  571. "description": "keep target refs in sync with a source ref",
  572. "related": [
  573. "syncRef"
  574. ]
  575. },
  576. {
  577. "name": "templateRef",
  578. "package": "core",
  579. "lastUpdated": 1663295825000,
  580. "docs": "https://vueuse.org/core/templateRef/",
  581. "category": "Component",
  582. "description": "shorthand for binding ref to template element"
  583. },
  584. {
  585. "name": "toObserver",
  586. "package": "rxjs",
  587. "lastUpdated": 1631130736000,
  588. "docs": "https://vueuse.org/rxjs/toObserver/",
  589. "category": "@RxJS",
  590. "description": "sugar function to convert a `ref` into an RxJS [Observer](https://rxjs.dev/guide/observer)"
  591. },
  592. {
  593. "name": "toReactive",
  594. "package": "shared",
  595. "lastUpdated": 1645878866000,
  596. "docs": "https://vueuse.org/shared/toReactive/",
  597. "category": "Reactivity",
  598. "description": "converts ref to reactive"
  599. },
  600. {
  601. "name": "toRefs",
  602. "package": "shared",
  603. "lastUpdated": 1655284952000,
  604. "docs": "https://vueuse.org/shared/toRefs/",
  605. "category": "Reactivity",
  606. "description": "extended [`toRefs`](https://v3.vuejs.org/api/refs-api.html#torefs) that also accepts refs of an object"
  607. },
  608. {
  609. "name": "tryOnBeforeMount",
  610. "package": "shared",
  611. "lastUpdated": 1655284952000,
  612. "docs": "https://vueuse.org/shared/tryOnBeforeMount/",
  613. "category": "Component",
  614. "description": "safe `onBeforeMount`"
  615. },
  616. {
  617. "name": "tryOnBeforeUnmount",
  618. "package": "shared",
  619. "lastUpdated": 1639442454000,
  620. "docs": "https://vueuse.org/shared/tryOnBeforeUnmount/",
  621. "category": "Component",
  622. "description": "safe `onBeforeUnmount`"
  623. },
  624. {
  625. "name": "tryOnMounted",
  626. "package": "shared",
  627. "lastUpdated": 1640933217000,
  628. "docs": "https://vueuse.org/shared/tryOnMounted/",
  629. "category": "Component",
  630. "description": "safe `onMounted`"
  631. },
  632. {
  633. "name": "tryOnScopeDispose",
  634. "package": "shared",
  635. "lastUpdated": 1675070075000,
  636. "docs": "https://vueuse.org/shared/tryOnScopeDispose/",
  637. "category": "Component",
  638. "description": "safe `onScopeDispose`"
  639. },
  640. {
  641. "name": "tryOnUnmounted",
  642. "package": "shared",
  643. "lastUpdated": 1640933217000,
  644. "docs": "https://vueuse.org/shared/tryOnUnmounted/",
  645. "category": "Component",
  646. "description": "safe `onUnmounted`"
  647. },
  648. {
  649. "name": "unrefElement",
  650. "package": "core",
  651. "lastUpdated": 1657259100000,
  652. "docs": "https://vueuse.org/core/unrefElement/",
  653. "category": "Component",
  654. "description": "unref for dom element"
  655. },
  656. {
  657. "name": "until",
  658. "package": "shared",
  659. "lastUpdated": 1664157004000,
  660. "docs": "https://vueuse.org/shared/until/",
  661. "category": "Watch",
  662. "description": "promised one-time watch for changes"
  663. },
  664. {
  665. "name": "useAbs",
  666. "package": "math",
  667. "lastUpdated": 1658041562000,
  668. "docs": "https://vueuse.org/math/useAbs/",
  669. "category": "@Math",
  670. "description": "reactive `Math.abs`"
  671. },
  672. {
  673. "name": "useActiveElement",
  674. "package": "core",
  675. "lastUpdated": 1672753027000,
  676. "component": true,
  677. "docs": "https://vueuse.org/core/useActiveElement/",
  678. "category": "Elements",
  679. "description": "reactive `document.activeElement`"
  680. },
  681. {
  682. "name": "useArrayEvery",
  683. "package": "shared",
  684. "lastUpdated": 1660291797000,
  685. "docs": "https://vueuse.org/shared/useArrayEvery/",
  686. "category": "Array",
  687. "description": "reactive `Array.every`"
  688. },
  689. {
  690. "name": "useArrayFilter",
  691. "package": "shared",
  692. "lastUpdated": 1660291797000,
  693. "docs": "https://vueuse.org/shared/useArrayFilter/",
  694. "category": "Array",
  695. "description": "reactive `Array.filter`"
  696. },
  697. {
  698. "name": "useArrayFind",
  699. "package": "shared",
  700. "lastUpdated": 1660291797000,
  701. "docs": "https://vueuse.org/shared/useArrayFind/",
  702. "category": "Array",
  703. "description": "reactive `Array.find`"
  704. },
  705. {
  706. "name": "useArrayFindIndex",
  707. "package": "shared",
  708. "lastUpdated": 1660291797000,
  709. "docs": "https://vueuse.org/shared/useArrayFindIndex/",
  710. "category": "Array",
  711. "description": "reactive `Array.findIndex`"
  712. },
  713. {
  714. "name": "useArrayFindLast",
  715. "package": "shared",
  716. "lastUpdated": 1676713178000,
  717. "docs": "https://vueuse.org/shared/useArrayFindLast/",
  718. "category": "Array",
  719. "description": "reactive `Array.findLast`"
  720. },
  721. {
  722. "name": "useArrayJoin",
  723. "package": "shared",
  724. "lastUpdated": 1660291797000,
  725. "docs": "https://vueuse.org/shared/useArrayJoin/",
  726. "category": "Array",
  727. "description": "reactive `Array.join`"
  728. },
  729. {
  730. "name": "useArrayMap",
  731. "package": "shared",
  732. "lastUpdated": 1662376596000,
  733. "docs": "https://vueuse.org/shared/useArrayMap/",
  734. "category": "Array",
  735. "description": "reactive `Array.map`"
  736. },
  737. {
  738. "name": "useArrayReduce",
  739. "package": "shared",
  740. "lastUpdated": 1660291797000,
  741. "docs": "https://vueuse.org/shared/useArrayReduce/",
  742. "category": "Array",
  743. "description": "reactive `Array.reduce`"
  744. },
  745. {
  746. "name": "useArraySome",
  747. "package": "shared",
  748. "lastUpdated": 1660291797000,
  749. "docs": "https://vueuse.org/shared/useArraySome/",
  750. "category": "Array",
  751. "description": "reactive `Array.some`"
  752. },
  753. {
  754. "name": "useArrayUnique",
  755. "package": "shared",
  756. "lastUpdated": 1672753114000,
  757. "docs": "https://vueuse.org/shared/useArrayUnique/",
  758. "category": "Array",
  759. "description": "reactive unique array"
  760. },
  761. {
  762. "name": "useAsyncQueue",
  763. "package": "core",
  764. "lastUpdated": 1639818708000,
  765. "docs": "https://vueuse.org/core/useAsyncQueue/",
  766. "category": "Utilities",
  767. "description": "executes each asynchronous task sequentially and passes the current task result to the next task"
  768. },
  769. {
  770. "name": "useAsyncState",
  771. "package": "core",
  772. "lastUpdated": 1676388144000,
  773. "docs": "https://vueuse.org/core/useAsyncState/",
  774. "category": "State",
  775. "description": "reactive async state"
  776. },
  777. {
  778. "name": "useAsyncValidator",
  779. "package": "integrations",
  780. "lastUpdated": 1676570052000,
  781. "component": true,
  782. "docs": "https://vueuse.org/integrations/useAsyncValidator/",
  783. "category": "@Integrations",
  784. "description": "wrapper for [`async-validator`](https://github.com/yiminghe/async-validator)",
  785. "importPath": "integrations/useAsyncValidator"
  786. },
  787. {
  788. "name": "useAuth",
  789. "package": "firebase",
  790. "lastUpdated": 1658645224000,
  791. "docs": "https://vueuse.org/firebase/useAuth/",
  792. "category": "@Firebase",
  793. "description": "reactive [Firebase Auth](https://firebase.google.com/docs/auth) binding",
  794. "importPath": "firebase/useAuth"
  795. },
  796. {
  797. "name": "useAverage",
  798. "package": "math",
  799. "lastUpdated": 1658041190000,
  800. "docs": "https://vueuse.org/math/useAverage/",
  801. "category": "@Math",
  802. "description": "get the average of an array reactively"
  803. },
  804. {
  805. "name": "useAxios",
  806. "package": "integrations",
  807. "lastUpdated": 1676590260000,
  808. "docs": "https://vueuse.org/integrations/useAxios/",
  809. "category": "@Integrations",
  810. "description": "wrapper for [`axios`](https://github.com/axios/axios)",
  811. "importPath": "integrations/useAxios"
  812. },
  813. {
  814. "name": "useBase64",
  815. "package": "core",
  816. "lastUpdated": 1657259100000,
  817. "docs": "https://vueuse.org/core/useBase64/",
  818. "category": "Utilities",
  819. "description": "reactive base64 transforming"
  820. },
  821. {
  822. "name": "useBattery",
  823. "package": "core",
  824. "lastUpdated": 1657430593000,
  825. "component": true,
  826. "docs": "https://vueuse.org/core/useBattery/",
  827. "category": "Sensors",
  828. "description": "reactive [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery_Status_API)"
  829. },
  830. {
  831. "name": "useBluetooth",
  832. "package": "core",
  833. "lastUpdated": 1665965343000,
  834. "docs": "https://vueuse.org/core/useBluetooth/",
  835. "category": "Browser",
  836. "description": "reactive [Web Bluetooth API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Bluetooth_API)"
  837. },
  838. {
  839. "name": "useBreakpoints",
  840. "package": "core",
  841. "lastUpdated": 1662285732000,
  842. "docs": "https://vueuse.org/core/useBreakpoints/",
  843. "category": "Browser",
  844. "description": "reactive viewport breakpoints"
  845. },
  846. {
  847. "name": "useBroadcastChannel",
  848. "package": "core",
  849. "lastUpdated": 1658083596000,
  850. "docs": "https://vueuse.org/core/useBroadcastChannel/",
  851. "category": "Browser",
  852. "description": "reactive [BroadcastChannel API](https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel)"
  853. },
  854. {
  855. "name": "useBrowserLocation",
  856. "package": "core",
  857. "lastUpdated": 1639442454000,
  858. "component": true,
  859. "docs": "https://vueuse.org/core/useBrowserLocation/",
  860. "category": "Browser",
  861. "description": "reactive browser location"
  862. },
  863. {
  864. "name": "useCached",
  865. "package": "core",
  866. "lastUpdated": 1644284136000,
  867. "docs": "https://vueuse.org/core/useCached/",
  868. "category": "Utilities",
  869. "description": "cache a ref with a custom comparator"
  870. },
  871. {
  872. "name": "useCeil",
  873. "package": "math",
  874. "lastUpdated": 1657638060000,
  875. "docs": "https://vueuse.org/math/useCeil/",
  876. "category": "@Math",
  877. "description": "reactive `Math.ceil`"
  878. },
  879. {
  880. "name": "useChangeCase",
  881. "package": "integrations",
  882. "lastUpdated": 1657259100000,
  883. "docs": "https://vueuse.org/integrations/useChangeCase/",
  884. "category": "@Integrations",
  885. "description": "reactive wrapper for [`change-case`](https://github.com/blakeembrey/change-case)",
  886. "importPath": "integrations/useChangeCase"
  887. },
  888. {
  889. "name": "useClamp",
  890. "package": "math",
  891. "lastUpdated": 1676714120000,
  892. "docs": "https://vueuse.org/math/useClamp/",
  893. "category": "@Math",
  894. "description": "reactively clamp a value between two other values"
  895. },
  896. {
  897. "name": "useClipboard",
  898. "package": "core",
  899. "lastUpdated": 1666676330000,
  900. "docs": "https://vueuse.org/core/useClipboard/",
  901. "category": "Browser",
  902. "description": "reactive [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API)"
  903. },
  904. {
  905. "name": "useCloned",
  906. "package": "core",
  907. "lastUpdated": 1662386652000,
  908. "docs": "https://vueuse.org/core/useCloned/",
  909. "category": "Utilities",
  910. "description": "reactive clone of a ref"
  911. },
  912. {
  913. "name": "useColorMode",
  914. "package": "core",
  915. "lastUpdated": 1674955241000,
  916. "component": true,
  917. "docs": "https://vueuse.org/core/useColorMode/",
  918. "category": "Browser",
  919. "description": "reactive color mode (dark / light / customs) with auto data persistence",
  920. "related": [
  921. "useDark",
  922. "usePreferredDark",
  923. "useStorage"
  924. ]
  925. },
  926. {
  927. "name": "useConfirmDialog",
  928. "package": "core",
  929. "lastUpdated": 1642756441000,
  930. "docs": "https://vueuse.org/core/useConfirmDialog/",
  931. "category": "Utilities",
  932. "description": "creates event hooks to support modals and confirmation dialog chains"
  933. },
  934. {
  935. "name": "useCookies",
  936. "package": "integrations",
  937. "lastUpdated": 1642756753000,
  938. "docs": "https://vueuse.org/integrations/useCookies/",
  939. "category": "@Integrations",
  940. "description": "wrapper for [`universal-cookie`](https://www.npmjs.com/package/universal-cookie)",
  941. "importPath": "integrations/useCookies"
  942. },
  943. {
  944. "name": "useCounter",
  945. "package": "shared",
  946. "lastUpdated": 1666677599000,
  947. "docs": "https://vueuse.org/shared/useCounter/",
  948. "category": "Utilities",
  949. "description": "basic counter with utility functions"
  950. },
  951. {
  952. "name": "useCssVar",
  953. "package": "core",
  954. "lastUpdated": 1657259100000,
  955. "docs": "https://vueuse.org/core/useCssVar/",
  956. "category": "Browser",
  957. "description": "manipulate CSS variables"
  958. },
  959. {
  960. "name": "useCurrentElement",
  961. "package": "core",
  962. "lastUpdated": 1661239180000,
  963. "docs": "https://vueuse.org/core/useCurrentElement/",
  964. "category": "Component",
  965. "description": "get the DOM element of current component as a ref"
  966. },
  967. {
  968. "name": "useCycleList",
  969. "package": "core",
  970. "lastUpdated": 1659556886000,
  971. "docs": "https://vueuse.org/core/useCycleList/",
  972. "category": "Utilities",
  973. "description": "cycle through a list of items"
  974. },
  975. {
  976. "name": "useDark",
  977. "package": "core",
  978. "lastUpdated": 1662892188000,
  979. "component": true,
  980. "docs": "https://vueuse.org/core/useDark/",
  981. "category": "Browser",
  982. "description": "reactive dark mode with auto data persistence",
  983. "related": [
  984. "useColorMode",
  985. "usePreferredDark",
  986. "useStorage"
  987. ]
  988. },
  989. {
  990. "name": "useDateFormat",
  991. "package": "shared",
  992. "lastUpdated": 1664216752000,
  993. "docs": "https://vueuse.org/shared/useDateFormat/",
  994. "category": "Time",
  995. "description": "get the formatted date according to the string of tokens passed in"
  996. },
  997. {
  998. "name": "useDebouncedRefHistory",
  999. "package": "core",
  1000. "lastUpdated": 1657259100000,
  1001. "docs": "https://vueuse.org/core/useDebouncedRefHistory/",
  1002. "category": "State",
  1003. "description": "shorthand for `useRefHistory` with debounced filter",
  1004. "related": [
  1005. "useRefHistory",
  1006. "useThrottledRefHistory"
  1007. ]
  1008. },
  1009. {
  1010. "name": "useDebounceFn",
  1011. "package": "shared",
  1012. "lastUpdated": 1672753228000,
  1013. "docs": "https://vueuse.org/shared/useDebounceFn/",
  1014. "category": "Utilities",
  1015. "description": "debounce execution of a function",
  1016. "related": [
  1017. "useThrottleFn"
  1018. ]
  1019. },
  1020. {
  1021. "name": "useDeviceMotion",
  1022. "package": "core",
  1023. "lastUpdated": 1639442454000,
  1024. "component": true,
  1025. "docs": "https://vueuse.org/core/useDeviceMotion/",
  1026. "category": "Sensors",
  1027. "description": "reactive [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent)"
  1028. },
  1029. {
  1030. "name": "useDeviceOrientation",
  1031. "package": "core",
  1032. "lastUpdated": 1657430593000,
  1033. "component": true,
  1034. "docs": "https://vueuse.org/core/useDeviceOrientation/",
  1035. "category": "Sensors",
  1036. "description": "reactive [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent)"
  1037. },
  1038. {
  1039. "name": "useDevicePixelRatio",
  1040. "package": "core",
  1041. "lastUpdated": 1676712461000,
  1042. "component": true,
  1043. "docs": "https://vueuse.org/core/useDevicePixelRatio/",
  1044. "category": "Sensors",
  1045. "description": "reactively track [`window.devicePixelRatio`](https://developer.mozilla.org/ru/docs/Web/API/Window/devicePixelRatio)"
  1046. },
  1047. {
  1048. "name": "useDevicesList",
  1049. "package": "core",
  1050. "lastUpdated": 1662892188000,
  1051. "component": true,
  1052. "docs": "https://vueuse.org/core/useDevicesList/",
  1053. "category": "Sensors",
  1054. "description": "reactive [enumerateDevices](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/enumerateDevices) listing available input/output devices",
  1055. "related": [
  1056. "useUserMedia"
  1057. ]
  1058. },
  1059. {
  1060. "name": "useDisplayMedia",
  1061. "package": "core",
  1062. "lastUpdated": 1672752994000,
  1063. "docs": "https://vueuse.org/core/useDisplayMedia/",
  1064. "category": "Sensors",
  1065. "description": "reactive [`mediaDevices.getDisplayMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia) streaming",
  1066. "related": [
  1067. "useUserMedia"
  1068. ]
  1069. },
  1070. {
  1071. "name": "useDocumentVisibility",
  1072. "package": "core",
  1073. "lastUpdated": 1658083596000,
  1074. "component": true,
  1075. "docs": "https://vueuse.org/core/useDocumentVisibility/",
  1076. "category": "Elements",
  1077. "description": "reactively track [`document.visibilityState`](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState)"
  1078. },
  1079. {
  1080. "name": "useDraggable",
  1081. "package": "core",
  1082. "lastUpdated": 1671204368000,
  1083. "component": true,
  1084. "docs": "https://vueuse.org/core/useDraggable/",
  1085. "category": "Elements",
  1086. "description": "make elements draggable"
  1087. },
  1088. {
  1089. "name": "useDrauu",
  1090. "package": "integrations",
  1091. "lastUpdated": 1657259100000,
  1092. "docs": "https://vueuse.org/integrations/useDrauu/",
  1093. "category": "@Integrations",
  1094. "description": "reactive instance for [drauu](https://github.com/antfu/drauu)",
  1095. "importPath": "integrations/useDrauu"
  1096. },
  1097. {
  1098. "name": "useDropZone",
  1099. "package": "core",
  1100. "lastUpdated": 1658043158000,
  1101. "docs": "https://vueuse.org/core/useDropZone/",
  1102. "category": "Elements",
  1103. "description": "create a zone where files can be dropped"
  1104. },
  1105. {
  1106. "name": "useElementBounding",
  1107. "package": "core",
  1108. "lastUpdated": 1672422913000,
  1109. "component": true,
  1110. "docs": "https://vueuse.org/core/useElementBounding/",
  1111. "category": "Elements",
  1112. "description": "reactive [bounding box](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect) of an HTML element"
  1113. },
  1114. {
  1115. "name": "useElementByPoint",
  1116. "package": "core",
  1117. "lastUpdated": 1672852514000,
  1118. "docs": "https://vueuse.org/core/useElementByPoint/",
  1119. "category": "Sensors",
  1120. "description": "reactive element by point"
  1121. },
  1122. {
  1123. "name": "useElementHover",
  1124. "package": "core",
  1125. "lastUpdated": 1676712131000,
  1126. "directive": true,
  1127. "docs": "https://vueuse.org/core/useElementHover/",
  1128. "category": "Sensors",
  1129. "description": "reactive element's hover state"
  1130. },
  1131. {
  1132. "name": "useElementSize",
  1133. "package": "core",
  1134. "lastUpdated": 1674954789000,
  1135. "component": true,
  1136. "directive": true,
  1137. "docs": "https://vueuse.org/core/useElementSize/",
  1138. "category": "Elements",
  1139. "description": "reactive size of an HTML element"
  1140. },
  1141. {
  1142. "package": "motion",
  1143. "category": "@Motion",
  1144. "name": "useElementStyle",
  1145. "description": "sync a reactive object to a target element CSS styling",
  1146. "external": "https://motion.vueuse.org/api/use-element-style.html"
  1147. },
  1148. {
  1149. "package": "motion",
  1150. "category": "@Motion",
  1151. "name": "useElementTransform",
  1152. "description": "sync a reactive object to a target element CSS transform.",
  1153. "external": "https://motion.vueuse.org/api/use-element-transform.html"
  1154. },
  1155. {
  1156. "name": "useElementVisibility",
  1157. "package": "core",
  1158. "lastUpdated": 1662384256000,
  1159. "component": true,
  1160. "directive": true,
  1161. "docs": "https://vueuse.org/core/useElementVisibility/",
  1162. "category": "Elements",
  1163. "description": "tracks the visibility of an element within the viewport"
  1164. },
  1165. {
  1166. "name": "useEventBus",
  1167. "package": "core",
  1168. "lastUpdated": 1676389922000,
  1169. "docs": "https://vueuse.org/core/useEventBus/",
  1170. "category": "Utilities",
  1171. "description": "a basic event bus"
  1172. },
  1173. {
  1174. "name": "useEventListener",
  1175. "package": "core",
  1176. "lastUpdated": 1676715818000,
  1177. "docs": "https://vueuse.org/core/useEventListener/",
  1178. "category": "Browser",
  1179. "description": "use EventListener with ease"
  1180. },
  1181. {
  1182. "name": "useEventSource",
  1183. "package": "core",
  1184. "lastUpdated": 1657634387000,
  1185. "docs": "https://vueuse.org/core/useEventSource/",
  1186. "category": "Network",
  1187. "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"
  1188. },
  1189. {
  1190. "name": "useEyeDropper",
  1191. "package": "core",
  1192. "lastUpdated": 1658083596000,
  1193. "component": true,
  1194. "docs": "https://vueuse.org/core/useEyeDropper/",
  1195. "category": "Browser",
  1196. "description": "reactive [EyeDropper API](https://developer.mozilla.org/en-US/docs/Web/API/EyeDropper_API)"
  1197. },
  1198. {
  1199. "name": "useFavicon",
  1200. "package": "core",
  1201. "lastUpdated": 1661409315000,
  1202. "docs": "https://vueuse.org/core/useFavicon/",
  1203. "category": "Browser",
  1204. "description": "reactive favicon"
  1205. },
  1206. {
  1207. "name": "useFetch",
  1208. "package": "core",
  1209. "lastUpdated": 1676093591000,
  1210. "docs": "https://vueuse.org/core/useFetch/",
  1211. "category": "Network",
  1212. "description": "reactive [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) provides the ability to abort requests"
  1213. },
  1214. {
  1215. "name": "useFileDialog",
  1216. "package": "core",
  1217. "lastUpdated": 1662385329000,
  1218. "docs": "https://vueuse.org/core/useFileDialog/",
  1219. "category": "Browser",
  1220. "description": "open file dialog with ease"
  1221. },
  1222. {
  1223. "name": "useFileSystemAccess",
  1224. "package": "core",
  1225. "lastUpdated": 1657430593000,
  1226. "docs": "https://vueuse.org/core/useFileSystemAccess/",
  1227. "category": "Browser",
  1228. "description": "create and read and write local files with [FileSystemAccessAPI](https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API)"
  1229. },
  1230. {
  1231. "name": "useFirestore",
  1232. "package": "firebase",
  1233. "lastUpdated": 1668298845000,
  1234. "docs": "https://vueuse.org/firebase/useFirestore/",
  1235. "category": "@Firebase",
  1236. "description": "reactive [Firestore](https://firebase.google.com/docs/firestore) binding",
  1237. "importPath": "firebase/useFirestore"
  1238. },
  1239. {
  1240. "name": "useFloor",
  1241. "package": "math",
  1242. "lastUpdated": 1657638060000,
  1243. "docs": "https://vueuse.org/math/useFloor/",
  1244. "category": "@Math",
  1245. "description": "reactive `Math.floor`"
  1246. },
  1247. {
  1248. "name": "useFocus",
  1249. "package": "core",
  1250. "lastUpdated": 1674992405000,
  1251. "docs": "https://vueuse.org/core/useFocus/",
  1252. "category": "Sensors",
  1253. "description": "reactive utility to track or set the focus state of a DOM element"
  1254. },
  1255. {
  1256. "name": "useFocusTrap",
  1257. "package": "integrations",
  1258. "lastUpdated": 1639818708000,
  1259. "component": true,
  1260. "docs": "https://vueuse.org/integrations/useFocusTrap/",
  1261. "category": "@Integrations",
  1262. "description": "reactive wrapper for [`focus-trap`](https://github.com/focus-trap/focus-trap)",
  1263. "importPath": "integrations/useFocusTrap"
  1264. },
  1265. {
  1266. "name": "useFocusWithin",
  1267. "package": "core",
  1268. "lastUpdated": 1674955241000,
  1269. "docs": "https://vueuse.org/core/useFocusWithin/",
  1270. "category": "Sensors",
  1271. "description": "reactive utility to track if an element or one of its decendants has focus"
  1272. },
  1273. {
  1274. "name": "useFps",
  1275. "package": "core",
  1276. "lastUpdated": 1644734082000,
  1277. "docs": "https://vueuse.org/core/useFps/",
  1278. "category": "Sensors",
  1279. "description": "reactive FPS (frames per second)"
  1280. },
  1281. {
  1282. "name": "useFullscreen",
  1283. "package": "core",
  1284. "lastUpdated": 1657430593000,
  1285. "component": true,
  1286. "docs": "https://vueuse.org/core/useFullscreen/",
  1287. "category": "Browser",
  1288. "description": "reactive [Fullscreen API](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API)"
  1289. },
  1290. {
  1291. "name": "useFuse",
  1292. "package": "integrations",
  1293. "lastUpdated": 1657259100000,
  1294. "docs": "https://vueuse.org/integrations/useFuse/",
  1295. "category": "@Integrations",
  1296. "description": "easily implement fuzzy search using a composable with [Fuse.js](https://github.com/krisk/fuse)",
  1297. "importPath": "integrations/useFuse"
  1298. },
  1299. {
  1300. "name": "useGamepad",
  1301. "package": "core",
  1302. "lastUpdated": 1658083596000,
  1303. "docs": "https://vueuse.org/core/useGamepad/",
  1304. "category": "Browser",
  1305. "description": "provides reactive bindings for the [Gamepad API](https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API)"
  1306. },
  1307. {
  1308. "name": "useGeolocation",
  1309. "package": "core",
  1310. "lastUpdated": 1671204138000,
  1311. "component": true,
  1312. "docs": "https://vueuse.org/core/useGeolocation/",
  1313. "category": "Sensors",
  1314. "description": "reactive [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API)"
  1315. },
  1316. {
  1317. "name": "useHead",
  1318. "package": "head",
  1319. "description": "update head meta tags reactively.",
  1320. "category": "@Head",
  1321. "external": "https://github.com/vueuse/head#api"
  1322. },
  1323. {
  1324. "name": "useIDBKeyval",
  1325. "package": "integrations",
  1326. "lastUpdated": 1668302379000,
  1327. "docs": "https://vueuse.org/integrations/useIDBKeyval/",
  1328. "category": "@Integrations",
  1329. "description": "wrapper for [`idb-keyval`](https://www.npmjs.com/package/idb-keyval)",
  1330. "importPath": "integrations/useIDBKeyval"
  1331. },
  1332. {
  1333. "name": "useIdle",
  1334. "package": "core",
  1335. "lastUpdated": 1657638023000,
  1336. "component": true,
  1337. "docs": "https://vueuse.org/core/useIdle/",
  1338. "category": "Sensors",
  1339. "description": "tracks whether the user is being inactive"
  1340. },
  1341. {
  1342. "name": "useImage",
  1343. "package": "core",
  1344. "lastUpdated": 1658083596000,
  1345. "component": true,
  1346. "docs": "https://vueuse.org/core/useImage/",
  1347. "category": "Browser",
  1348. "description": "reactive load an image in the browser"
  1349. },
  1350. {
  1351. "name": "useInfiniteScroll",
  1352. "package": "core",
  1353. "lastUpdated": 1658043158000,
  1354. "directive": true,
  1355. "docs": "https://vueuse.org/core/useInfiniteScroll/",
  1356. "category": "Sensors",
  1357. "description": "infinite scrolling of the element"
  1358. },
  1359. {
  1360. "name": "useIntersectionObserver",
  1361. "package": "core",
  1362. "lastUpdated": 1657637968000,
  1363. "directive": true,
  1364. "docs": "https://vueuse.org/core/useIntersectionObserver/",
  1365. "category": "Elements",
  1366. "description": "detects that a target element's visibility"
  1367. },
  1368. {
  1369. "name": "useInterval",
  1370. "package": "shared",
  1371. "lastUpdated": 1676713336000,
  1372. "docs": "https://vueuse.org/shared/useInterval/",
  1373. "category": "Animation",
  1374. "description": "reactive counter increases on every interval"
  1375. },
  1376. {
  1377. "name": "useIntervalFn",
  1378. "package": "shared",
  1379. "lastUpdated": 1674954620000,
  1380. "docs": "https://vueuse.org/shared/useIntervalFn/",
  1381. "category": "Animation",
  1382. "description": "wrapper for `setInterval` with controls"
  1383. },
  1384. {
  1385. "name": "useIpcRenderer",
  1386. "package": "electron",
  1387. "lastUpdated": 1658645224000,
  1388. "docs": "https://vueuse.org/electron/useIpcRenderer/",
  1389. "category": "@Electron",
  1390. "description": "provides [ipcRenderer](https://www.electronjs.org/docs/api/ipc-renderer) and all of its APIs"
  1391. },
  1392. {
  1393. "name": "useIpcRendererInvoke",
  1394. "package": "electron",
  1395. "lastUpdated": 1658645224000,
  1396. "docs": "https://vueuse.org/electron/useIpcRendererInvoke/",
  1397. "category": "@Electron",
  1398. "description": "reactive [ipcRenderer.invoke API](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args) result"
  1399. },
  1400. {
  1401. "name": "useIpcRendererOn",
  1402. "package": "electron",
  1403. "lastUpdated": 1658645224000,
  1404. "docs": "https://vueuse.org/electron/useIpcRendererOn/",
  1405. "category": "@Electron",
  1406. "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"
  1407. },
  1408. {
  1409. "name": "useJwt",
  1410. "package": "integrations",
  1411. "lastUpdated": 1657730911000,
  1412. "docs": "https://vueuse.org/integrations/useJwt/",
  1413. "category": "@Integrations",
  1414. "description": "wrapper for [`jwt-decode`](https://github.com/auth0/jwt-decode)",
  1415. "importPath": "integrations/useJwt"
  1416. },
  1417. {
  1418. "name": "useKeyModifier",
  1419. "package": "core",
  1420. "lastUpdated": 1657638042000,
  1421. "docs": "https://vueuse.org/core/useKeyModifier/",
  1422. "category": "Sensors",
  1423. "description": "reactive [Modifier State](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/getModifierState)"
  1424. },
  1425. {
  1426. "name": "useLastChanged",
  1427. "package": "shared",
  1428. "lastUpdated": 1642756441000,
  1429. "docs": "https://vueuse.org/shared/useLastChanged/",
  1430. "category": "State",
  1431. "description": "records the timestamp of the last change"
  1432. },
  1433. {
  1434. "name": "useLocalStorage",
  1435. "package": "core",
  1436. "lastUpdated": 1657634978000,
  1437. "docs": "https://vueuse.org/core/useLocalStorage/",
  1438. "category": "State",
  1439. "description": "reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)",
  1440. "related": [
  1441. "useStorage"
  1442. ]
  1443. },
  1444. {
  1445. "name": "useMagicKeys",
  1446. "package": "core",
  1447. "lastUpdated": 1672752994000,
  1448. "docs": "https://vueuse.org/core/useMagicKeys/",
  1449. "category": "Sensors",
  1450. "description": "reactive keys pressed state"
  1451. },
  1452. {
  1453. "name": "useManualRefHistory",
  1454. "package": "core",
  1455. "lastUpdated": 1662386652000,
  1456. "docs": "https://vueuse.org/core/useManualRefHistory/",
  1457. "category": "State",
  1458. "description": "manually track the change history of a ref when the using calls `commit()`",
  1459. "related": [
  1460. "useRefHistory"
  1461. ]
  1462. },
  1463. {
  1464. "name": "useMath",
  1465. "package": "math",
  1466. "lastUpdated": 1658042869000,
  1467. "docs": "https://vueuse.org/math/useMath/",
  1468. "category": "@Math",
  1469. "description": "reactive `Math` methods"
  1470. },
  1471. {
  1472. "name": "useMax",
  1473. "package": "math",
  1474. "lastUpdated": 1658041190000,
  1475. "docs": "https://vueuse.org/math/useMax/",
  1476. "category": "@Math",
  1477. "description": "reactive `Math.max`"
  1478. },
  1479. {
  1480. "name": "useMediaControls",
  1481. "package": "core",
  1482. "lastUpdated": 1674853020000,
  1483. "docs": "https://vueuse.org/core/useMediaControls/",
  1484. "category": "Browser",
  1485. "description": "reactive media controls for both `audio` and `video` elements"
  1486. },
  1487. {
  1488. "name": "useMediaQuery",
  1489. "package": "core",
  1490. "lastUpdated": 1662574748000,
  1491. "docs": "https://vueuse.org/core/useMediaQuery/",
  1492. "category": "Browser",
  1493. "description": "reactive [Media Query](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Testing_media_queries)"
  1494. },
  1495. {
  1496. "name": "useMemoize",
  1497. "package": "core",
  1498. "lastUpdated": 1667952962000,
  1499. "docs": "https://vueuse.org/core/useMemoize/",
  1500. "category": "Utilities",
  1501. "description": "cache results of functions depending on arguments and keep it reactive"
  1502. },
  1503. {
  1504. "name": "useMemory",
  1505. "package": "core",
  1506. "lastUpdated": 1658083607000,
  1507. "docs": "https://vueuse.org/core/useMemory/",
  1508. "category": "Browser",
  1509. "description": "reactive Memory Info"
  1510. },
  1511. {
  1512. "name": "useMin",
  1513. "package": "math",
  1514. "lastUpdated": 1658041610000,
  1515. "docs": "https://vueuse.org/math/useMin/",
  1516. "category": "@Math",
  1517. "description": "reactive `Math.min`"
  1518. },
  1519. {
  1520. "package": "motion",
  1521. "category": "@Motion",
  1522. "name": "useMotion",
  1523. "description": "putting your components in motion.",
  1524. "external": "https://motion.vueuse.org/api/use-motion.html"
  1525. },
  1526. {
  1527. "package": "motion",
  1528. "category": "@Motion",
  1529. "name": "useMotionProperties",
  1530. "description": "access Motion Properties for a target element.",
  1531. "external": "https://motion.vueuse.org/api/use-motion-properties.html"
  1532. },
  1533. {
  1534. "package": "motion",
  1535. "category": "@Motion",
  1536. "name": "useMotionVariants",
  1537. "description": "handle the Variants state and selection.",
  1538. "external": "https://motion.vueuse.org/api/use-motion-variants.html"
  1539. },
  1540. {
  1541. "name": "useMounted",
  1542. "package": "core",
  1543. "lastUpdated": 1640933217000,
  1544. "docs": "https://vueuse.org/core/useMounted/",
  1545. "category": "Component",
  1546. "description": "mounted state in ref"
  1547. },
  1548. {
  1549. "name": "useMouse",
  1550. "package": "core",
  1551. "lastUpdated": 1672753737000,
  1552. "component": true,
  1553. "docs": "https://vueuse.org/core/useMouse/",
  1554. "category": "Sensors",
  1555. "description": "reactive mouse position"
  1556. },
  1557. {
  1558. "name": "useMouseInElement",
  1559. "package": "core",
  1560. "lastUpdated": 1674954670000,
  1561. "component": true,
  1562. "docs": "https://vueuse.org/core/useMouseInElement/",
  1563. "category": "Elements",
  1564. "description": "reactive mouse position related to an element"
  1565. },
  1566. {
  1567. "name": "useMousePressed",
  1568. "package": "core",
  1569. "lastUpdated": 1639818708000,
  1570. "component": true,
  1571. "docs": "https://vueuse.org/core/useMousePressed/",
  1572. "category": "Sensors",
  1573. "description": "reactive mouse pressing state"
  1574. },
  1575. {
  1576. "name": "useMutationObserver",
  1577. "package": "core",
  1578. "lastUpdated": 1657718877000,
  1579. "docs": "https://vueuse.org/core/useMutationObserver/",
  1580. "category": "Elements",
  1581. "description": "watch for changes being made to the DOM tree"
  1582. },
  1583. {
  1584. "name": "useNavigatorLanguage",
  1585. "package": "core",
  1586. "lastUpdated": 1662892188000,
  1587. "docs": "https://vueuse.org/core/useNavigatorLanguage/",
  1588. "category": "Sensors",
  1589. "description": "reactive [navigator.language](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language)"
  1590. },
  1591. {
  1592. "name": "useNetwork",
  1593. "package": "core",
  1594. "lastUpdated": 1658083596000,
  1595. "component": true,
  1596. "docs": "https://vueuse.org/core/useNetwork/",
  1597. "category": "Sensors",
  1598. "description": "reactive [Network status](https://developer.mozilla.org/en-US/docs/Web/API/Network_Information_API)"
  1599. },
  1600. {
  1601. "name": "useNow",
  1602. "package": "core",
  1603. "lastUpdated": 1639442454000,
  1604. "component": true,
  1605. "docs": "https://vueuse.org/core/useNow/",
  1606. "category": "Animation",
  1607. "description": "reactive current Date instance"
  1608. },
  1609. {
  1610. "name": "useNProgress",
  1611. "package": "integrations",
  1612. "lastUpdated": 1658758826000,
  1613. "docs": "https://vueuse.org/integrations/useNProgress/",
  1614. "category": "@Integrations",
  1615. "description": "reactive wrapper for [`nprogress`](https://github.com/rstacruz/nprogress)",
  1616. "importPath": "integrations/useNProgress"
  1617. },
  1618. {
  1619. "name": "useObjectUrl",
  1620. "package": "core",
  1621. "lastUpdated": 1657132677000,
  1622. "component": true,
  1623. "docs": "https://vueuse.org/core/useObjectUrl/",
  1624. "category": "Browser",
  1625. "description": "reactive URL representing an object"
  1626. },
  1627. {
  1628. "name": "useObservable",
  1629. "package": "rxjs",
  1630. "lastUpdated": 1651595539000,
  1631. "docs": "https://vueuse.org/rxjs/useObservable/",
  1632. "category": "@RxJS",
  1633. "description": "use an RxJS [`Observable`](https://rxjs.dev/guide/observable)"
  1634. },
  1635. {
  1636. "name": "useOffsetPagination",
  1637. "package": "core",
  1638. "lastUpdated": 1659592690000,
  1639. "component": true,
  1640. "docs": "https://vueuse.org/core/useOffsetPagination/",
  1641. "category": "Utilities",
  1642. "description": "reactive offset pagination"
  1643. },
  1644. {
  1645. "name": "useOnline",
  1646. "package": "core",
  1647. "lastUpdated": 1639442454000,
  1648. "component": true,
  1649. "docs": "https://vueuse.org/core/useOnline/",
  1650. "category": "Sensors",
  1651. "description": "reactive online state"
  1652. },
  1653. {
  1654. "name": "usePageLeave",
  1655. "package": "core",
  1656. "lastUpdated": 1642756441000,
  1657. "component": true,
  1658. "docs": "https://vueuse.org/core/usePageLeave/",
  1659. "category": "Sensors",
  1660. "description": "reactive state to show whether the mouse leaves the page"
  1661. },
  1662. {
  1663. "name": "useParallax",
  1664. "package": "core",
  1665. "lastUpdated": 1657718913000,
  1666. "docs": "https://vueuse.org/core/useParallax/",
  1667. "category": "Sensors",
  1668. "description": "create parallax effect easily"
  1669. },
  1670. {
  1671. "name": "usePermission",
  1672. "package": "core",
  1673. "lastUpdated": 1657430593000,
  1674. "docs": "https://vueuse.org/core/usePermission/",
  1675. "category": "Browser",
  1676. "description": "reactive [Permissions API](https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API)",
  1677. "related": [
  1678. "useUserMedia"
  1679. ]
  1680. },
  1681. {
  1682. "name": "usePointer",
  1683. "package": "core",
  1684. "lastUpdated": 1658083596000,
  1685. "component": true,
  1686. "docs": "https://vueuse.org/core/usePointer/",
  1687. "category": "Sensors",
  1688. "description": "reactive [pointer state](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_events)"
  1689. },
  1690. {
  1691. "name": "usePointerLock",
  1692. "package": "core",
  1693. "lastUpdated": 1673941699000,
  1694. "component": true,
  1695. "docs": "https://vueuse.org/core/usePointerLock/",
  1696. "category": "Sensors",
  1697. "description": "reactive [pointer lock](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API)"
  1698. },
  1699. {
  1700. "name": "usePointerSwipe",
  1701. "package": "core",
  1702. "lastUpdated": 1667953110000,
  1703. "docs": "https://vueuse.org/core/usePointerSwipe/",
  1704. "category": "Sensors",
  1705. "description": "reactive swipe detection based on [PointerEvents](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent)"
  1706. },
  1707. {
  1708. "name": "usePrecision",
  1709. "package": "math",
  1710. "lastUpdated": 1674662786000,
  1711. "docs": "https://vueuse.org/math/usePrecision/",
  1712. "category": "@Math",
  1713. "description": "reactively set the precision of a number"
  1714. },
  1715. {
  1716. "name": "usePreferredColorScheme",
  1717. "package": "core",
  1718. "lastUpdated": 1639442454000,
  1719. "component": true,
  1720. "docs": "https://vueuse.org/core/usePreferredColorScheme/",
  1721. "category": "Browser",
  1722. "description": "reactive [prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) media query"
  1723. },
  1724. {
  1725. "name": "usePreferredContrast",
  1726. "package": "core",
  1727. "lastUpdated": 1661240113000,
  1728. "component": true,
  1729. "docs": "https://vueuse.org/core/usePreferredContrast/",
  1730. "category": "Browser",
  1731. "description": "reactive [prefers-contrast](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-contrast) media query"
  1732. },
  1733. {
  1734. "name": "usePreferredDark",
  1735. "package": "core",
  1736. "lastUpdated": 1639442454000,
  1737. "component": true,
  1738. "docs": "https://vueuse.org/core/usePreferredDark/",
  1739. "category": "Browser",
  1740. "description": "reactive dark theme preference",
  1741. "related": [
  1742. "useColorMode",
  1743. "useDark"
  1744. ]
  1745. },
  1746. {
  1747. "name": "usePreferredLanguages",
  1748. "package": "core",
  1749. "lastUpdated": 1639442454000,
  1750. "component": true,
  1751. "docs": "https://vueuse.org/core/usePreferredLanguages/",
  1752. "category": "Browser",
  1753. "description": "reactive [Navigator Languages](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorLanguage/languages)"
  1754. },
  1755. {
  1756. "name": "usePreferredReducedMotion",
  1757. "package": "core",
  1758. "lastUpdated": 1659593252000,
  1759. "component": true,
  1760. "docs": "https://vueuse.org/core/usePreferredReducedMotion/",
  1761. "category": "Browser",
  1762. "description": "reactive [prefers-reduced-motion](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion) media query"
  1763. },
  1764. {
  1765. "name": "usePrevious",
  1766. "package": "core",
  1767. "lastUpdated": 1674951743000,
  1768. "docs": "https://vueuse.org/core/usePrevious/",
  1769. "category": "Utilities",
  1770. "description": "holds the previous value of a ref"
  1771. },
  1772. {
  1773. "name": "useProjection",
  1774. "package": "math",
  1775. "lastUpdated": 1657638060000,
  1776. "docs": "https://vueuse.org/math/useProjection/",
  1777. "category": "@Math",
  1778. "description": "reactive numeric projection from one domain to another",
  1779. "related": [
  1780. "createGenericProjection",
  1781. "createProjection"
  1782. ]
  1783. },
  1784. {
  1785. "name": "useQRCode",
  1786. "package": "integrations",
  1787. "lastUpdated": 1657259100000,
  1788. "docs": "https://vueuse.org/integrations/useQRCode/",
  1789. "category": "@Integrations",
  1790. "description": "wrapper for [`qrcode`](https://github.com/soldair/node-qrcode)",
  1791. "importPath": "integrations/useQRCode"
  1792. },
  1793. {
  1794. "name": "useRafFn",
  1795. "package": "core",
  1796. "lastUpdated": 1674954620000,
  1797. "docs": "https://vueuse.org/core/useRafFn/",
  1798. "category": "Animation",
  1799. "description": "call function on every `requestAnimationFrame`"
  1800. },
  1801. {
  1802. "name": "useRefHistory",
  1803. "package": "core",
  1804. "lastUpdated": 1662386652000,
  1805. "docs": "https://vueuse.org/core/useRefHistory/",
  1806. "category": "State",
  1807. "description": "track the change history of a ref",
  1808. "related": [
  1809. "useDebouncedRefHistory",
  1810. "useManualRefHistory",
  1811. "useThrottledRefHistory"
  1812. ]
  1813. },
  1814. {
  1815. "name": "useResizeObserver",
  1816. "package": "core",
  1817. "lastUpdated": 1662384935000,
  1818. "docs": "https://vueuse.org/core/useResizeObserver/",
  1819. "category": "Elements",
  1820. "description": "reports changes to the dimensions of an Element's content or the border-box"
  1821. },
  1822. {
  1823. "name": "useRound",
  1824. "package": "math",
  1825. "lastUpdated": 1657638060000,
  1826. "docs": "https://vueuse.org/math/useRound/",
  1827. "category": "@Math",
  1828. "description": "reactive `Math.round`"
  1829. },
  1830. {
  1831. "name": "useRouteHash",
  1832. "package": "router",
  1833. "lastUpdated": 1666676087000,
  1834. "docs": "https://vueuse.org/router/useRouteHash/",
  1835. "category": "@Router",
  1836. "description": "shorthand for a reactive `route.hash`"
  1837. },
  1838. {
  1839. "name": "useRouteParams",
  1840. "package": "router",
  1841. "lastUpdated": 1666676087000,
  1842. "docs": "https://vueuse.org/router/useRouteParams/",
  1843. "category": "@Router",
  1844. "description": "shorthand for a reactive `route.params`"
  1845. },
  1846. {
  1847. "name": "useRouteQuery",
  1848. "package": "router",
  1849. "lastUpdated": 1674955241000,
  1850. "docs": "https://vueuse.org/router/useRouteQuery/",
  1851. "category": "@Router",
  1852. "description": "shorthand for a reactive `route.query`"
  1853. },
  1854. {
  1855. "name": "useRTDB",
  1856. "package": "firebase",
  1857. "lastUpdated": 1658645224000,
  1858. "docs": "https://vueuse.org/firebase/useRTDB/",
  1859. "category": "@Firebase",
  1860. "description": "reactive [Firebase Realtime Database](https://firebase.google.com/docs/database) binding",
  1861. "importPath": "firebase/useRTDB"
  1862. },
  1863. {
  1864. "name": "useSchemaOrg",
  1865. "package": "schema-org",
  1866. "description": "update schema.org reactively.",
  1867. "category": "@SchemaOrg",
  1868. "external": "https://vue-schema-org.netlify.app/api/core/use-schema-org.html"
  1869. },
  1870. {
  1871. "name": "useScreenOrientation",
  1872. "package": "core",
  1873. "lastUpdated": 1657430593000,
  1874. "docs": "https://vueuse.org/core/useScreenOrientation/",
  1875. "category": "Browser",
  1876. "description": "reactive [Screen Orientation API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Orientation_API)"
  1877. },
  1878. {
  1879. "name": "useScreenSafeArea",
  1880. "package": "core",
  1881. "lastUpdated": 1640682127000,
  1882. "component": true,
  1883. "docs": "https://vueuse.org/core/useScreenSafeArea/",
  1884. "category": "Browser",
  1885. "description": "reactive `env(safe-area-inset-*)`"
  1886. },
  1887. {
  1888. "name": "useScriptTag",
  1889. "package": "core",
  1890. "lastUpdated": 1659556839000,
  1891. "docs": "https://vueuse.org/core/useScriptTag/",
  1892. "category": "Browser",
  1893. "description": "script tag injecting"
  1894. },
  1895. {
  1896. "name": "useScroll",
  1897. "package": "core",
  1898. "lastUpdated": 1676711938000,
  1899. "directive": true,
  1900. "docs": "https://vueuse.org/core/useScroll/",
  1901. "category": "Sensors",
  1902. "description": "reactive scroll position and state"
  1903. },
  1904. {
  1905. "name": "useScrollLock",
  1906. "package": "core",
  1907. "lastUpdated": 1676713396000,
  1908. "directive": true,
  1909. "docs": "https://vueuse.org/core/useScrollLock/",
  1910. "category": "Sensors",
  1911. "description": "lock scrolling of the element"
  1912. },
  1913. {
  1914. "name": "useSessionStorage",
  1915. "package": "core",
  1916. "lastUpdated": 1657634978000,
  1917. "docs": "https://vueuse.org/core/useSessionStorage/",
  1918. "category": "State",
  1919. "description": "reactive [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)",
  1920. "related": [
  1921. "useStorage"
  1922. ]
  1923. },
  1924. {
  1925. "name": "useShare",
  1926. "package": "core",
  1927. "lastUpdated": 1657718983000,
  1928. "docs": "https://vueuse.org/core/useShare/",
  1929. "category": "Browser",
  1930. "description": "reactive [Web Share API](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/share)"
  1931. },
  1932. {
  1933. "name": "useSorted",
  1934. "package": "core",
  1935. "lastUpdated": 1665961123000,
  1936. "docs": "https://vueuse.org/core/useSorted/",
  1937. "category": "Array",
  1938. "description": "reactive sort array"
  1939. },
  1940. {
  1941. "name": "useSound",
  1942. "package": "sound",
  1943. "description": "play sound effects reactively.",
  1944. "category": "@Sound",
  1945. "external": "https://github.com/vueuse/sound#examples"
  1946. },
  1947. {
  1948. "name": "useSpeechRecognition",
  1949. "package": "core",
  1950. "lastUpdated": 1662892188000,
  1951. "docs": "https://vueuse.org/core/useSpeechRecognition/",
  1952. "category": "Sensors",
  1953. "description": "reactive [SpeechRecognition](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition)"
  1954. },
  1955. {
  1956. "name": "useSpeechSynthesis",
  1957. "package": "core",
  1958. "lastUpdated": 1676650547000,
  1959. "docs": "https://vueuse.org/core/useSpeechSynthesis/",
  1960. "category": "Sensors",
  1961. "description": "reactive [SpeechSynthesis](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis)"
  1962. },
  1963. {
  1964. "package": "motion",
  1965. "category": "@Motion",
  1966. "name": "useSpring",
  1967. "description": "spring animations.",
  1968. "external": "https://motion.vueuse.org/api/use-spring.html"
  1969. },
  1970. {
  1971. "name": "useStepper",
  1972. "package": "core",
  1973. "lastUpdated": 1657132687000,
  1974. "docs": "https://vueuse.org/core/useStepper/",
  1975. "category": "Utilities",
  1976. "description": "provides helpers for building a multi-step wizard interface"
  1977. },
  1978. {
  1979. "name": "useStorage",
  1980. "package": "core",
  1981. "lastUpdated": 1676387907000,
  1982. "docs": "https://vueuse.org/core/useStorage/",
  1983. "category": "State",
  1984. "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)",
  1985. "related": [
  1986. "useColorMode",
  1987. "useDark",
  1988. "useLocalStorage",
  1989. "useSessionStorage",
  1990. "useStorageAsync"
  1991. ]
  1992. },
  1993. {
  1994. "name": "useStorageAsync",
  1995. "package": "core",
  1996. "lastUpdated": 1676546331000,
  1997. "docs": "https://vueuse.org/core/useStorageAsync/",
  1998. "category": "State",
  1999. "description": "reactive Storage in with async support",
  2000. "related": [
  2001. "useStorage"
  2002. ]
  2003. },
  2004. {
  2005. "name": "useStyleTag",
  2006. "package": "core",
  2007. "lastUpdated": 1669416726000,
  2008. "docs": "https://vueuse.org/core/useStyleTag/",
  2009. "category": "Browser",
  2010. "description": "inject reactive `style` element in head"
  2011. },
  2012. {
  2013. "name": "useSubject",
  2014. "package": "rxjs",
  2015. "lastUpdated": 1672752994000,
  2016. "docs": "https://vueuse.org/rxjs/useSubject/",
  2017. "category": "@RxJS",
  2018. "description": "bind an RxJS [`Subject`](https://rxjs.dev/guide/subject) to a `ref` and propagate value changes both ways"
  2019. },
  2020. {
  2021. "name": "useSubscription",
  2022. "package": "rxjs",
  2023. "lastUpdated": 1628521945000,
  2024. "docs": "https://vueuse.org/rxjs/useSubscription/",
  2025. "category": "@RxJS",
  2026. "description": "use an RxJS [`Subscription`](https://rxjs.dev/guide/subscription) without worrying about unsubscribing from it or creating memory leaks"
  2027. },
  2028. {
  2029. "name": "useSum",
  2030. "package": "math",
  2031. "lastUpdated": 1658041190000,
  2032. "docs": "https://vueuse.org/math/useSum/",
  2033. "category": "@Math",
  2034. "description": "get the sum of an array reactively"
  2035. },
  2036. {
  2037. "name": "useSupported",
  2038. "package": "core",
  2039. "lastUpdated": 1657430593000,
  2040. "docs": "https://vueuse.org/core/useSupported/",
  2041. "category": "Utilities",
  2042. "description": "sSR compatibility `isSupported`"
  2043. },
  2044. {
  2045. "name": "useSwipe",
  2046. "package": "core",
  2047. "lastUpdated": 1657721393000,
  2048. "docs": "https://vueuse.org/core/useSwipe/",
  2049. "category": "Sensors",
  2050. "description": "reactive swipe detection based on [`TouchEvents`](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent)"
  2051. },
  2052. {
  2053. "name": "useTemplateRefsList",
  2054. "package": "core",
  2055. "lastUpdated": 1639442454000,
  2056. "docs": "https://vueuse.org/core/useTemplateRefsList/",
  2057. "category": "Component",
  2058. "description": "shorthand for binding refs to template elements and components inside `v-for`"
  2059. },
  2060. {
  2061. "name": "useTextareaAutosize",
  2062. "package": "core",
  2063. "lastUpdated": 1671205095000,
  2064. "docs": "https://vueuse.org/core/useTextareaAutosize/",
  2065. "category": "Browser",
  2066. "description": "automatically update the height of a textarea depending on the content"
  2067. },
  2068. {
  2069. "name": "useTextDirection",
  2070. "package": "core",
  2071. "lastUpdated": 1658657118000,
  2072. "docs": "https://vueuse.org/core/useTextDirection/",
  2073. "category": "Browser",
  2074. "description": "reactive [dir](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) of the element's text"
  2075. },
  2076. {
  2077. "name": "useTextSelection",
  2078. "package": "core",
  2079. "lastUpdated": 1646469737000,
  2080. "docs": "https://vueuse.org/core/useTextSelection/",
  2081. "category": "Sensors",
  2082. "description": "reactively track user text selection based on [`Window.getSelection`](https://developer.mozilla.org/en-US/docs/Web/API/Window/getSelection)"
  2083. },
  2084. {
  2085. "name": "useThrottledRefHistory",
  2086. "package": "core",
  2087. "lastUpdated": 1658083596000,
  2088. "docs": "https://vueuse.org/core/useThrottledRefHistory/",
  2089. "category": "State",
  2090. "description": "shorthand for `useRefHistory` with throttled filter",
  2091. "related": [
  2092. "useDebouncedRefHistory",
  2093. "useRefHistory"
  2094. ]
  2095. },
  2096. {
  2097. "name": "useThrottleFn",
  2098. "package": "shared",
  2099. "lastUpdated": 1672753228000,
  2100. "docs": "https://vueuse.org/shared/useThrottleFn/",
  2101. "category": "Utilities",
  2102. "description": "throttle execution of a function",
  2103. "related": [
  2104. "refDebounced",
  2105. "refThrottled",
  2106. "useDebounceFn"
  2107. ]
  2108. },
  2109. {
  2110. "name": "useTimeAgo",
  2111. "package": "core",
  2112. "lastUpdated": 1671824301000,
  2113. "component": true,
  2114. "docs": "https://vueuse.org/core/useTimeAgo/",
  2115. "category": "Time",
  2116. "description": "reactive time ago"
  2117. },
  2118. {
  2119. "name": "useTimeout",
  2120. "package": "shared",
  2121. "lastUpdated": 1664157082000,
  2122. "docs": "https://vueuse.org/shared/useTimeout/",
  2123. "category": "Animation",
  2124. "description": "update value after a given time with controls"
  2125. },
  2126. {
  2127. "name": "useTimeoutFn",
  2128. "package": "shared",
  2129. "lastUpdated": 1674954620000,
  2130. "docs": "https://vueuse.org/shared/useTimeoutFn/",
  2131. "category": "Animation",
  2132. "description": "wrapper for `setTimeout` with controls"
  2133. },
  2134. {
  2135. "name": "useTimeoutPoll",
  2136. "package": "core",
  2137. "lastUpdated": 1658083632000,
  2138. "docs": "https://vueuse.org/core/useTimeoutPoll/",
  2139. "category": "Utilities",
  2140. "description": "use timeout to poll something"
  2141. },
  2142. {
  2143. "name": "useTimestamp",
  2144. "package": "core",
  2145. "lastUpdated": 1664157082000,
  2146. "component": true,
  2147. "docs": "https://vueuse.org/core/useTimestamp/",
  2148. "category": "Animation",
  2149. "description": "reactive current timestamp"
  2150. },
  2151. {
  2152. "name": "useTitle",
  2153. "package": "core",
  2154. "lastUpdated": 1665963788000,
  2155. "docs": "https://vueuse.org/core/useTitle/",
  2156. "category": "Browser",
  2157. "description": "reactive document title"
  2158. },
  2159. {
  2160. "name": "useToFixed",
  2161. "package": "math",
  2162. "lastUpdated": 1659586610000,
  2163. "docs": "https://vueuse.org/math/useToFixed/",
  2164. "category": "@Math",
  2165. "description": "reactive `toFixed`",
  2166. "deprecated": true
  2167. },
  2168. {
  2169. "name": "useToggle",
  2170. "package": "shared",
  2171. "lastUpdated": 1657259100000,
  2172. "docs": "https://vueuse.org/shared/useToggle/",
  2173. "category": "Utilities",
  2174. "description": "a boolean switcher with utility functions"
  2175. },
  2176. {
  2177. "name": "useToNumber",
  2178. "package": "shared",
  2179. "lastUpdated": 1659592336000,
  2180. "docs": "https://vueuse.org/shared/useToNumber/",
  2181. "category": "Utilities",
  2182. "description": "reactively convert a string ref to number"
  2183. },
  2184. {
  2185. "name": "useToString",
  2186. "package": "shared",
  2187. "lastUpdated": 1659592531000,
  2188. "docs": "https://vueuse.org/shared/useToString/",
  2189. "category": "Utilities",
  2190. "description": "reactively convert a ref to string"
  2191. },
  2192. {
  2193. "name": "useTransition",
  2194. "package": "core",
  2195. "lastUpdated": 1674955241000,
  2196. "docs": "https://vueuse.org/core/useTransition/",
  2197. "category": "Animation",
  2198. "description": "transition between values"
  2199. },
  2200. {
  2201. "name": "useTrunc",
  2202. "package": "math",
  2203. "lastUpdated": 1658043525000,
  2204. "docs": "https://vueuse.org/math/useTrunc/",
  2205. "category": "@Math",
  2206. "description": "reactive `Math.trunc`"
  2207. },
  2208. {
  2209. "name": "useUrlSearchParams",
  2210. "package": "core",
  2211. "lastUpdated": 1662286506000,
  2212. "docs": "https://vueuse.org/core/useUrlSearchParams/",
  2213. "category": "Browser",
  2214. "description": "reactive [URLSearchParams](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams)"
  2215. },
  2216. {
  2217. "name": "useUserMedia",
  2218. "package": "core",
  2219. "lastUpdated": 1657430593000,
  2220. "docs": "https://vueuse.org/core/useUserMedia/",
  2221. "category": "Sensors",
  2222. "description": "reactive [`mediaDevices.getUserMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) streaming",
  2223. "related": [
  2224. "useDevicesList",
  2225. "useDisplayMedia",
  2226. "usePermission"
  2227. ]
  2228. },
  2229. {
  2230. "name": "useVibrate",
  2231. "package": "core",
  2232. "lastUpdated": 1657430593000,
  2233. "docs": "https://vueuse.org/core/useVibrate/",
  2234. "category": "Browser",
  2235. "description": "reactive [Vibration API](https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API)"
  2236. },
  2237. {
  2238. "name": "useVirtualList",
  2239. "package": "core",
  2240. "lastUpdated": 1676174012000,
  2241. "component": true,
  2242. "docs": "https://vueuse.org/core/useVirtualList/",
  2243. "category": "Component",
  2244. "description": "create virtual lists with ease"
  2245. },
  2246. {
  2247. "name": "useVModel",
  2248. "package": "core",
  2249. "lastUpdated": 1662386652000,
  2250. "docs": "https://vueuse.org/core/useVModel/",
  2251. "category": "Component",
  2252. "description": "shorthand for v-model binding",
  2253. "related": [
  2254. "useVModels"
  2255. ]
  2256. },
  2257. {
  2258. "name": "useVModels",
  2259. "package": "core",
  2260. "lastUpdated": 1657730657000,
  2261. "docs": "https://vueuse.org/core/useVModels/",
  2262. "category": "Component",
  2263. "description": "shorthand for props v-model binding",
  2264. "related": [
  2265. "useVModel"
  2266. ]
  2267. },
  2268. {
  2269. "name": "useWakeLock",
  2270. "package": "core",
  2271. "lastUpdated": 1658083596000,
  2272. "docs": "https://vueuse.org/core/useWakeLock/",
  2273. "category": "Browser",
  2274. "description": "reactive [Screen Wake Lock API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API)"
  2275. },
  2276. {
  2277. "name": "useWebNotification",
  2278. "package": "core",
  2279. "lastUpdated": 1658083596000,
  2280. "docs": "https://vueuse.org/core/useWebNotification/",
  2281. "category": "Browser",
  2282. "description": "reactive [Notification](https://developer.mozilla.org/en-US/docs/Web/API/notification)"
  2283. },
  2284. {
  2285. "name": "useWebSocket",
  2286. "package": "core",
  2287. "lastUpdated": 1674954839000,
  2288. "docs": "https://vueuse.org/core/useWebSocket/",
  2289. "category": "Network",
  2290. "description": "reactive [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket) client"
  2291. },
  2292. {
  2293. "name": "useWebWorker",
  2294. "package": "core",
  2295. "lastUpdated": 1666677873000,
  2296. "docs": "https://vueuse.org/core/useWebWorker/",
  2297. "category": "Browser",
  2298. "description": "simple [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) registration and communication",
  2299. "related": [
  2300. "useWebWorkerFn"
  2301. ]
  2302. },
  2303. {
  2304. "name": "useWebWorkerFn",
  2305. "package": "core",
  2306. "lastUpdated": 1657730737000,
  2307. "docs": "https://vueuse.org/core/useWebWorkerFn/",
  2308. "category": "Browser",
  2309. "description": "run expensive functions without blocking the UI",
  2310. "related": [
  2311. "useWebWorker"
  2312. ]
  2313. },
  2314. {
  2315. "name": "useWindowFocus",
  2316. "package": "core",
  2317. "lastUpdated": 1639442454000,
  2318. "component": true,
  2319. "docs": "https://vueuse.org/core/useWindowFocus/",
  2320. "category": "Elements",
  2321. "description": "reactively track window focus with `window.onfocus` and `window.onblur` events"
  2322. },
  2323. {
  2324. "name": "useWindowScroll",
  2325. "package": "core",
  2326. "lastUpdated": 1676590806000,
  2327. "docs": "https://vueuse.org/core/useWindowScroll/",
  2328. "category": "Elements",
  2329. "description": "reactive window scroll"
  2330. },
  2331. {
  2332. "name": "useWindowSize",
  2333. "package": "core",
  2334. "lastUpdated": 1662285565000,
  2335. "component": true,
  2336. "docs": "https://vueuse.org/core/useWindowSize/",
  2337. "category": "Elements",
  2338. "description": "reactive window size"
  2339. },
  2340. {
  2341. "name": "useZoomFactor",
  2342. "package": "electron",
  2343. "lastUpdated": 1658645224000,
  2344. "docs": "https://vueuse.org/electron/useZoomFactor/",
  2345. "category": "@Electron",
  2346. "description": "reactive [WebFrame](https://www.electronjs.org/docs/api/web-frame#webframe) zoom factor"
  2347. },
  2348. {
  2349. "name": "useZoomLevel",
  2350. "package": "electron",
  2351. "lastUpdated": 1658645224000,
  2352. "docs": "https://vueuse.org/electron/useZoomLevel/",
  2353. "category": "@Electron",
  2354. "description": "reactive [WebFrame](https://www.electronjs.org/docs/api/web-frame#webframe) zoom level"
  2355. },
  2356. {
  2357. "name": "utils",
  2358. "package": "shared",
  2359. "lastUpdated": 1672752994000,
  2360. "internal": true
  2361. },
  2362. {
  2363. "name": "watchArray",
  2364. "package": "shared",
  2365. "lastUpdated": 1657133473000,
  2366. "docs": "https://vueuse.org/shared/watchArray/",
  2367. "category": "Watch",
  2368. "description": "watch for an array with additions and removals"
  2369. },
  2370. {
  2371. "name": "watchAtMost",
  2372. "package": "shared",
  2373. "lastUpdated": 1662892188000,
  2374. "docs": "https://vueuse.org/shared/watchAtMost/",
  2375. "category": "Watch",
  2376. "description": "`watch` with the number of times triggered"
  2377. },
  2378. {
  2379. "name": "watchDebounced",
  2380. "package": "shared",
  2381. "lastUpdated": 1662892188000,
  2382. "docs": "https://vueuse.org/shared/watchDebounced/",
  2383. "category": "Watch",
  2384. "description": "debounced watch",
  2385. "alias": [
  2386. "debouncedWatch"
  2387. ]
  2388. },
  2389. {
  2390. "name": "watchIgnorable",
  2391. "package": "shared",
  2392. "lastUpdated": 1655390134000,
  2393. "docs": "https://vueuse.org/shared/watchIgnorable/",
  2394. "category": "Watch",
  2395. "description": "ignorable watch",
  2396. "alias": [
  2397. "ignorableWatch"
  2398. ]
  2399. },
  2400. {
  2401. "name": "watchOnce",
  2402. "package": "shared",
  2403. "lastUpdated": 1662892188000,
  2404. "docs": "https://vueuse.org/shared/watchOnce/",
  2405. "category": "Watch",
  2406. "description": "`watch` that only triggers once"
  2407. },
  2408. {
  2409. "name": "watchPausable",
  2410. "package": "shared",
  2411. "lastUpdated": 1662892188000,
  2412. "docs": "https://vueuse.org/shared/watchPausable/",
  2413. "category": "Watch",
  2414. "description": "pausable watch",
  2415. "alias": [
  2416. "pausableWatch"
  2417. ]
  2418. },
  2419. {
  2420. "name": "watchThrottled",
  2421. "package": "shared",
  2422. "lastUpdated": 1657259100000,
  2423. "docs": "https://vueuse.org/shared/watchThrottled/",
  2424. "category": "Watch",
  2425. "description": "throttled watch",
  2426. "alias": [
  2427. "throttledWatch"
  2428. ]
  2429. },
  2430. {
  2431. "name": "watchTriggerable",
  2432. "package": "shared",
  2433. "lastUpdated": 1657077213000,
  2434. "docs": "https://vueuse.org/shared/watchTriggerable/",
  2435. "category": "Watch",
  2436. "description": "watch that can be triggered manually"
  2437. },
  2438. {
  2439. "name": "watchWithFilter",
  2440. "package": "shared",
  2441. "lastUpdated": 1662892188000,
  2442. "docs": "https://vueuse.org/shared/watchWithFilter/",
  2443. "category": "Watch",
  2444. "description": "`watch` with additional EventFilter control"
  2445. },
  2446. {
  2447. "name": "whenever",
  2448. "package": "shared",
  2449. "lastUpdated": 1658645224000,
  2450. "docs": "https://vueuse.org/shared/whenever/",
  2451. "category": "Watch",
  2452. "description": "shorthand for watching value to be truthy"
  2453. }
  2454. ]
  2455. }