index.cjs 65 KB

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