智慧水务管理系统 - 精河县供水工程综合管理平台

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