| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589 |
- //#region index.json
- var packages$1 = {
- "shared": {
- "name": "shared",
- "display": "Shared utilities",
- "dir": "packages/shared"
- },
- "core": {
- "name": "core",
- "display": "VueUse",
- "description": "Collection of essential Vue Composition Utilities",
- "dir": "packages/core"
- },
- "components": {
- "name": "components",
- "display": "Components",
- "description": "Renderless components for VueUse",
- "author": "Jacob Clevenger<https://github.com/wheatjs>",
- "dir": "packages/components"
- },
- "math": {
- "name": "math",
- "display": "Math",
- "description": "Math functions for VueUse",
- "dir": "packages/math"
- },
- "router": {
- "name": "router",
- "display": "Router",
- "description": "Utilities for vue-router",
- "addon": true,
- "external": ["vue-router"],
- "globals": { "vue-router": "VueRouter" },
- "dir": "packages/router",
- "docs": "https://vueuse.org/router/README.html"
- },
- "integrations": {
- "name": "integrations",
- "display": "Integrations",
- "description": "Integration wrappers for utility libraries",
- "addon": true,
- "submodules": true,
- "external": [
- "axios",
- "universal-cookie",
- "qrcode",
- "http",
- "nprogress",
- "jwt-decode",
- "focus-trap",
- "change-case",
- "drauu",
- "fuse.js",
- "async-validator",
- "idb-keyval",
- "sortablejs",
- "node:http"
- ],
- "globals": {
- "axios": "axios",
- "universal-cookie": "UniversalCookie",
- "qrcode": "QRCode",
- "nprogress": "nprogress",
- "jwt-decode": "jwt_decode",
- "focus-trap": "focusTrap",
- "drauu": "Drauu",
- "fuse.js": "Fuse",
- "change-case": "changeCase",
- "async-validator": "AsyncValidator",
- "idb-keyval": "idbKeyval",
- "sortablejs": "Sortable"
- },
- "dir": "packages/integrations",
- "docs": "https://vueuse.org/integrations/README.html"
- },
- "rxjs": {
- "name": "rxjs",
- "display": "RxJS",
- "description": "Enables RxJS reactive functions in Vue",
- "addon": true,
- "external": ["rxjs", "rxjs/operators"],
- "globals": {
- "rxjs": "rxjs",
- "rxjs/operators": "rxjs.operator"
- },
- "dir": "packages/rxjs",
- "docs": "https://vueuse.org/rxjs/README.html"
- },
- "firebase": {
- "name": "firebase",
- "display": "Firebase",
- "description": "Enables realtime bindings for Firebase",
- "addon": true,
- "submodules": true,
- "external": [
- "firebase",
- "firebase/app",
- "firebase/database",
- "firebase/firestore"
- ],
- "globals": {
- "firebase": "firebase",
- "firebase/app": "firebase",
- "firebase/database": "firebase",
- "firebase/firestore": "firebase"
- },
- "dir": "packages/firebase",
- "docs": "https://vueuse.org/firebase/README.html"
- },
- "electron": {
- "name": "electron",
- "display": "Electron",
- "description": "Electron renderer process modules for VueUse",
- "author": "Archer Gu<https://github.com/ArcherGu>",
- "addon": true,
- "external": ["electron"],
- "iife": false,
- "dir": "packages/electron",
- "docs": "https://vueuse.org/electron/README.html"
- }
- };
- var categories$1 = [
- "Animation",
- "Array",
- "Browser",
- "Component",
- "Elements",
- "Network",
- "Reactivity",
- "Sensors",
- "State",
- "Time",
- "Utilities",
- "Watch",
- "@Electron",
- "@Firebase",
- "@Head",
- "@Integrations",
- "@Math",
- "@Motion",
- "@Router",
- "@RxJS",
- "@SchemaOrg",
- "@Sound"
- ];
- var functions$1 = [
- {
- "name": "computedAsync",
- "package": "core",
- "lastUpdated": 1767923245e3,
- "docs": "https://vueuse.org/core/computedAsync/",
- "category": "Reactivity",
- "description": "computed for async functions",
- "alias": ["asyncComputed"]
- },
- {
- "name": "computedEager",
- "package": "shared",
- "lastUpdated": 1774958324e3,
- "docs": "https://vueuse.org/shared/computedEager/",
- "category": "Reactivity",
- "description": "eager computed without lazy evaluation",
- "alias": ["eagerComputed"]
- },
- {
- "name": "computedInject",
- "package": "core",
- "lastUpdated": 1767755257e3,
- "docs": "https://vueuse.org/core/computedInject/",
- "category": "Component",
- "description": "combine `computed` and `inject`"
- },
- {
- "name": "computedWithControl",
- "package": "shared",
- "lastUpdated": 1767755257e3,
- "docs": "https://vueuse.org/shared/computedWithControl/",
- "category": "Reactivity",
- "description": "explicitly define the dependencies of computed",
- "alias": ["controlledComputed"],
- "related": ["refWithControl"]
- },
- {
- "name": "createDisposableDirective",
- "package": "shared",
- "lastUpdated": 1776333975e3,
- "docs": "https://vueuse.org/shared/createDisposableDirective/",
- "category": "Utilities",
- "description": "utility for authoring disposable directives"
- },
- {
- "name": "createEventHook",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/createEventHook/",
- "category": "Utilities",
- "description": "utility for creating event hooks"
- },
- {
- "name": "createGenericProjection",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/createGenericProjection/",
- "category": "@Math",
- "description": "generic version of `createProjection`",
- "related": ["createProjection", "useProjection"]
- },
- {
- "name": "createGlobalState",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/createGlobalState/",
- "category": "State",
- "description": "keep states in the global scope to be reusable across Vue instances",
- "related": ["createSharedComposable"]
- },
- {
- "name": "createHead",
- "package": "head",
- "description": "create the head manager instance.",
- "category": "@Head",
- "external": "https://github.com/vueuse/head#api"
- },
- {
- "name": "createInjectionState",
- "package": "shared",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/shared/createInjectionState/",
- "category": "State",
- "description": "create global state that can be injected into components"
- },
- {
- "name": "createProjection",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/createProjection/",
- "category": "@Math",
- "description": "reactive numeric projection from one domain to another",
- "related": ["createGenericProjection", "useProjection"]
- },
- {
- "name": "createRef",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/createRef/",
- "category": "Reactivity",
- "description": "returns a `deepRef` or `shallowRef` depending on the `deep` param"
- },
- {
- "name": "createReusableTemplate",
- "package": "core",
- "lastUpdated": 1772276777e3,
- "docs": "https://vueuse.org/core/createReusableTemplate/",
- "category": "Component",
- "description": "define and reuse template inside the component scope"
- },
- {
- "name": "createSchemaOrg",
- "package": "schema-org",
- "description": "create the schema.org manager instance.",
- "category": "@SchemaOrg",
- "external": "https://vue-schema-org.netlify.app/api/core/create-schema-org.html"
- },
- {
- "name": "createSharedComposable",
- "package": "shared",
- "lastUpdated": 1758032331e3,
- "docs": "https://vueuse.org/shared/createSharedComposable/",
- "category": "State",
- "description": "make a composable function usable with multiple Vue instances",
- "related": ["createGlobalState"]
- },
- {
- "name": "createTemplatePromise",
- "package": "core",
- "lastUpdated": 1758032485e3,
- "docs": "https://vueuse.org/core/createTemplatePromise/",
- "category": "Component",
- "description": "template as Promise"
- },
- {
- "name": "createUnrefFn",
- "package": "core",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/core/createUnrefFn/",
- "category": "Utilities",
- "description": "make a plain function accepting ref and raw values as arguments",
- "related": ["reactify"]
- },
- {
- "name": "extendRef",
- "package": "shared",
- "lastUpdated": 1744088337e3,
- "docs": "https://vueuse.org/shared/extendRef/",
- "category": "Reactivity",
- "description": "add extra attributes to Ref"
- },
- {
- "name": "from",
- "package": "rxjs",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/rxjs/from/",
- "category": "@RxJS",
- "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"
- },
- {
- "name": "get",
- "package": "shared",
- "lastUpdated": 1753513037e3,
- "docs": "https://vueuse.org/shared/get/",
- "category": "Utilities",
- "description": "shorthand for accessing `ref.value`"
- },
- {
- "name": "injectLocal",
- "package": "shared",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/shared/injectLocal/",
- "category": "State",
- "description": "extended `inject` with ability to call `provideLocal` to provide the value in the same component"
- },
- {
- "name": "isDefined",
- "package": "shared",
- "lastUpdated": 1744088337e3,
- "docs": "https://vueuse.org/shared/isDefined/",
- "category": "Utilities",
- "description": "non-nullish checking type guard for Ref"
- },
- {
- "name": "logicAnd",
- "package": "math",
- "lastUpdated": 1757478278e3,
- "docs": "https://vueuse.org/math/logicAnd/",
- "category": "@Math",
- "description": "`AND` condition for refs",
- "alias": ["and"],
- "related": ["logicNot", "logicOr"]
- },
- {
- "name": "logicNot",
- "package": "math",
- "lastUpdated": 1757478278e3,
- "docs": "https://vueuse.org/math/logicNot/",
- "category": "@Math",
- "description": "`NOT` condition for ref",
- "alias": ["not"],
- "related": ["logicAnd", "logicOr"]
- },
- {
- "name": "logicOr",
- "package": "math",
- "lastUpdated": 1757478278e3,
- "docs": "https://vueuse.org/math/logicOr/",
- "category": "@Math",
- "description": "`OR` conditions for refs",
- "alias": ["or"],
- "related": ["logicAnd", "logicNot"]
- },
- {
- "name": "makeDestructurable",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/makeDestructurable/",
- "category": "Utilities",
- "description": "make isomorphic destructurable for object and array at the same time"
- },
- {
- "name": "onClickOutside",
- "package": "core",
- "lastUpdated": 177495633e4,
- "component": true,
- "directive": true,
- "docs": "https://vueuse.org/core/onClickOutside/",
- "category": "Sensors",
- "description": "listen for clicks outside of an element"
- },
- {
- "name": "onElementRemoval",
- "package": "core",
- "lastUpdated": 1735805567e3,
- "docs": "https://vueuse.org/core/onElementRemoval/",
- "category": "Sensors",
- "description": "fires when the element or any element containing it is removed from the DOM"
- },
- {
- "name": "onKeyStroke",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "directive": true,
- "docs": "https://vueuse.org/core/onKeyStroke/",
- "category": "Sensors",
- "description": "listen for keyboard keystrokes",
- "variants": [
- "onKeyDown",
- "onKeyUp",
- "onKeyPressed"
- ]
- },
- {
- "name": "onLongPress",
- "package": "core",
- "lastUpdated": 1786586292e3,
- "component": true,
- "directive": true,
- "docs": "https://vueuse.org/core/onLongPress/",
- "category": "Sensors",
- "description": "listen for a long press on an element"
- },
- {
- "name": "onStartTyping",
- "package": "core",
- "lastUpdated": 1779295353e3,
- "docs": "https://vueuse.org/core/onStartTyping/",
- "category": "Sensors",
- "description": "fires when users start typing on non-editable elements"
- },
- {
- "name": "provideLocal",
- "package": "shared",
- "lastUpdated": 1758403186e3,
- "docs": "https://vueuse.org/shared/provideLocal/",
- "category": "State",
- "description": "extended `provide` with ability to call `injectLocal` to obtain the value in the same component"
- },
- {
- "name": "reactify",
- "package": "shared",
- "lastUpdated": 1758032498e3,
- "docs": "https://vueuse.org/shared/reactify/",
- "category": "Reactivity",
- "description": "converts plain functions into reactive functions",
- "alias": ["createReactiveFn"],
- "related": ["createUnrefFn"]
- },
- {
- "name": "reactifyObject",
- "package": "shared",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/shared/reactifyObject/",
- "category": "Reactivity",
- "description": "apply `reactify` to an object"
- },
- {
- "name": "reactiveComputed",
- "package": "shared",
- "lastUpdated": 1744088337e3,
- "docs": "https://vueuse.org/shared/reactiveComputed/",
- "category": "Reactivity",
- "description": "computed reactive object"
- },
- {
- "name": "reactiveOmit",
- "package": "shared",
- "lastUpdated": 1758032498e3,
- "docs": "https://vueuse.org/shared/reactiveOmit/",
- "category": "Reactivity",
- "description": "reactively omit fields from a reactive object"
- },
- {
- "name": "reactivePick",
- "package": "shared",
- "lastUpdated": 1767755257e3,
- "docs": "https://vueuse.org/shared/reactivePick/",
- "category": "Reactivity",
- "description": "reactively pick fields from a reactive object"
- },
- {
- "name": "refAutoReset",
- "package": "shared",
- "lastUpdated": 1757478278e3,
- "docs": "https://vueuse.org/shared/refAutoReset/",
- "category": "Reactivity",
- "description": "a ref which will be reset to the default value after some time",
- "alias": ["autoResetRef"]
- },
- {
- "name": "refDebounced",
- "package": "shared",
- "lastUpdated": 1757478278e3,
- "docs": "https://vueuse.org/shared/refDebounced/",
- "category": "Reactivity",
- "description": "debounce execution of a ref value",
- "alias": ["useDebounce", "debouncedRef"],
- "related": ["useThrottleFn"]
- },
- {
- "name": "refDefault",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/refDefault/",
- "category": "Reactivity",
- "description": "apply default value to a ref"
- },
- {
- "name": "refManualReset",
- "package": "shared",
- "lastUpdated": 176792353e4,
- "docs": "https://vueuse.org/shared/refManualReset/",
- "category": "Reactivity",
- "description": "create a ref with manual reset functionality"
- },
- {
- "name": "refThrottled",
- "package": "shared",
- "lastUpdated": 1757478278e3,
- "docs": "https://vueuse.org/shared/refThrottled/",
- "category": "Reactivity",
- "description": "throttle changing of a ref value",
- "alias": ["useThrottle", "throttledRef"],
- "related": ["useThrottleFn"]
- },
- {
- "name": "refWithControl",
- "package": "shared",
- "lastUpdated": 1757478278e3,
- "docs": "https://vueuse.org/shared/refWithControl/",
- "category": "Reactivity",
- "description": "fine-grained controls over ref and its reactivity",
- "alias": ["controlledRef"],
- "related": ["computedWithControl"]
- },
- {
- "name": "set",
- "package": "shared",
- "lastUpdated": 1732178709e3,
- "docs": "https://vueuse.org/shared/set/",
- "category": "Utilities",
- "description": "shorthand for `ref.value = x`"
- },
- {
- "name": "syncRef",
- "package": "shared",
- "lastUpdated": 1764573571e3,
- "docs": "https://vueuse.org/shared/syncRef/",
- "category": "Reactivity",
- "description": "two-way refs synchronization",
- "related": ["syncRefs"]
- },
- {
- "name": "syncRefs",
- "package": "shared",
- "lastUpdated": 1741154516e3,
- "docs": "https://vueuse.org/shared/syncRefs/",
- "category": "Reactivity",
- "description": "keep target refs in sync with a source ref",
- "related": ["syncRef"]
- },
- {
- "name": "toObserver",
- "package": "rxjs",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/rxjs/toObserver/",
- "category": "@RxJS",
- "description": "sugar function to convert a `ref` into an RxJS [Observer](https://rxjs.dev/guide/observer)"
- },
- {
- "name": "toReactive",
- "package": "shared",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/shared/toReactive/",
- "category": "Reactivity",
- "description": "converts ref to reactive"
- },
- {
- "name": "toRef",
- "package": "shared",
- "lastUpdated": 1774958324e3,
- "docs": "https://vueuse.org/shared/toRef/",
- "category": "Reactivity",
- "description": "normalize value/ref/getter to `ref` or `computed`"
- },
- {
- "name": "toRefs",
- "package": "shared",
- "lastUpdated": 1744088337e3,
- "docs": "https://vueuse.org/shared/toRefs/",
- "category": "Reactivity",
- "description": "extended [`toRefs`](https://vuejs.org/api/reactivity-utilities.html#torefs) that also accepts refs of an object"
- },
- {
- "name": "tryOnBeforeMount",
- "package": "shared",
- "lastUpdated": 1758696813e3,
- "docs": "https://vueuse.org/shared/tryOnBeforeMount/",
- "category": "Component",
- "description": "safe `onBeforeMount`"
- },
- {
- "name": "tryOnBeforeUnmount",
- "package": "shared",
- "lastUpdated": 1758696813e3,
- "docs": "https://vueuse.org/shared/tryOnBeforeUnmount/",
- "category": "Component",
- "description": "safe `onBeforeUnmount`"
- },
- {
- "name": "tryOnMounted",
- "package": "shared",
- "lastUpdated": 1758696813e3,
- "docs": "https://vueuse.org/shared/tryOnMounted/",
- "category": "Component",
- "description": "safe `onMounted`"
- },
- {
- "name": "tryOnScopeDispose",
- "package": "shared",
- "lastUpdated": 1758668657e3,
- "docs": "https://vueuse.org/shared/tryOnScopeDispose/",
- "category": "Component",
- "description": "safe `onScopeDispose`"
- },
- {
- "name": "tryOnUnmounted",
- "package": "shared",
- "lastUpdated": 1758696813e3,
- "docs": "https://vueuse.org/shared/tryOnUnmounted/",
- "category": "Component",
- "description": "safe `onUnmounted`"
- },
- {
- "name": "unrefElement",
- "package": "core",
- "lastUpdated": 1783111363e3,
- "docs": "https://vueuse.org/core/unrefElement/",
- "category": "Component",
- "description": "retrieves the underlying DOM element from a Vue ref or component instance"
- },
- {
- "name": "until",
- "package": "shared",
- "lastUpdated": 1767923245e3,
- "docs": "https://vueuse.org/shared/until/",
- "category": "Watch",
- "description": "promised one-time watch for changes"
- },
- {
- "name": "useAbs",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/useAbs/",
- "category": "@Math",
- "description": "reactive `Math.abs`"
- },
- {
- "name": "useActiveElement",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useActiveElement/",
- "category": "Elements",
- "description": "reactive `document.activeElement`"
- },
- {
- "name": "useAnimate",
- "package": "core",
- "lastUpdated": 1770013115e3,
- "docs": "https://vueuse.org/core/useAnimate/",
- "category": "Animation",
- "description": "reactive [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API)"
- },
- {
- "name": "useArrayDifference",
- "package": "shared",
- "lastUpdated": 1767755257e3,
- "docs": "https://vueuse.org/shared/useArrayDifference/",
- "category": "Array",
- "description": "reactive get array difference of two arrays"
- },
- {
- "name": "useArrayEvery",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/useArrayEvery/",
- "category": "Array",
- "description": "reactive `Array.every`"
- },
- {
- "name": "useArrayFilter",
- "package": "shared",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/shared/useArrayFilter/",
- "category": "Array",
- "description": "reactive `Array.filter`"
- },
- {
- "name": "useArrayFind",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/useArrayFind/",
- "category": "Array",
- "description": "reactive `Array.find`"
- },
- {
- "name": "useArrayFindIndex",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/useArrayFindIndex/",
- "category": "Array",
- "description": "reactive `Array.findIndex`"
- },
- {
- "name": "useArrayFindLast",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/useArrayFindLast/",
- "category": "Array",
- "description": "reactive `Array.findLast`"
- },
- {
- "name": "useArrayIncludes",
- "package": "shared",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/shared/useArrayIncludes/",
- "category": "Array",
- "description": "reactive `Array.includes`"
- },
- {
- "name": "useArrayJoin",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/useArrayJoin/",
- "category": "Array",
- "description": "reactive `Array.join`"
- },
- {
- "name": "useArrayMap",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/useArrayMap/",
- "category": "Array",
- "description": "reactive `Array.map`"
- },
- {
- "name": "useArrayReduce",
- "package": "shared",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/shared/useArrayReduce/",
- "category": "Array",
- "description": "reactive `Array.reduce`"
- },
- {
- "name": "useArraySome",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/useArraySome/",
- "category": "Array",
- "description": "reactive `Array.some`"
- },
- {
- "name": "useArrayUnique",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/useArrayUnique/",
- "category": "Array",
- "description": "reactive unique array"
- },
- {
- "name": "useAsyncQueue",
- "package": "core",
- "lastUpdated": 1764121112e3,
- "docs": "https://vueuse.org/core/useAsyncQueue/",
- "category": "Utilities",
- "description": "executes each asynchronous task sequentially and passes the current task result to the next task"
- },
- {
- "name": "useAsyncState",
- "package": "core",
- "lastUpdated": 1766198217e3,
- "docs": "https://vueuse.org/core/useAsyncState/",
- "category": "State",
- "description": "reactive async state"
- },
- {
- "name": "useAsyncValidator",
- "package": "integrations",
- "lastUpdated": 1741147666e3,
- "component": true,
- "docs": "https://vueuse.org/integrations/useAsyncValidator/",
- "category": "@Integrations",
- "description": "wrapper for [`async-validator`](https://github.com/yiminghe/async-validator)",
- "importPath": "integrations/useAsyncValidator"
- },
- {
- "name": "useAuth",
- "package": "firebase",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/firebase/useAuth/",
- "category": "@Firebase",
- "description": "reactive [Firebase Auth](https://firebase.google.com/docs/auth) binding",
- "importPath": "firebase/useAuth"
- },
- {
- "name": "useAverage",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/useAverage/",
- "category": "@Math",
- "description": "get the average of an array reactively"
- },
- {
- "name": "useAxios",
- "package": "integrations",
- "lastUpdated": 1773022965e3,
- "docs": "https://vueuse.org/integrations/useAxios/",
- "category": "@Integrations",
- "description": "wrapper for [`axios`](https://github.com/axios/axios)",
- "importPath": "integrations/useAxios"
- },
- {
- "name": "useBase64",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/core/useBase64/",
- "category": "Utilities",
- "description": "reactive base64 transforming"
- },
- {
- "name": "useBattery",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useBattery/",
- "category": "Sensors",
- "description": "reactive [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery_Status_API)"
- },
- {
- "name": "useBluetooth",
- "package": "core",
- "lastUpdated": 1788237761e3,
- "docs": "https://vueuse.org/core/useBluetooth/",
- "category": "Browser",
- "description": "reactive [Web Bluetooth API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Bluetooth_API)"
- },
- {
- "name": "useBreakpoints",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useBreakpoints/",
- "category": "Browser",
- "description": "reactive viewport breakpoints"
- },
- {
- "name": "useBroadcastChannel",
- "package": "core",
- "lastUpdated": 1772346044e3,
- "docs": "https://vueuse.org/core/useBroadcastChannel/",
- "category": "Browser",
- "description": "reactive [BroadcastChannel API](https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel)"
- },
- {
- "name": "useBrowserLocation",
- "package": "core",
- "lastUpdated": 1780588689e3,
- "component": true,
- "docs": "https://vueuse.org/core/useBrowserLocation/",
- "category": "Browser",
- "description": "reactive browser location"
- },
- {
- "name": "useCached",
- "package": "core",
- "lastUpdated": 1777274138e3,
- "docs": "https://vueuse.org/core/useCached/",
- "category": "Utilities",
- "description": "cache a ref with a custom comparator"
- },
- {
- "name": "useCeil",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/useCeil/",
- "category": "@Math",
- "description": "reactive `Math.ceil`"
- },
- {
- "name": "useChangeCase",
- "package": "integrations",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/integrations/useChangeCase/",
- "category": "@Integrations",
- "description": "reactive wrapper for [`change-case`](https://github.com/blakeembrey/change-case)",
- "importPath": "integrations/useChangeCase"
- },
- {
- "name": "useClamp",
- "package": "math",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/math/useClamp/",
- "category": "@Math",
- "description": "reactively clamp a value between two other values"
- },
- {
- "name": "useClipboard",
- "package": "core",
- "lastUpdated": 1788334595e3,
- "component": true,
- "docs": "https://vueuse.org/core/useClipboard/",
- "category": "Browser",
- "description": "reactive [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API)",
- "related": ["useClipboardItems"]
- },
- {
- "name": "useClipboardItems",
- "package": "core",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/core/useClipboardItems/",
- "category": "Browser",
- "description": "reactive [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API)",
- "related": ["useClipboard"]
- },
- {
- "name": "useCloned",
- "package": "core",
- "lastUpdated": 1785373764e3,
- "docs": "https://vueuse.org/core/useCloned/",
- "category": "Utilities",
- "description": "reactive clone of a ref"
- },
- {
- "name": "useColorMode",
- "package": "core",
- "lastUpdated": 1751427119e3,
- "component": true,
- "docs": "https://vueuse.org/core/useColorMode/",
- "category": "Browser",
- "description": "reactive color mode (dark / light / customs) with auto data persistence",
- "related": [
- "useDark",
- "usePreferredDark",
- "useStorage"
- ]
- },
- {
- "name": "useConfirmDialog",
- "package": "core",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/core/useConfirmDialog/",
- "category": "Utilities",
- "description": "creates event hooks to support modals and confirmation dialog chains"
- },
- {
- "name": "useCookies",
- "package": "integrations",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/integrations/useCookies/",
- "category": "@Integrations",
- "description": "wrapper for [`universal-cookie`](https://www.npmjs.com/package/universal-cookie)",
- "importPath": "integrations/useCookies"
- },
- {
- "name": "useCountdown",
- "package": "core",
- "lastUpdated": 1786459659e3,
- "docs": "https://vueuse.org/core/useCountdown/",
- "category": "Time",
- "description": "reactive countdown timer in seconds"
- },
- {
- "name": "useCounter",
- "package": "shared",
- "lastUpdated": 1744088337e3,
- "docs": "https://vueuse.org/shared/useCounter/",
- "category": "Utilities",
- "description": "basic counter with utility functions"
- },
- {
- "name": "useCssSupports",
- "package": "core",
- "lastUpdated": 1770702885e3,
- "docs": "https://vueuse.org/core/useCssSupports/",
- "category": "Browser",
- "description": "SSR compatible and reactive [`CSS.supports`](https://developer.mozilla.org/docs/Web/API/CSS/supports_static)"
- },
- {
- "name": "useCssVar",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/core/useCssVar/",
- "category": "Browser",
- "description": "manipulate CSS variables"
- },
- {
- "name": "useCurrentElement",
- "package": "core",
- "lastUpdated": 1735017005e3,
- "docs": "https://vueuse.org/core/useCurrentElement/",
- "category": "Component",
- "description": "get the DOM element of current component as a ref"
- },
- {
- "name": "useCycleList",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/core/useCycleList/",
- "category": "Utilities",
- "description": "cycle through a list of items"
- },
- {
- "name": "useDark",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useDark/",
- "category": "Browser",
- "description": "reactive dark mode with auto data persistence",
- "related": [
- "useColorMode",
- "usePreferredDark",
- "useStorage"
- ]
- },
- {
- "name": "useDateFormat",
- "package": "shared",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/shared/useDateFormat/",
- "category": "Time",
- "description": "get the formatted date according to the string of tokens passed in"
- },
- {
- "name": "useDebouncedRefHistory",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/core/useDebouncedRefHistory/",
- "category": "State",
- "description": "shorthand for `useRefHistory` with debounced filter",
- "related": ["useRefHistory", "useThrottledRefHistory"]
- },
- {
- "name": "useDebounceFn",
- "package": "shared",
- "lastUpdated": 1780476462e3,
- "docs": "https://vueuse.org/shared/useDebounceFn/",
- "category": "Utilities",
- "description": "debounce execution of a function",
- "related": ["useThrottleFn"]
- },
- {
- "name": "useDeviceMotion",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useDeviceMotion/",
- "category": "Sensors",
- "description": "reactive [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent)"
- },
- {
- "name": "useDeviceOrientation",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useDeviceOrientation/",
- "category": "Sensors",
- "description": "reactive [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent)"
- },
- {
- "name": "useDevicePixelRatio",
- "package": "core",
- "lastUpdated": 1774958324e3,
- "component": true,
- "docs": "https://vueuse.org/core/useDevicePixelRatio/",
- "category": "Sensors",
- "description": "reactively track [`window.devicePixelRatio`](https://developer.mozilla.org/docs/Web/API/Window/devicePixelRatio)"
- },
- {
- "name": "useDevicesList",
- "package": "core",
- "lastUpdated": 1772346044e3,
- "component": true,
- "docs": "https://vueuse.org/core/useDevicesList/",
- "category": "Sensors",
- "description": "reactive [enumerateDevices](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/enumerateDevices) listing available input/output devices",
- "related": ["useUserMedia"]
- },
- {
- "name": "useDisplayMedia",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useDisplayMedia/",
- "category": "Sensors",
- "description": "reactive [`mediaDevices.getDisplayMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia) streaming",
- "related": ["useUserMedia"]
- },
- {
- "name": "useDocumentVisibility",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useDocumentVisibility/",
- "category": "Elements",
- "description": "reactively track [`document.visibilityState`](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState)"
- },
- {
- "name": "useDraggable",
- "package": "core",
- "lastUpdated": 1785249498e3,
- "component": true,
- "docs": "https://vueuse.org/core/useDraggable/",
- "category": "Elements",
- "description": "make elements draggable"
- },
- {
- "name": "useDrauu",
- "package": "integrations",
- "lastUpdated": 1739701304e3,
- "docs": "https://vueuse.org/integrations/useDrauu/",
- "category": "@Integrations",
- "description": "reactive instance for [drauu](https://github.com/antfu/drauu)",
- "importPath": "integrations/useDrauu"
- },
- {
- "name": "useDropZone",
- "package": "core",
- "lastUpdated": 1764121826e3,
- "docs": "https://vueuse.org/core/useDropZone/",
- "category": "Elements",
- "description": "create a zone where files can be dropped"
- },
- {
- "name": "useElementBounding",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "directive": true,
- "docs": "https://vueuse.org/core/useElementBounding/",
- "category": "Elements",
- "description": "reactive [bounding box](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect) of an HTML element"
- },
- {
- "name": "useElementByPoint",
- "package": "core",
- "lastUpdated": 1786459659e3,
- "docs": "https://vueuse.org/core/useElementByPoint/",
- "category": "Sensors",
- "description": "reactive element by point"
- },
- {
- "name": "useElementHover",
- "package": "core",
- "lastUpdated": 1750320219e3,
- "directive": true,
- "docs": "https://vueuse.org/core/useElementHover/",
- "category": "Sensors",
- "description": "reactive element's hover state"
- },
- {
- "name": "useElementOverflow",
- "package": "core",
- "lastUpdated": 178306584e4,
- "component": true,
- "directive": true,
- "docs": "https://vueuse.org/core/useElementOverflow/",
- "category": "Elements",
- "description": "reactive element's overflow state"
- },
- {
- "name": "useElementSize",
- "package": "core",
- "lastUpdated": 1785249471e3,
- "component": true,
- "directive": true,
- "docs": "https://vueuse.org/core/useElementSize/",
- "category": "Elements",
- "description": "reactive size of an HTML element"
- },
- {
- "package": "motion",
- "category": "@Motion",
- "name": "useElementStyle",
- "description": "sync a reactive object to a target element CSS styling",
- "external": "https://motion.vueuse.org/api/use-element-style"
- },
- {
- "package": "motion",
- "category": "@Motion",
- "name": "useElementTransform",
- "description": "sync a reactive object to a target element CSS transform.",
- "external": "https://motion.vueuse.org/api/use-element-transform"
- },
- {
- "name": "useElementVisibility",
- "package": "core",
- "lastUpdated": 1773650113e3,
- "component": true,
- "directive": true,
- "docs": "https://vueuse.org/core/useElementVisibility/",
- "category": "Elements",
- "description": "tracks the visibility of an element within the viewport"
- },
- {
- "name": "useEventBus",
- "package": "core",
- "lastUpdated": 1784996771e3,
- "docs": "https://vueuse.org/core/useEventBus/",
- "category": "Utilities",
- "description": "a basic event bus"
- },
- {
- "name": "useEventListener",
- "package": "core",
- "lastUpdated": 1767755257e3,
- "docs": "https://vueuse.org/core/useEventListener/",
- "category": "Browser",
- "description": "use EventListener with ease"
- },
- {
- "name": "useEventSource",
- "package": "core",
- "lastUpdated": 1787186305e3,
- "docs": "https://vueuse.org/core/useEventSource/",
- "category": "Network",
- "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"
- },
- {
- "name": "useExtractedObservable",
- "package": "rxjs",
- "lastUpdated": 1774958324e3,
- "docs": "https://vueuse.org/rxjs/useExtractedObservable/",
- "category": "@RxJS",
- "description": "use an RxJS [`Observable`](https://rxjs.dev/guide/observable) as extracted from one or more composables"
- },
- {
- "name": "useEyeDropper",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useEyeDropper/",
- "category": "Browser",
- "description": "reactive [EyeDropper API](https://developer.mozilla.org/en-US/docs/Web/API/EyeDropper_API)"
- },
- {
- "name": "useFavicon",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useFavicon/",
- "category": "Browser",
- "description": "reactive favicon"
- },
- {
- "name": "useFetch",
- "package": "core",
- "lastUpdated": 178658621e4,
- "docs": "https://vueuse.org/core/useFetch/",
- "category": "Network",
- "description": "reactive [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) provides the ability to abort requests"
- },
- {
- "name": "useFileDialog",
- "package": "core",
- "lastUpdated": 1774958324e3,
- "docs": "https://vueuse.org/core/useFileDialog/",
- "category": "Browser",
- "description": "open file dialog with ease"
- },
- {
- "name": "useFileSystemAccess",
- "package": "core",
- "lastUpdated": 1770013115e3,
- "docs": "https://vueuse.org/core/useFileSystemAccess/",
- "category": "Browser",
- "description": "create and read and write local files with [FileSystemAccessAPI](https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API)"
- },
- {
- "name": "useFirestore",
- "package": "firebase",
- "lastUpdated": 1767755257e3,
- "docs": "https://vueuse.org/firebase/useFirestore/",
- "category": "@Firebase",
- "description": "reactive [Firestore](https://firebase.google.com/docs/firestore) binding",
- "importPath": "firebase/useFirestore"
- },
- {
- "name": "useFloor",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/useFloor/",
- "category": "@Math",
- "description": "reactive `Math.floor`"
- },
- {
- "name": "useFocus",
- "package": "core",
- "lastUpdated": 1739701304e3,
- "docs": "https://vueuse.org/core/useFocus/",
- "category": "Sensors",
- "description": "reactive utility to track or set the focus state of a DOM element"
- },
- {
- "name": "useFocusTrap",
- "package": "integrations",
- "lastUpdated": 177760015e4,
- "component": true,
- "docs": "https://vueuse.org/integrations/useFocusTrap/",
- "category": "@Integrations",
- "description": "reactive wrapper for [`focus-trap`](https://github.com/focus-trap/focus-trap)",
- "importPath": "integrations/useFocusTrap"
- },
- {
- "name": "useFocusWithin",
- "package": "core",
- "lastUpdated": 1739600241e3,
- "docs": "https://vueuse.org/core/useFocusWithin/",
- "category": "Sensors",
- "description": "reactive utility to track if an element or one of its descendants has focus"
- },
- {
- "name": "useFps",
- "package": "core",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/core/useFps/",
- "category": "Sensors",
- "description": "reactive FPS (frames per second)"
- },
- {
- "name": "useFullscreen",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useFullscreen/",
- "category": "Browser",
- "description": "reactive [Fullscreen API](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API)"
- },
- {
- "name": "useFuse",
- "package": "integrations",
- "lastUpdated": 1782276566e3,
- "docs": "https://vueuse.org/integrations/useFuse/",
- "category": "@Integrations",
- "description": "easily implement fuzzy search using a composable with [Fuse.js](https://github.com/krisk/fuse)",
- "importPath": "integrations/useFuse"
- },
- {
- "name": "useGamepad",
- "package": "core",
- "lastUpdated": 1783938004e3,
- "docs": "https://vueuse.org/core/useGamepad/",
- "category": "Browser",
- "description": "provides reactive bindings for the [Gamepad API](https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API)"
- },
- {
- "name": "useGeolocation",
- "package": "core",
- "lastUpdated": 1772346044e3,
- "component": true,
- "docs": "https://vueuse.org/core/useGeolocation/",
- "category": "Sensors",
- "description": "reactive [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API)"
- },
- {
- "name": "useHead",
- "package": "head",
- "description": "update head meta tags reactively.",
- "category": "@Head",
- "external": "https://github.com/vueuse/head#api"
- },
- {
- "name": "useIDBKeyval",
- "package": "integrations",
- "lastUpdated": 178635772e4,
- "docs": "https://vueuse.org/integrations/useIDBKeyval/",
- "category": "@Integrations",
- "description": "wrapper for [`idb-keyval`](https://www.npmjs.com/package/idb-keyval)",
- "importPath": "integrations/useIDBKeyval"
- },
- {
- "name": "useIdle",
- "package": "core",
- "lastUpdated": 1761115389e3,
- "component": true,
- "docs": "https://vueuse.org/core/useIdle/",
- "category": "Sensors",
- "description": "tracks whether the user is being inactive"
- },
- {
- "name": "useImage",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useImage/",
- "category": "Browser",
- "description": "reactive load an image in the browser"
- },
- {
- "name": "useInfiniteScroll",
- "package": "core",
- "lastUpdated": 1772346044e3,
- "directive": true,
- "docs": "https://vueuse.org/core/useInfiniteScroll/",
- "category": "Sensors",
- "description": "infinite scrolling of the element"
- },
- {
- "name": "useIntersectionObserver",
- "package": "core",
- "lastUpdated": 1783111363e3,
- "directive": true,
- "docs": "https://vueuse.org/core/useIntersectionObserver/",
- "category": "Elements",
- "description": "detects changes to a target element's visibility"
- },
- {
- "name": "useInterval",
- "package": "shared",
- "lastUpdated": 1744088337e3,
- "docs": "https://vueuse.org/shared/useInterval/",
- "category": "Animation",
- "description": "reactive counter that increases on every interval"
- },
- {
- "name": "useIntervalFn",
- "package": "shared",
- "lastUpdated": 1748328969e3,
- "docs": "https://vueuse.org/shared/useIntervalFn/",
- "category": "Animation",
- "description": "wrapper for `setInterval` with controls"
- },
- {
- "name": "useIpcRenderer",
- "package": "electron",
- "lastUpdated": 1739701304e3,
- "docs": "https://vueuse.org/electron/useIpcRenderer/",
- "category": "@Electron",
- "description": "provides [ipcRenderer](https://www.electronjs.org/docs/api/ipc-renderer) and all of its APIs with Vue reactivity"
- },
- {
- "name": "useIpcRendererInvoke",
- "package": "electron",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/electron/useIpcRendererInvoke/",
- "category": "@Electron",
- "description": "reactive [ipcRenderer.invoke API](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args) result"
- },
- {
- "name": "useIpcRendererOn",
- "package": "electron",
- "lastUpdated": 1726477425e3,
- "docs": "https://vueuse.org/electron/useIpcRendererOn/",
- "category": "@Electron",
- "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"
- },
- {
- "name": "useJwt",
- "package": "integrations",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/integrations/useJwt/",
- "category": "@Integrations",
- "description": "wrapper for [`jwt-decode`](https://github.com/auth0/jwt-decode)",
- "importPath": "integrations/useJwt"
- },
- {
- "name": "useKeyModifier",
- "package": "core",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/core/useKeyModifier/",
- "category": "Sensors",
- "description": "reactive [Modifier State](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/getModifierState)"
- },
- {
- "name": "useLastChanged",
- "package": "shared",
- "lastUpdated": 1744088337e3,
- "docs": "https://vueuse.org/shared/useLastChanged/",
- "category": "State",
- "description": "records the timestamp of the last change"
- },
- {
- "name": "useLiveAnnouncer",
- "package": "core",
- "lastUpdated": 1786587985e3,
- "docs": "https://vueuse.org/core/useLiveAnnouncer/",
- "category": "Browser",
- "description": "accessible way to announce messages to screen reader users (ARIA live regions)"
- },
- {
- "name": "useLocalStorage",
- "package": "core",
- "lastUpdated": 1753513037e3,
- "docs": "https://vueuse.org/core/useLocalStorage/",
- "category": "State",
- "description": "reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)",
- "related": ["useStorage"]
- },
- {
- "name": "useMagicKeys",
- "package": "core",
- "lastUpdated": 1769007613e3,
- "docs": "https://vueuse.org/core/useMagicKeys/",
- "category": "Sensors",
- "description": "reactive keys pressed state"
- },
- {
- "name": "useManualRefHistory",
- "package": "core",
- "lastUpdated": 1774958324e3,
- "docs": "https://vueuse.org/core/useManualRefHistory/",
- "category": "State",
- "description": "manually track the change history of a ref when the user calls `commit()`",
- "related": ["useRefHistory"]
- },
- {
- "name": "useMath",
- "package": "math",
- "lastUpdated": 1758032498e3,
- "docs": "https://vueuse.org/math/useMath/",
- "category": "@Math",
- "description": "reactive `Math` methods"
- },
- {
- "name": "useMax",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/useMax/",
- "category": "@Math",
- "description": "reactive `Math.max`"
- },
- {
- "name": "useMediaControls",
- "package": "core",
- "lastUpdated": 1772346044e3,
- "docs": "https://vueuse.org/core/useMediaControls/",
- "category": "Browser",
- "description": "reactive media controls for both `audio` and `video` elements"
- },
- {
- "name": "useMediaQuery",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/core/useMediaQuery/",
- "category": "Browser",
- "description": "reactive [Media Query](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Testing_media_queries)"
- },
- {
- "name": "useMemoize",
- "package": "core",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/core/useMemoize/",
- "category": "Utilities",
- "description": "cache results of functions depending on arguments and keep it reactive"
- },
- {
- "name": "useMemory",
- "package": "core",
- "lastUpdated": 1786459659e3,
- "docs": "https://vueuse.org/core/useMemory/",
- "category": "Browser",
- "description": "reactive Memory Info"
- },
- {
- "name": "useMin",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/useMin/",
- "category": "@Math",
- "description": "reactive `Math.min`"
- },
- {
- "package": "motion",
- "category": "@Motion",
- "name": "useMotion",
- "description": "putting your components in motion.",
- "external": "https://motion.vueuse.org/api/use-motion"
- },
- {
- "package": "motion",
- "category": "@Motion",
- "name": "useMotionProperties",
- "description": "access Motion Properties for a target element.",
- "external": "https://motion.vueuse.org/api/use-motion-properties"
- },
- {
- "package": "motion",
- "category": "@Motion",
- "name": "useMotionVariants",
- "description": "handle the Variants state and selection.",
- "external": "https://motion.vueuse.org/api/use-motion-variants"
- },
- {
- "name": "useMounted",
- "package": "core",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/core/useMounted/",
- "category": "Component",
- "description": "mounted state in ref"
- },
- {
- "name": "useMouse",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useMouse/",
- "category": "Sensors",
- "description": "reactive mouse position"
- },
- {
- "name": "useMouseInElement",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "directive": true,
- "docs": "https://vueuse.org/core/useMouseInElement/",
- "category": "Elements",
- "description": "reactive mouse position related to an element"
- },
- {
- "name": "useMousePressed",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useMousePressed/",
- "category": "Sensors",
- "description": "reactive mouse pressing state"
- },
- {
- "name": "useMutationObserver",
- "package": "core",
- "lastUpdated": 1783111363e3,
- "docs": "https://vueuse.org/core/useMutationObserver/",
- "category": "Elements",
- "description": "watch for changes being made to the DOM tree"
- },
- {
- "name": "useNavigatorLanguage",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useNavigatorLanguage/",
- "category": "Sensors",
- "description": "reactive [navigator.language](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language)"
- },
- {
- "name": "useNetwork",
- "package": "core",
- "lastUpdated": 1774958324e3,
- "component": true,
- "docs": "https://vueuse.org/core/useNetwork/",
- "category": "Sensors",
- "description": "reactive [Network status](https://developer.mozilla.org/en-US/docs/Web/API/Network_Information_API)"
- },
- {
- "name": "useNow",
- "package": "core",
- "lastUpdated": 1788334595e3,
- "component": true,
- "docs": "https://vueuse.org/core/useNow/",
- "category": "Animation",
- "description": "reactive current Date instance"
- },
- {
- "name": "useNProgress",
- "package": "integrations",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/integrations/useNProgress/",
- "category": "@Integrations",
- "description": "reactive wrapper for [`nprogress`](https://github.com/rstacruz/nprogress)",
- "importPath": "integrations/useNProgress"
- },
- {
- "name": "useObjectUrl",
- "package": "core",
- "lastUpdated": 1774958324e3,
- "component": true,
- "docs": "https://vueuse.org/core/useObjectUrl/",
- "category": "Browser",
- "description": "reactive URL representing an object"
- },
- {
- "name": "useObservable",
- "package": "rxjs",
- "lastUpdated": 1739600241e3,
- "docs": "https://vueuse.org/rxjs/useObservable/",
- "category": "@RxJS",
- "description": "use an RxJS [`Observable`](https://rxjs.dev/guide/observable)"
- },
- {
- "name": "useOffsetPagination",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "component": true,
- "docs": "https://vueuse.org/core/useOffsetPagination/",
- "category": "Utilities",
- "description": "reactive offset pagination"
- },
- {
- "name": "useOnline",
- "package": "core",
- "lastUpdated": 175367704e4,
- "component": true,
- "docs": "https://vueuse.org/core/useOnline/",
- "category": "Sensors",
- "description": "reactive online state"
- },
- {
- "name": "usePageLeave",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/usePageLeave/",
- "category": "Sensors",
- "description": "reactive state to show whether the mouse leaves the page"
- },
- {
- "name": "useParallax",
- "package": "core",
- "lastUpdated": 1776327185e3,
- "docs": "https://vueuse.org/core/useParallax/",
- "category": "Sensors",
- "description": "create parallax effect easily"
- },
- {
- "name": "useParentElement",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/core/useParentElement/",
- "category": "Elements",
- "description": "get parent element of the given element"
- },
- {
- "name": "usePerformanceObserver",
- "package": "core",
- "lastUpdated": 1726477425e3,
- "docs": "https://vueuse.org/core/usePerformanceObserver/",
- "category": "Browser",
- "description": "observe performance metrics"
- },
- {
- "name": "usePermission",
- "package": "core",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/core/usePermission/",
- "category": "Browser",
- "description": "reactive [Permissions API](https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API)",
- "related": ["useUserMedia"]
- },
- {
- "name": "usePointer",
- "package": "core",
- "lastUpdated": 1787185874e3,
- "component": true,
- "docs": "https://vueuse.org/core/usePointer/",
- "category": "Sensors",
- "description": "reactive [pointer state](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_events)"
- },
- {
- "name": "usePointerLock",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/usePointerLock/",
- "category": "Sensors",
- "description": "reactive [pointer lock](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API)"
- },
- {
- "name": "usePointerSwipe",
- "package": "core",
- "lastUpdated": 1780064273e3,
- "docs": "https://vueuse.org/core/usePointerSwipe/",
- "category": "Sensors",
- "description": "reactive swipe detection based on [PointerEvents](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent)"
- },
- {
- "name": "usePrecision",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/usePrecision/",
- "category": "@Math",
- "description": "reactively set the precision of a number"
- },
- {
- "name": "usePreferredColorScheme",
- "package": "core",
- "lastUpdated": 175367704e4,
- "component": true,
- "docs": "https://vueuse.org/core/usePreferredColorScheme/",
- "category": "Browser",
- "description": "reactive [prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) media query"
- },
- {
- "name": "usePreferredContrast",
- "package": "core",
- "lastUpdated": 175367704e4,
- "component": true,
- "docs": "https://vueuse.org/core/usePreferredContrast/",
- "category": "Browser",
- "description": "reactive [prefers-contrast](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-contrast) media query"
- },
- {
- "name": "usePreferredDark",
- "package": "core",
- "lastUpdated": 175367704e4,
- "component": true,
- "docs": "https://vueuse.org/core/usePreferredDark/",
- "category": "Browser",
- "description": "reactive dark theme preference",
- "related": ["useColorMode", "useDark"]
- },
- {
- "name": "usePreferredLanguages",
- "package": "core",
- "lastUpdated": 1755561737e3,
- "component": true,
- "docs": "https://vueuse.org/core/usePreferredLanguages/",
- "category": "Browser",
- "description": "reactive [Navigator Languages](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorLanguage/languages)"
- },
- {
- "name": "usePreferredReducedMotion",
- "package": "core",
- "lastUpdated": 175367704e4,
- "component": true,
- "docs": "https://vueuse.org/core/usePreferredReducedMotion/",
- "category": "Browser",
- "description": "reactive [prefers-reduced-motion](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion) media query"
- },
- {
- "name": "usePreferredReducedTransparency",
- "package": "core",
- "lastUpdated": 175367704e4,
- "component": true,
- "docs": "https://vueuse.org/core/usePreferredReducedTransparency/",
- "category": "Browser",
- "description": "reactive [prefers-reduced-transparency](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-transparency) media query"
- },
- {
- "name": "usePrevious",
- "package": "core",
- "lastUpdated": 1774958324e3,
- "docs": "https://vueuse.org/core/usePrevious/",
- "category": "Utilities",
- "description": "holds the previous value of a ref"
- },
- {
- "name": "useProjection",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/useProjection/",
- "category": "@Math",
- "description": "reactive numeric projection from one domain to another",
- "related": ["createGenericProjection", "createProjection"]
- },
- {
- "name": "useQRCode",
- "package": "integrations",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/integrations/useQRCode/",
- "category": "@Integrations",
- "description": "wrapper for [`qrcode`](https://github.com/soldair/node-qrcode)",
- "importPath": "integrations/useQRCode"
- },
- {
- "name": "useRafFn",
- "package": "core",
- "lastUpdated": 1774958324e3,
- "docs": "https://vueuse.org/core/useRafFn/",
- "category": "Animation",
- "description": "call function on every `requestAnimationFrame`"
- },
- {
- "name": "useRefHistory",
- "package": "core",
- "lastUpdated": 1767923245e3,
- "docs": "https://vueuse.org/core/useRefHistory/",
- "category": "State",
- "description": "track the change history of a ref",
- "related": [
- "useDebouncedRefHistory",
- "useManualRefHistory",
- "useThrottledRefHistory"
- ]
- },
- {
- "name": "useResizeObserver",
- "package": "core",
- "lastUpdated": 1789422677e3,
- "directive": true,
- "docs": "https://vueuse.org/core/useResizeObserver/",
- "category": "Elements",
- "description": "reports changes to the dimensions of an Element's content or the border-box"
- },
- {
- "name": "useRound",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/useRound/",
- "category": "@Math",
- "description": "reactive `Math.round`"
- },
- {
- "name": "useRouteHash",
- "package": "router",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/router/useRouteHash/",
- "category": "@Router",
- "description": "shorthand for a reactive `route.hash`"
- },
- {
- "name": "useRouteParams",
- "package": "router",
- "lastUpdated": 1767755257e3,
- "docs": "https://vueuse.org/router/useRouteParams/",
- "category": "@Router",
- "description": "shorthand for a reactive `route.params`"
- },
- {
- "name": "useRouteQuery",
- "package": "router",
- "lastUpdated": 1767755257e3,
- "docs": "https://vueuse.org/router/useRouteQuery/",
- "category": "@Router",
- "description": "shorthand for a reactive `route.query`"
- },
- {
- "name": "useRTDB",
- "package": "firebase",
- "lastUpdated": 1739600241e3,
- "docs": "https://vueuse.org/firebase/useRTDB/",
- "category": "@Firebase",
- "description": "reactive [Firebase Realtime Database](https://firebase.google.com/docs/database) binding",
- "importPath": "firebase/useRTDB"
- },
- {
- "name": "useSchemaOrg",
- "package": "schema-org",
- "description": "update schema.org reactively.",
- "category": "@SchemaOrg",
- "external": "https://vue-schema-org.netlify.app/api/core/use-schema-org.html"
- },
- {
- "name": "useScreenOrientation",
- "package": "core",
- "lastUpdated": 1772346044e3,
- "docs": "https://vueuse.org/core/useScreenOrientation/",
- "category": "Browser",
- "description": "reactive [Screen Orientation API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Orientation_API)"
- },
- {
- "name": "useScreenSafeArea",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useScreenSafeArea/",
- "category": "Browser",
- "description": "reactive `env(safe-area-inset-*)`"
- },
- {
- "name": "useScriptTag",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useScriptTag/",
- "category": "Browser",
- "description": "creates a script tag"
- },
- {
- "name": "useScroll",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "directive": true,
- "docs": "https://vueuse.org/core/useScroll/",
- "category": "Sensors",
- "description": "reactive scroll position and state"
- },
- {
- "name": "useScrollLock",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "directive": true,
- "docs": "https://vueuse.org/core/useScrollLock/",
- "category": "Sensors",
- "description": "lock scrolling of the element"
- },
- {
- "name": "useSessionStorage",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/core/useSessionStorage/",
- "category": "State",
- "description": "reactive [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)",
- "related": ["useStorage"]
- },
- {
- "name": "useShare",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useShare/",
- "category": "Browser",
- "description": "reactive [Web Share API](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/share)"
- },
- {
- "name": "useSortable",
- "package": "integrations",
- "lastUpdated": 1776996687e3,
- "component": true,
- "docs": "https://vueuse.org/integrations/useSortable/",
- "category": "@Integrations",
- "description": "wrapper for [`sortable`](https://github.com/SortableJS/Sortable)",
- "importPath": "integrations/useSortable"
- },
- {
- "name": "useSorted",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/core/useSorted/",
- "category": "Array",
- "description": "reactive sort array"
- },
- {
- "name": "useSound",
- "package": "sound",
- "description": "play sound effects reactively.",
- "category": "@Sound",
- "external": "https://github.com/vueuse/sound#examples"
- },
- {
- "name": "useSpeechRecognition",
- "package": "core",
- "lastUpdated": 1779372159e3,
- "docs": "https://vueuse.org/core/useSpeechRecognition/",
- "category": "Sensors",
- "description": "reactive [SpeechRecognition](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition)"
- },
- {
- "name": "useSpeechSynthesis",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useSpeechSynthesis/",
- "category": "Sensors",
- "description": "reactive [SpeechSynthesis](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis)"
- },
- {
- "package": "motion",
- "category": "@Motion",
- "name": "useSpring",
- "description": "spring animations.",
- "external": "https://motion.vueuse.org/api/use-spring"
- },
- {
- "name": "useSSRWidth",
- "package": "core",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/core/useSSRWidth/",
- "category": "Browser",
- "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)"
- },
- {
- "name": "useStepper",
- "package": "core",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/core/useStepper/",
- "category": "Utilities",
- "description": "provides helpers for building a multi-step wizard interface"
- },
- {
- "name": "useStorage",
- "package": "core",
- "lastUpdated": 1767755257e3,
- "docs": "https://vueuse.org/core/useStorage/",
- "category": "State",
- "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)",
- "related": [
- "useColorMode",
- "useDark",
- "useLocalStorage",
- "useSessionStorage",
- "useStorageAsync"
- ]
- },
- {
- "name": "useStorageAsync",
- "package": "core",
- "lastUpdated": 177435705e4,
- "docs": "https://vueuse.org/core/useStorageAsync/",
- "category": "State",
- "description": "reactive Storage with async support",
- "related": ["useStorage"]
- },
- {
- "name": "useStyleTag",
- "package": "core",
- "lastUpdated": 1780469574e3,
- "docs": "https://vueuse.org/core/useStyleTag/",
- "category": "Browser",
- "description": "inject reactive `style` element in head"
- },
- {
- "name": "useSubject",
- "package": "rxjs",
- "lastUpdated": 1739600241e3,
- "docs": "https://vueuse.org/rxjs/useSubject/",
- "category": "@RxJS",
- "description": "bind an RxJS [`Subject`](https://rxjs.dev/guide/subject) to a `ref` and propagate value changes both ways"
- },
- {
- "name": "useSubscription",
- "package": "rxjs",
- "lastUpdated": 1628521945e3,
- "docs": "https://vueuse.org/rxjs/useSubscription/",
- "category": "@RxJS",
- "description": "use an RxJS [`Subscription`](https://rxjs.dev/guide/subscription) without worrying about unsubscribing from it or creating memory leaks"
- },
- {
- "name": "useSum",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/useSum/",
- "category": "@Math",
- "description": "get the sum of an array reactively"
- },
- {
- "name": "useSupported",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useSupported/",
- "category": "Utilities",
- "description": "SSR compatibility `isSupported`"
- },
- {
- "name": "useSwipe",
- "package": "core",
- "lastUpdated": 1756733202e3,
- "docs": "https://vueuse.org/core/useSwipe/",
- "category": "Sensors",
- "description": "reactive swipe detection based on [`TouchEvents`](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent)"
- },
- {
- "name": "useTemplateRefsList",
- "package": "core",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/core/useTemplateRefsList/",
- "category": "Component",
- "description": "shorthand for binding refs to template elements and components inside `v-for`"
- },
- {
- "name": "useTemporalNow",
- "package": "core",
- "lastUpdated": 1787190565e3,
- "docs": "https://vueuse.org/core/useTemporalNow/",
- "category": "Time",
- "description": "reactive [Temporal API](https://tc39.es/proposal-temporal/docs/) with timezone conversion and calendar system support"
- },
- {
- "name": "useTextareaAutosize",
- "package": "core",
- "lastUpdated": 1777371147e3,
- "docs": "https://vueuse.org/core/useTextareaAutosize/",
- "category": "Browser",
- "description": "automatically update the height of a textarea depending on the content"
- },
- {
- "name": "useTextDirection",
- "package": "core",
- "lastUpdated": 1772346044e3,
- "docs": "https://vueuse.org/core/useTextDirection/",
- "category": "Browser",
- "description": "reactive [dir](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) of the element's text"
- },
- {
- "name": "useTextSelection",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useTextSelection/",
- "category": "Sensors",
- "description": "reactively track user text selection based on [`Window.getSelection`](https://developer.mozilla.org/en-US/docs/Web/API/Window/getSelection)"
- },
- {
- "name": "useThrottledRefHistory",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/core/useThrottledRefHistory/",
- "category": "State",
- "description": "shorthand for `useRefHistory` with throttled filter",
- "related": ["useDebouncedRefHistory", "useRefHistory"]
- },
- {
- "name": "useThrottleFn",
- "package": "shared",
- "lastUpdated": 1786182815e3,
- "docs": "https://vueuse.org/shared/useThrottleFn/",
- "category": "Utilities",
- "description": "throttle execution of a function",
- "related": [
- "refDebounced",
- "refThrottled",
- "useDebounceFn"
- ]
- },
- {
- "name": "useTimeAgo",
- "package": "core",
- "lastUpdated": 1788334595e3,
- "component": true,
- "docs": "https://vueuse.org/core/useTimeAgo/",
- "category": "Time",
- "description": "reactive time ago",
- "utils": ["formatTimeAgo"]
- },
- {
- "name": "useTimeAgoIntl",
- "package": "core",
- "lastUpdated": 1786459659e3,
- "docs": "https://vueuse.org/core/useTimeAgoIntl/",
- "category": "Time",
- "description": "reactive time ago with i18n supported",
- "utils": ["formatTimeAgoIntl"]
- },
- {
- "name": "useTimeout",
- "package": "shared",
- "lastUpdated": 1762306081e3,
- "docs": "https://vueuse.org/shared/useTimeout/",
- "category": "Animation",
- "description": "reactive value that becomes `true` after a given time"
- },
- {
- "name": "useTimeoutFn",
- "package": "shared",
- "lastUpdated": 1750320219e3,
- "docs": "https://vueuse.org/shared/useTimeoutFn/",
- "category": "Animation",
- "description": "wrapper for `setTimeout` with controls"
- },
- {
- "name": "useTimeoutPoll",
- "package": "core",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/core/useTimeoutPoll/",
- "category": "Utilities",
- "description": "use timeout to poll something"
- },
- {
- "name": "useTimestamp",
- "package": "core",
- "lastUpdated": 1786459659e3,
- "component": true,
- "docs": "https://vueuse.org/core/useTimestamp/",
- "category": "Animation",
- "description": "reactive current timestamp"
- },
- {
- "name": "useTitle",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useTitle/",
- "category": "Browser",
- "description": "reactive document title"
- },
- {
- "name": "useToggle",
- "package": "shared",
- "lastUpdated": 1756726434e3,
- "docs": "https://vueuse.org/shared/useToggle/",
- "category": "Utilities",
- "description": "a boolean switcher with utility functions"
- },
- {
- "name": "useToNumber",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/useToNumber/",
- "category": "Utilities",
- "description": "reactively convert a string ref to number"
- },
- {
- "name": "useToString",
- "package": "shared",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/shared/useToString/",
- "category": "Utilities",
- "description": "reactively convert a ref to string"
- },
- {
- "name": "useTransition",
- "package": "core",
- "lastUpdated": 1758205253e3,
- "docs": "https://vueuse.org/core/useTransition/",
- "category": "Animation",
- "description": "transition between values"
- },
- {
- "name": "useTrunc",
- "package": "math",
- "lastUpdated": 175367704e4,
- "docs": "https://vueuse.org/math/useTrunc/",
- "category": "@Math",
- "description": "reactive `Math.trunc`"
- },
- {
- "name": "useUrlSearchParams",
- "package": "core",
- "lastUpdated": 1764573571e3,
- "docs": "https://vueuse.org/core/useUrlSearchParams/",
- "category": "Browser",
- "description": "reactive [URLSearchParams](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams)"
- },
- {
- "name": "useUserMedia",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useUserMedia/",
- "category": "Sensors",
- "description": "reactive [`mediaDevices.getUserMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) streaming",
- "related": [
- "useDevicesList",
- "useDisplayMedia",
- "usePermission"
- ]
- },
- {
- "name": "useVibrate",
- "package": "core",
- "lastUpdated": 1786459659e3,
- "docs": "https://vueuse.org/core/useVibrate/",
- "category": "Browser",
- "description": "reactive [Vibration API](https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API)"
- },
- {
- "name": "useVirtualList",
- "package": "core",
- "lastUpdated": 1785249364e3,
- "component": true,
- "docs": "https://vueuse.org/core/useVirtualList/",
- "category": "Component",
- "description": "create virtual lists with ease"
- },
- {
- "name": "useVModel",
- "package": "core",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/core/useVModel/",
- "category": "Component",
- "description": "shorthand for v-model binding",
- "related": ["useVModels"]
- },
- {
- "name": "useVModels",
- "package": "core",
- "lastUpdated": 1788334595e3,
- "docs": "https://vueuse.org/core/useVModels/",
- "category": "Component",
- "description": "shorthand for props v-model binding",
- "related": ["useVModel"]
- },
- {
- "name": "useWakeLock",
- "package": "core",
- "lastUpdated": 1774956001e3,
- "docs": "https://vueuse.org/core/useWakeLock/",
- "category": "Browser",
- "description": "reactive [Screen Wake Lock API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API)"
- },
- {
- "name": "useWebMCP",
- "package": "core",
- "lastUpdated": 1788884805e3,
- "docs": "https://vueuse.org/core/useWebMCP/",
- "category": "Browser",
- "description": "register a [WebMCP](https://github.com/webmachinelearning/webmcp) tool and tie its lifecycle to the current Vue scope"
- },
- {
- "name": "useWebNotification",
- "package": "core",
- "lastUpdated": 1772346044e3,
- "docs": "https://vueuse.org/core/useWebNotification/",
- "category": "Browser",
- "description": "reactive [Notification](https://developer.mozilla.org/en-US/docs/Web/API/notification)"
- },
- {
- "name": "useWebSocket",
- "package": "core",
- "lastUpdated": 1786586231e3,
- "docs": "https://vueuse.org/core/useWebSocket/",
- "category": "Network",
- "description": "reactive [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket) client"
- },
- {
- "name": "useWebWorker",
- "package": "core",
- "lastUpdated": 1772346044e3,
- "docs": "https://vueuse.org/core/useWebWorker/",
- "category": "Browser",
- "description": "simple [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) registration and communication",
- "related": ["useWebWorkerFn"]
- },
- {
- "name": "useWebWorkerFn",
- "package": "core",
- "lastUpdated": 1776327185e3,
- "docs": "https://vueuse.org/core/useWebWorkerFn/",
- "category": "Browser",
- "description": "run expensive functions without blocking the UI",
- "related": ["useWebWorker"]
- },
- {
- "name": "useWindowFocus",
- "package": "core",
- "lastUpdated": 175367704e4,
- "component": true,
- "docs": "https://vueuse.org/core/useWindowFocus/",
- "category": "Elements",
- "description": "reactively track window focus with `window.onfocus` and `window.onblur` events"
- },
- {
- "name": "useWindowScroll",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "docs": "https://vueuse.org/core/useWindowScroll/",
- "category": "Elements",
- "description": "reactive window scroll"
- },
- {
- "name": "useWindowSize",
- "package": "core",
- "lastUpdated": 1770099476e3,
- "component": true,
- "docs": "https://vueuse.org/core/useWindowSize/",
- "category": "Elements",
- "description": "reactive window size"
- },
- {
- "name": "useZoomFactor",
- "package": "electron",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/electron/useZoomFactor/",
- "category": "@Electron",
- "description": "reactive [WebFrame](https://www.electronjs.org/docs/api/web-frame#webframe) zoom factor"
- },
- {
- "name": "useZoomLevel",
- "package": "electron",
- "lastUpdated": 1741147666e3,
- "docs": "https://vueuse.org/electron/useZoomLevel/",
- "category": "@Electron",
- "description": "reactive [WebFrame](https://www.electronjs.org/docs/api/web-frame#webframe) zoom level"
- },
- {
- "name": "utils",
- "package": "shared",
- "lastUpdated": 1741577867e3,
- "internal": true
- },
- {
- "name": "watchArray",
- "package": "shared",
- "lastUpdated": 1741159087e3,
- "docs": "https://vueuse.org/shared/watchArray/",
- "category": "Watch",
- "description": "watch for an array with additions and removals"
- },
- {
- "name": "watchAtMost",
- "package": "shared",
- "lastUpdated": 1770702904e3,
- "docs": "https://vueuse.org/shared/watchAtMost/",
- "category": "Watch",
- "description": "`watch` with the number of times triggered"
- },
- {
- "name": "watchDebounced",
- "package": "shared",
- "lastUpdated": 1770702904e3,
- "docs": "https://vueuse.org/shared/watchDebounced/",
- "category": "Watch",
- "description": "debounced watch",
- "alias": ["debouncedWatch"]
- },
- {
- "name": "watchDeep",
- "package": "shared",
- "lastUpdated": 1770702904e3,
- "docs": "https://vueuse.org/shared/watchDeep/",
- "category": "Watch",
- "description": "shorthand for watching value with `{deep: true}`"
- },
- {
- "name": "watchExtractedObservable",
- "package": "rxjs",
- "lastUpdated": 1767755257e3,
- "docs": "https://vueuse.org/rxjs/watchExtractedObservable/",
- "category": "@RxJS",
- "description": "watch the values of an RxJS [`Observable`](https://rxjs.dev/guide/observable) as extracted from one or more composables"
- },
- {
- "name": "watchIgnorable",
- "package": "shared",
- "lastUpdated": 1770702904e3,
- "docs": "https://vueuse.org/shared/watchIgnorable/",
- "category": "Watch",
- "description": "ignorable watch",
- "alias": ["ignorableWatch"]
- },
- {
- "name": "watchImmediate",
- "package": "shared",
- "lastUpdated": 1770702904e3,
- "docs": "https://vueuse.org/shared/watchImmediate/",
- "category": "Watch",
- "description": "shorthand for watching value with `{immediate: true}`"
- },
- {
- "name": "watchOnce",
- "package": "shared",
- "lastUpdated": 1770702904e3,
- "docs": "https://vueuse.org/shared/watchOnce/",
- "category": "Watch",
- "description": "shorthand for watching value with `{ once: true }`"
- },
- {
- "name": "watchPausable",
- "package": "shared",
- "lastUpdated": 1770702904e3,
- "docs": "https://vueuse.org/shared/watchPausable/",
- "category": "Watch",
- "description": "pausable watch",
- "alias": ["pausableWatch"]
- },
- {
- "name": "watchThrottled",
- "package": "shared",
- "lastUpdated": 1770702904e3,
- "docs": "https://vueuse.org/shared/watchThrottled/",
- "category": "Watch",
- "description": "throttled watch",
- "alias": ["throttledWatch"]
- },
- {
- "name": "watchTriggerable",
- "package": "shared",
- "lastUpdated": 1770702904e3,
- "docs": "https://vueuse.org/shared/watchTriggerable/",
- "category": "Watch",
- "description": "watch that can be triggered manually"
- },
- {
- "name": "watchWithFilter",
- "package": "shared",
- "lastUpdated": 1770702904e3,
- "docs": "https://vueuse.org/shared/watchWithFilter/",
- "category": "Watch",
- "description": "`watch` with additional EventFilter control"
- },
- {
- "name": "whenever",
- "package": "shared",
- "lastUpdated": 1770703383e3,
- "docs": "https://vueuse.org/shared/whenever/",
- "category": "Watch",
- "description": "shorthand for watching value to be truthy"
- }
- ];
- var metadata_default = {
- packages: packages$1,
- categories: categories$1,
- functions: functions$1
- };
- //#endregion
- //#region metadata.ts
- const categoriesOrder = [
- "State",
- "Elements",
- "Browser",
- "Sensors",
- "Network",
- "Animation",
- "Component",
- "Watch",
- "Reactivity",
- "Array",
- "Time",
- "Utilities"
- ];
- const metadata = metadata_default;
- const functions = functions$1;
- const packages = packages$1;
- const categories = categories$1;
- const functionNames = functions.map((f) => f.name);
- const categoryNames = Array.from(categories).sort((a, b) => categoriesOrder.indexOf(a) - categoriesOrder.indexOf(b)).sort((a, b) => a.startsWith("@") ? 1 : b.startsWith("@") ? -1 : 0);
- const coreCategoryNames = categoryNames.filter((f) => !f.startsWith("@"));
- const addonCategoryNames = categoryNames.filter((f) => f.startsWith("@"));
- function getFunction(name) {
- return metadata.functions.find((f) => f.name === name);
- }
- //#endregion
- //#region utils.ts
- function getCategories(functions) {
- 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));
- }
- function uniq(a) {
- return Array.from(new Set(a));
- }
- //#endregion
- export { addonCategoryNames, categories, categoryNames, coreCategoryNames, functionNames, functions, getCategories, getFunction, metadata, packages, uniq };
|