index.json 84 KB

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