index.mjs 70 KB

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