index.mjs 65 KB

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