index.cjs 65 KB

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