index.js 75 KB

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