24246cb9b753b9e9261ce7f515581f43bfa3e6c0c82f8fea2d066a0d022677e8da4d78dcfcbd4f8e16c4723552efac8fc95e69094fe07b69db0ad51206c83c 70 KB

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