index.mjs 66 KB

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