12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459 |
- 'use strict';
- 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>",
- external: [
- "@vueuse/core",
- "@vueuse/shared"
- ],
- dir: "packages/components"
- },
- math: {
- name: "math",
- display: "Math",
- description: "Math functions for VueUse",
- external: [
- "@vueuse/shared"
- ],
- 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",
- "@vueuse/core",
- "@vueuse/shared",
- "fuse.js",
- "async-validator"
- ],
- 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"
- },
- 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: 1661746302000,
- docs: "https://vueuse.org/core/computedAsync/",
- category: "Reactivity",
- description: "computed for async functions",
- alias: [
- "asyncComputed"
- ]
- },
- {
- name: "computedEager",
- "package": "shared",
- lastUpdated: 1645956777000,
- docs: "https://vueuse.org/shared/computedEager/",
- category: "Reactivity",
- description: "eager computed without lazy evaluation",
- alias: [
- "eagerComputed"
- ]
- },
- {
- name: "computedInject",
- "package": "core",
- lastUpdated: 1662388825000,
- docs: "https://vueuse.org/core/computedInject/",
- category: "Component",
- description: "combine computed and inject"
- },
- {
- name: "computedWithControl",
- "package": "shared",
- lastUpdated: 1657102664000,
- docs: "https://vueuse.org/shared/computedWithControl/",
- category: "Reactivity",
- description: "explicitly define the dependencies of computed",
- alias: [
- "controlledComputed"
- ],
- related: [
- "refWithControl"
- ]
- },
- {
- name: "createEventHook",
- "package": "shared",
- lastUpdated: 1621876156000,
- docs: "https://vueuse.org/shared/createEventHook/",
- category: "Utilities",
- description: "utility for creating event hooks"
- },
- {
- name: "createGenericProjection",
- "package": "math",
- lastUpdated: 1657437998000,
- docs: "https://vueuse.org/math/createGenericProjection/",
- category: "@Math",
- description: "generic version of `createProjection`",
- related: [
- "createProjection",
- "useProjection"
- ]
- },
- {
- name: "createGlobalState",
- "package": "shared",
- lastUpdated: 1625749207000,
- 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: 1648221687000,
- docs: "https://vueuse.org/shared/createInjectionState/",
- category: "State",
- description: "create global state that can be injected into components"
- },
- {
- name: "createProjection",
- "package": "math",
- lastUpdated: 1657437998000,
- docs: "https://vueuse.org/math/createProjection/",
- category: "@Math",
- description: "reactive numeric projection from one domain to another",
- related: [
- "createGenericProjection",
- "useProjection"
- ]
- },
- {
- 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: 1639442454000,
- docs: "https://vueuse.org/shared/createSharedComposable/",
- category: "State",
- description: "make a composable function usable with multiple Vue instances",
- related: [
- "createGlobalState"
- ]
- },
- {
- name: "createUnrefFn",
- "package": "core",
- lastUpdated: 1651597361000,
- 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: 1662892188000,
- docs: "https://vueuse.org/shared/extendRef/",
- category: "Reactivity",
- description: "add extra attributes to Ref"
- },
- {
- name: "from",
- "package": "rxjs",
- lastUpdated: 1665003343000,
- docs: "https://vueuse.org/rxjs/from/",
- category: "@RxJS",
- description: "/ fromEvent"
- },
- {
- name: "get",
- "package": "shared",
- lastUpdated: 1639442454000,
- docs: "https://vueuse.org/shared/get/",
- category: "Utilities",
- description: "shorthand for accessing `ref.value`"
- },
- {
- name: "isDefined",
- "package": "shared",
- lastUpdated: 1639442454000,
- docs: "https://vueuse.org/shared/isDefined/",
- category: "Utilities",
- description: "non-nullish checking type guard for Ref"
- },
- {
- name: "logicAnd",
- "package": "math",
- lastUpdated: 1657261466000,
- docs: "https://vueuse.org/math/logicAnd/",
- category: "@Math",
- description: "`AND` condition for refs",
- alias: [
- "and"
- ],
- related: [
- "logicNot",
- "logicOr"
- ]
- },
- {
- name: "logicNot",
- "package": "math",
- lastUpdated: 1657261466000,
- docs: "https://vueuse.org/math/logicNot/",
- category: "@Math",
- description: "`NOT` condition for ref",
- alias: [
- "not"
- ],
- related: [
- "logicAnd",
- "logicOr"
- ]
- },
- {
- name: "logicOr",
- "package": "math",
- lastUpdated: 1657261466000,
- docs: "https://vueuse.org/math/logicOr/",
- category: "@Math",
- description: "`OR` conditions for refs",
- alias: [
- "or"
- ],
- related: [
- "logicAnd",
- "logicNot"
- ]
- },
- {
- name: "makeDestructurable",
- "package": "shared",
- lastUpdated: 1662388825000,
- 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: 1663296141000,
- component: true,
- directive: true,
- docs: "https://vueuse.org/core/onClickOutside/",
- category: "Sensors",
- description: "listen for clicks outside of an element"
- },
- {
- name: "onKeyStroke",
- "package": "core",
- lastUpdated: 1663296067000,
- directive: true,
- docs: "https://vueuse.org/core/onKeyStroke/",
- category: "Sensors",
- description: "listen for keyboard key being stroked"
- },
- {
- name: "onLongPress",
- "package": "core",
- lastUpdated: 1661746302000,
- 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: 1639442454000,
- docs: "https://vueuse.org/core/onStartTyping/",
- category: "Sensors",
- description: "fires when users start typing on non-editable elements"
- },
- {
- name: "reactify",
- "package": "shared",
- lastUpdated: 1657634926000,
- docs: "https://vueuse.org/shared/reactify/",
- category: "Reactivity",
- description: "converts plain functions into reactive functions",
- alias: [
- "createReactiveFn"
- ],
- related: [
- "createUnrefFn"
- ]
- },
- {
- name: "reactifyObject",
- "package": "shared",
- lastUpdated: 1657634926000,
- docs: "https://vueuse.org/shared/reactifyObject/",
- category: "Reactivity",
- description: "apply `reactify` to an object"
- },
- {
- name: "reactiveComputed",
- "package": "shared",
- lastUpdated: 1645876129000,
- docs: "https://vueuse.org/shared/reactiveComputed/",
- category: "Reactivity",
- description: "computed reactive object"
- },
- {
- name: "reactiveOmit",
- "package": "shared",
- lastUpdated: 1658645224000,
- docs: "https://vueuse.org/shared/reactiveOmit/",
- category: "Reactivity",
- description: "reactively omit fields from a reactive object"
- },
- {
- name: "reactivePick",
- "package": "shared",
- lastUpdated: 1658645224000,
- docs: "https://vueuse.org/shared/reactivePick/",
- category: "Reactivity",
- description: "reactively pick fields from a reactive object"
- },
- {
- name: "refAutoReset",
- "package": "shared",
- lastUpdated: 1660291797000,
- 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: 1645956777000,
- 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: 1639442454000,
- docs: "https://vueuse.org/shared/refDefault/",
- category: "Reactivity",
- description: "apply default value to a ref"
- },
- {
- name: "refThrottled",
- "package": "shared",
- lastUpdated: 1645956777000,
- 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: 1662892188000,
- docs: "https://vueuse.org/shared/refWithControl/",
- category: "Reactivity",
- description: "fine-grained controls over ref and its reactivity",
- alias: [
- "controlledRef"
- ],
- related: [
- "computedWithControl"
- ]
- },
- {
- name: "resolveRef",
- "package": "shared",
- lastUpdated: 1657259100000,
- docs: "https://vueuse.org/shared/resolveRef/",
- category: "Reactivity",
- description: "normalize value/ref/getter to `ref` or `computed`",
- related: [
- "resolveUnref"
- ]
- },
- {
- name: "resolveUnref",
- "package": "shared",
- lastUpdated: 1657075685000,
- docs: "https://vueuse.org/shared/resolveUnref/",
- category: "Reactivity",
- description: "get the value of value/ref/getter",
- related: [
- "resolveRef"
- ]
- },
- {
- name: "set",
- "package": "shared",
- lastUpdated: 1642756441000,
- docs: "https://vueuse.org/shared/set/",
- category: "Utilities",
- description: "shorthand for `ref.value = x`"
- },
- {
- name: "syncRef",
- "package": "shared",
- lastUpdated: 1658655180000,
- docs: "https://vueuse.org/shared/syncRef/",
- category: "Reactivity",
- description: "two-way refs synchronization",
- related: [
- "syncRefs"
- ]
- },
- {
- name: "syncRefs",
- "package": "shared",
- lastUpdated: 1645952177000,
- docs: "https://vueuse.org/shared/syncRefs/",
- category: "Reactivity",
- description: "keep target refs in sync with a source ref",
- related: [
- "syncRef"
- ]
- },
- {
- name: "templateRef",
- "package": "core",
- lastUpdated: 1663295825000,
- docs: "https://vueuse.org/core/templateRef/",
- category: "Component",
- description: "shorthand for binding ref to template element"
- },
- {
- name: "toObserver",
- "package": "rxjs",
- lastUpdated: 1631130736000,
- 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: 1645878866000,
- docs: "https://vueuse.org/shared/toReactive/",
- category: "Reactivity",
- description: "converts ref to reactive"
- },
- {
- name: "toRefs",
- "package": "shared",
- lastUpdated: 1655284952000,
- docs: "https://vueuse.org/shared/toRefs/",
- category: "Reactivity",
- description: "extended [`toRefs`](https://v3.vuejs.org/api/refs-api.html#torefs) that also accepts refs of an object"
- },
- {
- name: "tryOnBeforeMount",
- "package": "shared",
- lastUpdated: 1655284952000,
- docs: "https://vueuse.org/shared/tryOnBeforeMount/",
- category: "Component",
- description: "safe `onBeforeMount`"
- },
- {
- name: "tryOnBeforeUnmount",
- "package": "shared",
- lastUpdated: 1639442454000,
- docs: "https://vueuse.org/shared/tryOnBeforeUnmount/",
- category: "Component",
- description: "safe `onBeforeUnmount`"
- },
- {
- name: "tryOnMounted",
- "package": "shared",
- lastUpdated: 1640933217000,
- docs: "https://vueuse.org/shared/tryOnMounted/",
- category: "Component",
- description: "safe `onMounted`"
- },
- {
- name: "tryOnScopeDispose",
- "package": "shared",
- lastUpdated: 1639442454000,
- docs: "https://vueuse.org/shared/tryOnScopeDispose/",
- category: "Component",
- description: "safe `onScopeDispose`"
- },
- {
- name: "tryOnUnmounted",
- "package": "shared",
- lastUpdated: 1640933217000,
- docs: "https://vueuse.org/shared/tryOnUnmounted/",
- category: "Component",
- description: "safe `onUnmounted`"
- },
- {
- name: "unrefElement",
- "package": "core",
- lastUpdated: 1657259100000,
- docs: "https://vueuse.org/core/unrefElement/",
- category: "Component",
- description: "unref for dom element"
- },
- {
- name: "until",
- "package": "shared",
- lastUpdated: 1664157004000,
- docs: "https://vueuse.org/shared/until/",
- category: "Watch",
- description: "promised one-time watch for changes"
- },
- {
- name: "useAbs",
- "package": "math",
- lastUpdated: 1658041562000,
- docs: "https://vueuse.org/math/useAbs/",
- category: "@Math",
- description: "reactive `Math.abs`"
- },
- {
- name: "useActiveElement",
- "package": "core",
- lastUpdated: 1661239180000,
- component: true,
- docs: "https://vueuse.org/core/useActiveElement/",
- category: "Elements",
- description: "reactive `document.activeElement`"
- },
- {
- name: "useArrayEvery",
- "package": "shared",
- lastUpdated: 1660291797000,
- docs: "https://vueuse.org/shared/useArrayEvery/",
- category: "Array",
- description: "reactive `Array.every`"
- },
- {
- name: "useArrayFilter",
- "package": "shared",
- lastUpdated: 1660291797000,
- docs: "https://vueuse.org/shared/useArrayFilter/",
- category: "Array",
- description: "reactive `Array.filter`"
- },
- {
- name: "useArrayFind",
- "package": "shared",
- lastUpdated: 1660291797000,
- docs: "https://vueuse.org/shared/useArrayFind/",
- category: "Array",
- description: "reactive `Array.find`"
- },
- {
- name: "useArrayFindIndex",
- "package": "shared",
- lastUpdated: 1660291797000,
- docs: "https://vueuse.org/shared/useArrayFindIndex/",
- category: "Array",
- description: "reactive `Array.findIndex`"
- },
- {
- name: "useArrayJoin",
- "package": "shared",
- lastUpdated: 1660291797000,
- docs: "https://vueuse.org/shared/useArrayJoin/",
- category: "Array",
- description: "reactive `Array.join`"
- },
- {
- name: "useArrayMap",
- "package": "shared",
- lastUpdated: 1662376596000,
- docs: "https://vueuse.org/shared/useArrayMap/",
- category: "Array",
- description: "reactive `Array.map`"
- },
- {
- name: "useArrayReduce",
- "package": "shared",
- lastUpdated: 1660291797000,
- docs: "https://vueuse.org/shared/useArrayReduce/",
- category: "Array",
- description: "reactive `Array.reduce`"
- },
- {
- name: "useArraySome",
- "package": "shared",
- lastUpdated: 1660291797000,
- docs: "https://vueuse.org/shared/useArraySome/",
- category: "Array",
- description: "reactive `Array.some`"
- },
- {
- name: "useAsyncQueue",
- "package": "core",
- lastUpdated: 1639818708000,
- 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: 1658656516000,
- docs: "https://vueuse.org/core/useAsyncState/",
- category: "State",
- description: "reactive async state"
- },
- {
- name: "useAsyncValidator",
- "package": "integrations",
- lastUpdated: 1657259100000,
- 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: 1658645224000,
- 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: 1658041190000,
- docs: "https://vueuse.org/math/useAverage/",
- category: "@Math",
- description: "get the average of an array reactively"
- },
- {
- name: "useAxios",
- "package": "integrations",
- lastUpdated: 1665960682000,
- 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: 1657259100000,
- docs: "https://vueuse.org/core/useBase64/",
- category: "Utilities",
- description: "reactive base64 transforming"
- },
- {
- name: "useBattery",
- "package": "core",
- lastUpdated: 1657430593000,
- 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: 1665965343000,
- 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: 1662285732000,
- docs: "https://vueuse.org/core/useBreakpoints/",
- category: "Browser",
- description: "reactive viewport breakpoints"
- },
- {
- name: "useBroadcastChannel",
- "package": "core",
- lastUpdated: 1658083596000,
- 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: 1639442454000,
- component: true,
- docs: "https://vueuse.org/core/useBrowserLocation/",
- category: "Browser",
- description: "reactive browser location"
- },
- {
- name: "useCached",
- "package": "core",
- lastUpdated: 1644284136000,
- docs: "https://vueuse.org/core/useCached/",
- category: "Utilities",
- description: "cache a ref with a custom comparator"
- },
- {
- name: "useCeil",
- "package": "math",
- lastUpdated: 1657638060000,
- docs: "https://vueuse.org/math/useCeil/",
- category: "@Math",
- description: "reactive `Math.ceil`"
- },
- {
- name: "useChangeCase",
- "package": "integrations",
- lastUpdated: 1657259100000,
- 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: 1657431142000,
- docs: "https://vueuse.org/math/useClamp/",
- category: "@Math",
- description: "reactively clamp a value between two other values"
- },
- {
- name: "useClipboard",
- "package": "core",
- lastUpdated: 1657634287000,
- docs: "https://vueuse.org/core/useClipboard/",
- category: "Browser",
- description: "reactive [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API)"
- },
- {
- name: "useCloned",
- "package": "core",
- lastUpdated: 1662386652000,
- docs: "https://vueuse.org/core/useCloned/",
- category: "Utilities",
- description: "reactive clone of a ref"
- },
- {
- name: "useColorMode",
- "package": "core",
- lastUpdated: 1662892188000,
- 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: 1642756441000,
- docs: "https://vueuse.org/core/useConfirmDialog/",
- category: "Utilities",
- description: "creates event hooks to support modals and confirmation dialog chains"
- },
- {
- name: "useCookies",
- "package": "integrations",
- lastUpdated: 1642756753000,
- docs: "https://vueuse.org/integrations/useCookies/",
- category: "@Integrations",
- description: "wrapper for [`universal-cookie`](https://www.npmjs.com/package/universal-cookie)",
- importPath: "integrations/useCookies"
- },
- {
- name: "useCounter",
- "package": "shared",
- lastUpdated: 1637326497000,
- docs: "https://vueuse.org/shared/useCounter/",
- category: "Utilities",
- description: "basic counter with utility functions"
- },
- {
- name: "useCssVar",
- "package": "core",
- lastUpdated: 1657259100000,
- docs: "https://vueuse.org/core/useCssVar/",
- category: "Browser",
- description: "manipulate CSS variables"
- },
- {
- name: "useCurrentElement",
- "package": "core",
- lastUpdated: 1661239180000,
- docs: "https://vueuse.org/core/useCurrentElement/",
- category: "Component",
- description: "get the DOM element of current component as a ref"
- },
- {
- name: "useCycleList",
- "package": "core",
- lastUpdated: 1659556886000,
- docs: "https://vueuse.org/core/useCycleList/",
- category: "Utilities",
- description: "cycle through a list of items"
- },
- {
- name: "useDark",
- "package": "core",
- lastUpdated: 1662892188000,
- 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: 1664216752000,
- 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: 1657259100000,
- docs: "https://vueuse.org/core/useDebouncedRefHistory/",
- category: "State",
- description: "shorthand for `useRefHistory` with debounced filter",
- related: [
- "useRefHistory",
- "useThrottledRefHistory"
- ]
- },
- {
- name: "useDebounceFn",
- "package": "shared",
- lastUpdated: 1660291797000,
- docs: "https://vueuse.org/shared/useDebounceFn/",
- category: "Utilities",
- description: "debounce execution of a function",
- related: [
- "useThrottleFn"
- ]
- },
- {
- name: "useDeviceMotion",
- "package": "core",
- lastUpdated: 1639442454000,
- 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: 1657430593000,
- 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: 1662386570000,
- component: true,
- docs: "https://vueuse.org/core/useDevicePixelRatio/",
- category: "Sensors",
- description: "reactively track [`window.devicePixelRatio`](https://developer.mozilla.org/ru/docs/Web/API/Window/devicePixelRatio)"
- },
- {
- name: "useDevicesList",
- "package": "core",
- lastUpdated: 1662892188000,
- 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: 1657430593000,
- 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: 1658083596000,
- 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: 1662386895000,
- component: true,
- docs: "https://vueuse.org/core/useDraggable/",
- category: "Elements",
- description: "make elements draggable"
- },
- {
- name: "useDrauu",
- "package": "integrations",
- lastUpdated: 1657259100000,
- 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: 1658043158000,
- docs: "https://vueuse.org/core/useDropZone/",
- category: "Elements",
- description: "create an zone where files can be dropped"
- },
- {
- name: "useElementBounding",
- "package": "core",
- lastUpdated: 1657259100000,
- component: 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: 1657259100000,
- docs: "https://vueuse.org/core/useElementByPoint/",
- category: "Sensors",
- description: "reactive element by point"
- },
- {
- name: "useElementHover",
- "package": "core",
- lastUpdated: 1660290815000,
- directive: true,
- docs: "https://vueuse.org/core/useElementHover/",
- category: "Sensors",
- description: "reactive element's hover state"
- },
- {
- name: "useElementSize",
- "package": "core",
- lastUpdated: 1662384935000,
- 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.html"
- },
- {
- "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.html"
- },
- {
- name: "useElementVisibility",
- "package": "core",
- lastUpdated: 1662384256000,
- 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: 1651597304000,
- docs: "https://vueuse.org/core/useEventBus/",
- category: "Utilities",
- description: "a basic event bus"
- },
- {
- name: "useEventListener",
- "package": "core",
- lastUpdated: 1657259100000,
- docs: "https://vueuse.org/core/useEventListener/",
- category: "Browser",
- description: "use EventListener with ease"
- },
- {
- name: "useEventSource",
- "package": "core",
- lastUpdated: 1657634387000,
- 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: "useEyeDropper",
- "package": "core",
- lastUpdated: 1658083596000,
- 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: 1661409315000,
- docs: "https://vueuse.org/core/useFavicon/",
- category: "Browser",
- description: "reactive favicon"
- },
- {
- name: "useFetch",
- "package": "core",
- lastUpdated: 1665014132000,
- 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: 1662385329000,
- docs: "https://vueuse.org/core/useFileDialog/",
- category: "Browser",
- description: "open file dialog with ease"
- },
- {
- name: "useFileSystemAccess",
- "package": "core",
- lastUpdated: 1657430593000,
- 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: 1665959947000,
- 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: 1657638060000,
- docs: "https://vueuse.org/math/useFloor/",
- category: "@Math",
- description: "reactive `Math.floor`"
- },
- {
- name: "useFocus",
- "package": "core",
- lastUpdated: 1652671318000,
- 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: 1639818708000,
- 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: 1662285126000,
- docs: "https://vueuse.org/core/useFocusWithin/",
- category: "Sensors",
- description: "reactive utility to track if an element or one of its decendants has focus"
- },
- {
- name: "useFps",
- "package": "core",
- lastUpdated: 1644734082000,
- docs: "https://vueuse.org/core/useFps/",
- category: "Sensors",
- description: "reactive FPS (frames per second)"
- },
- {
- name: "useFullscreen",
- "package": "core",
- lastUpdated: 1657430593000,
- 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: 1657259100000,
- 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: 1658083596000,
- 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: 1657638032000,
- 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: "useIdle",
- "package": "core",
- lastUpdated: 1657638023000,
- component: true,
- docs: "https://vueuse.org/core/useIdle/",
- category: "Sensors",
- description: "tracks whether the user is being inactive"
- },
- {
- name: "useImage",
- "package": "core",
- lastUpdated: 1658083596000,
- component: true,
- docs: "https://vueuse.org/core/useImage/",
- category: "Browser",
- description: "reactive load an image in the browser"
- },
- {
- name: "useInfiniteScroll",
- "package": "core",
- lastUpdated: 1658043158000,
- directive: true,
- docs: "https://vueuse.org/core/useInfiniteScroll/",
- category: "Sensors",
- description: "infinite scrolling of the element"
- },
- {
- name: "useIntersectionObserver",
- "package": "core",
- lastUpdated: 1657637968000,
- directive: true,
- docs: "https://vueuse.org/core/useIntersectionObserver/",
- category: "Elements",
- description: "detects that a target element's visibility"
- },
- {
- name: "useInterval",
- "package": "shared",
- lastUpdated: 1664157082000,
- docs: "https://vueuse.org/shared/useInterval/",
- category: "Animation",
- description: "reactive counter increases on every interval"
- },
- {
- name: "useIntervalFn",
- "package": "shared",
- lastUpdated: 1659611339000,
- docs: "https://vueuse.org/shared/useIntervalFn/",
- category: "Animation",
- description: "wrapper for `setInterval` with controls"
- },
- {
- name: "useIpcRenderer",
- "package": "electron",
- lastUpdated: 1658645224000,
- docs: "https://vueuse.org/electron/useIpcRenderer/",
- category: "@Electron",
- description: "provides [ipcRenderer](https://www.electronjs.org/docs/api/ipc-renderer) and all of its APIs"
- },
- {
- name: "useIpcRendererInvoke",
- "package": "electron",
- lastUpdated: 1658645224000,
- 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: 1658645224000,
- 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: 1657730911000,
- 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: 1657638042000,
- 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: 1642756441000,
- docs: "https://vueuse.org/shared/useLastChanged/",
- category: "State",
- description: "records the timestamp of the last change"
- },
- {
- name: "useLocalStorage",
- "package": "core",
- lastUpdated: 1657634978000,
- 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: 1657814222000,
- docs: "https://vueuse.org/core/useMagicKeys/",
- category: "Sensors",
- description: "reactive keys pressed state"
- },
- {
- name: "useManualRefHistory",
- "package": "core",
- lastUpdated: 1662386652000,
- docs: "https://vueuse.org/core/useManualRefHistory/",
- category: "State",
- description: "manually track the change history of a ref when the using calls `commit()`",
- related: [
- "useRefHistory"
- ]
- },
- {
- name: "useMath",
- "package": "math",
- lastUpdated: 1658042869000,
- docs: "https://vueuse.org/math/useMath/",
- category: "@Math",
- description: "reactive `Math` methods"
- },
- {
- name: "useMax",
- "package": "math",
- lastUpdated: 1658041190000,
- docs: "https://vueuse.org/math/useMax/",
- category: "@Math",
- description: "reactive `Math.max`"
- },
- {
- name: "useMediaControls",
- "package": "core",
- lastUpdated: 1657259100000,
- docs: "https://vueuse.org/core/useMediaControls/",
- category: "Browser",
- description: "reactive media controls for both `audio` and `video` elements"
- },
- {
- name: "useMediaQuery",
- "package": "core",
- lastUpdated: 1662574748000,
- 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: 1662384725000,
- 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: 1658083607000,
- docs: "https://vueuse.org/core/useMemory/",
- category: "Browser",
- description: "reactive Memory Info"
- },
- {
- name: "useMin",
- "package": "math",
- lastUpdated: 1658041610000,
- 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.html"
- },
- {
- "package": "motion",
- category: "@Motion",
- name: "useMotionProperties",
- description: "access Motion Properties for a target element.",
- external: "https://motion.vueuse.org/api/use-motion-properties.html"
- },
- {
- "package": "motion",
- category: "@Motion",
- name: "useMotionVariants",
- description: "handle the Variants state and selection.",
- external: "https://motion.vueuse.org/api/use-motion-variants.html"
- },
- {
- name: "useMounted",
- "package": "core",
- lastUpdated: 1640933217000,
- docs: "https://vueuse.org/core/useMounted/",
- category: "Component",
- description: "mounted state in ref"
- },
- {
- name: "useMouse",
- "package": "core",
- lastUpdated: 1657643692000,
- component: true,
- docs: "https://vueuse.org/core/useMouse/",
- category: "Sensors",
- description: "reactive mouse position"
- },
- {
- name: "useMouseInElement",
- "package": "core",
- lastUpdated: 1657643692000,
- component: true,
- docs: "https://vueuse.org/core/useMouseInElement/",
- category: "Elements",
- description: "reactive mouse position related to an element"
- },
- {
- name: "useMousePressed",
- "package": "core",
- lastUpdated: 1639818708000,
- component: true,
- docs: "https://vueuse.org/core/useMousePressed/",
- category: "Sensors",
- description: "reactive mouse pressing state"
- },
- {
- name: "useMutationObserver",
- "package": "core",
- lastUpdated: 1657718877000,
- docs: "https://vueuse.org/core/useMutationObserver/",
- category: "Elements",
- description: "watch for changes being made to the DOM tree"
- },
- {
- name: "useNavigatorLanguage",
- "package": "core",
- lastUpdated: 1662892188000,
- 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: 1658083596000,
- 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: 1639442454000,
- component: true,
- docs: "https://vueuse.org/core/useNow/",
- category: "Animation",
- description: "reactive current Date instance"
- },
- {
- name: "useNProgress",
- "package": "integrations",
- lastUpdated: 1658758826000,
- 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: 1657132677000,
- component: true,
- docs: "https://vueuse.org/core/useObjectUrl/",
- category: "Browser",
- description: "reactive URL representing an object"
- },
- {
- name: "useObservable",
- "package": "rxjs",
- lastUpdated: 1651595539000,
- docs: "https://vueuse.org/rxjs/useObservable/",
- category: "@RxJS",
- description: "use an RxJS [`Observable`](https://rxjs.dev/guide/observable)"
- },
- {
- name: "useOffsetPagination",
- "package": "core",
- lastUpdated: 1659592690000,
- component: true,
- docs: "https://vueuse.org/core/useOffsetPagination/",
- category: "Utilities",
- description: "reactive offset pagination"
- },
- {
- name: "useOnline",
- "package": "core",
- lastUpdated: 1639442454000,
- component: true,
- docs: "https://vueuse.org/core/useOnline/",
- category: "Sensors",
- description: "reactive online state"
- },
- {
- name: "usePageLeave",
- "package": "core",
- lastUpdated: 1642756441000,
- 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: 1657718913000,
- docs: "https://vueuse.org/core/useParallax/",
- category: "Sensors",
- description: "create parallax effect easily"
- },
- {
- name: "usePermission",
- "package": "core",
- lastUpdated: 1657430593000,
- 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: 1658083596000,
- 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: "usePointerSwipe",
- "package": "core",
- lastUpdated: 1657718938000,
- 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: 1659586173000,
- docs: "https://vueuse.org/math/usePrecision/",
- category: "@Math",
- description: "reactively set the precision of a number"
- },
- {
- name: "usePreferredColorScheme",
- "package": "core",
- lastUpdated: 1639442454000,
- 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: 1661240113000,
- 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: 1639442454000,
- component: true,
- docs: "https://vueuse.org/core/usePreferredDark/",
- category: "Browser",
- description: "reactive dark theme preference",
- related: [
- "useColorMode",
- "useDark"
- ]
- },
- {
- name: "usePreferredLanguages",
- "package": "core",
- lastUpdated: 1639442454000,
- 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: 1659593252000,
- 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: "useProjection",
- "package": "math",
- lastUpdated: 1657638060000,
- 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: 1657259100000,
- 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: 1657718952000,
- docs: "https://vueuse.org/core/useRafFn/",
- category: "Animation",
- description: "call function on every `requestAnimationFrame`"
- },
- {
- name: "useRefHistory",
- "package": "core",
- lastUpdated: 1662386652000,
- 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: 1662384935000,
- 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: 1657638060000,
- docs: "https://vueuse.org/math/useRound/",
- category: "@Math",
- description: "reactive `Math.round`"
- },
- {
- name: "useRouteHash",
- "package": "router",
- lastUpdated: 1639442454000,
- docs: "https://vueuse.org/router/useRouteHash/",
- category: "@Router",
- description: "shorthand for a reactive `route.hash`"
- },
- {
- name: "useRouteParams",
- "package": "router",
- lastUpdated: 1657133143000,
- docs: "https://vueuse.org/router/useRouteParams/",
- category: "@Router",
- description: "shorthand for a reactive `route.params`"
- },
- {
- name: "useRouteQuery",
- "package": "router",
- lastUpdated: 1649931974000,
- docs: "https://vueuse.org/router/useRouteQuery/",
- category: "@Router",
- description: "shorthand for a reactive `route.query`"
- },
- {
- name: "useRTDB",
- "package": "firebase",
- lastUpdated: 1658645224000,
- 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: 1657430593000,
- 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: 1640682127000,
- component: true,
- docs: "https://vueuse.org/core/useScreenSafeArea/",
- category: "Browser",
- description: "reactive `env(safe-area-inset-*)`"
- },
- {
- name: "useScriptTag",
- "package": "core",
- lastUpdated: 1659556839000,
- docs: "https://vueuse.org/core/useScriptTag/",
- category: "Browser",
- description: "script tag injecting"
- },
- {
- name: "useScroll",
- "package": "core",
- lastUpdated: 1664156364000,
- directive: true,
- docs: "https://vueuse.org/core/useScroll/",
- category: "Sensors",
- description: "reactive scroll position and state"
- },
- {
- name: "useScrollLock",
- "package": "core",
- lastUpdated: 1657259100000,
- directive: true,
- docs: "https://vueuse.org/core/useScrollLock/",
- category: "Sensors",
- description: "lock scrolling of the element"
- },
- {
- name: "useSessionStorage",
- "package": "core",
- lastUpdated: 1657634978000,
- 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: 1657718983000,
- 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: "useSorted",
- "package": "core",
- lastUpdated: 1665961123000,
- 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: 1662892188000,
- 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: 1658083561000,
- 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.html"
- },
- {
- name: "useStepper",
- "package": "core",
- lastUpdated: 1657132687000,
- docs: "https://vueuse.org/core/useStepper/",
- category: "Utilities",
- description: "provides helpers for building a multi-step wizard interface"
- },
- {
- name: "useStorage",
- "package": "core",
- lastUpdated: 1665959716000,
- docs: "https://vueuse.org/core/useStorage/",
- category: "State",
- description: "reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)/[SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)",
- related: [
- "useColorMode",
- "useDark",
- "useLocalStorage",
- "useSessionStorage",
- "useStorageAsync"
- ]
- },
- {
- name: "useStorageAsync",
- "package": "core",
- lastUpdated: 1657718694000,
- docs: "https://vueuse.org/core/useStorageAsync/",
- category: "State",
- description: "reactive Storage in with async support",
- related: [
- "useStorage"
- ]
- },
- {
- name: "useStyleTag",
- "package": "core",
- lastUpdated: 1657813267000,
- docs: "https://vueuse.org/core/useStyleTag/",
- category: "Browser",
- description: "inject reactive `style` element in head"
- },
- {
- name: "useSubject",
- "package": "rxjs",
- lastUpdated: 1651595539000,
- 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: 1628521945000,
- 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: 1658041190000,
- docs: "https://vueuse.org/math/useSum/",
- category: "@Math",
- description: "get the sum of an array reactively"
- },
- {
- name: "useSupported",
- "package": "core",
- lastUpdated: 1657430593000,
- docs: "https://vueuse.org/core/useSupported/",
- category: "Utilities",
- description: "sSR compatibility `isSupported`"
- },
- {
- name: "useSwipe",
- "package": "core",
- lastUpdated: 1657721393000,
- 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: 1639442454000,
- docs: "https://vueuse.org/core/useTemplateRefsList/",
- category: "Component",
- description: "shorthand for binding refs to template elements and components inside `v-for`"
- },
- {
- name: "useTextareaAutosize",
- "package": "core",
- lastUpdated: 1658083596000,
- 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: 1658657118000,
- 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: 1646469737000,
- 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: 1658083596000,
- docs: "https://vueuse.org/core/useThrottledRefHistory/",
- category: "State",
- description: "shorthand for `useRefHistory` with throttled filter",
- related: [
- "useDebouncedRefHistory",
- "useRefHistory"
- ]
- },
- {
- name: "useThrottleFn",
- "package": "shared",
- lastUpdated: 1657259100000,
- docs: "https://vueuse.org/shared/useThrottleFn/",
- category: "Utilities",
- description: "throttle execution of a function",
- related: [
- "refDebounced",
- "refThrottled",
- "useDebounceFn"
- ]
- },
- {
- name: "useTimeAgo",
- "package": "core",
- lastUpdated: 1664156942000,
- component: true,
- docs: "https://vueuse.org/core/useTimeAgo/",
- category: "Time",
- description: "reactive time ago"
- },
- {
- name: "useTimeout",
- "package": "shared",
- lastUpdated: 1664157082000,
- docs: "https://vueuse.org/shared/useTimeout/",
- category: "Animation",
- description: "update value after a given time with controls"
- },
- {
- name: "useTimeoutFn",
- "package": "shared",
- lastUpdated: 1660751262000,
- docs: "https://vueuse.org/shared/useTimeoutFn/",
- category: "Animation",
- description: "wrapper for `setTimeout` with controls"
- },
- {
- name: "useTimeoutPoll",
- "package": "core",
- lastUpdated: 1658083632000,
- docs: "https://vueuse.org/core/useTimeoutPoll/",
- category: "Utilities",
- description: "use timeout to poll something"
- },
- {
- name: "useTimestamp",
- "package": "core",
- lastUpdated: 1664157082000,
- component: true,
- docs: "https://vueuse.org/core/useTimestamp/",
- category: "Animation",
- description: "reactive current timestamp"
- },
- {
- name: "useTitle",
- "package": "core",
- lastUpdated: 1665963788000,
- docs: "https://vueuse.org/core/useTitle/",
- category: "Browser",
- description: "reactive document title"
- },
- {
- name: "useToFixed",
- "package": "math",
- lastUpdated: 1659586610000,
- docs: "https://vueuse.org/math/useToFixed/",
- category: "@Math",
- description: "reactive `toFixed`",
- deprecated: true
- },
- {
- name: "useToggle",
- "package": "shared",
- lastUpdated: 1657259100000,
- docs: "https://vueuse.org/shared/useToggle/",
- category: "Utilities",
- description: "a boolean switcher with utility functions"
- },
- {
- name: "useToNumber",
- "package": "shared",
- lastUpdated: 1659592336000,
- docs: "https://vueuse.org/shared/useToNumber/",
- category: "Utilities",
- description: "reactively convert a string ref to number"
- },
- {
- name: "useToString",
- "package": "shared",
- lastUpdated: 1659592531000,
- docs: "https://vueuse.org/shared/useToString/",
- category: "Utilities",
- description: "reactively convert a ref to string"
- },
- {
- name: "useTransition",
- "package": "core",
- lastUpdated: 1660293053000,
- docs: "https://vueuse.org/core/useTransition/",
- category: "Animation",
- description: "transition between values"
- },
- {
- name: "useTrunc",
- "package": "math",
- lastUpdated: 1658043525000,
- docs: "https://vueuse.org/math/useTrunc/",
- category: "@Math",
- description: "reactive `Math.trunc`"
- },
- {
- name: "useUrlSearchParams",
- "package": "core",
- lastUpdated: 1662286506000,
- 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: 1657430593000,
- 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: 1657430593000,
- 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: 1658083596000,
- component: true,
- docs: "https://vueuse.org/core/useVirtualList/",
- category: "Component",
- description: "create virtual lists with ease"
- },
- {
- name: "useVModel",
- "package": "core",
- lastUpdated: 1662386652000,
- docs: "https://vueuse.org/core/useVModel/",
- category: "Component",
- description: "shorthand for v-model binding",
- related: [
- "useVModels"
- ]
- },
- {
- name: "useVModels",
- "package": "core",
- lastUpdated: 1657730657000,
- docs: "https://vueuse.org/core/useVModels/",
- category: "Component",
- description: "shorthand for props v-model binding",
- related: [
- "useVModel"
- ]
- },
- {
- name: "useWakeLock",
- "package": "core",
- lastUpdated: 1658083596000,
- 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: "useWebNotification",
- "package": "core",
- lastUpdated: 1658083596000,
- 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: 1664132672000,
- 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: 1647220329000,
- 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: 1657730737000,
- docs: "https://vueuse.org/core/useWebWorkerFn/",
- category: "Browser",
- description: "run expensive functions without blocking the UI",
- related: [
- "useWebWorker"
- ]
- },
- {
- name: "useWindowFocus",
- "package": "core",
- lastUpdated: 1639442454000,
- 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: 1639442454000,
- docs: "https://vueuse.org/core/useWindowScroll/",
- category: "Elements",
- description: "reactive window scroll"
- },
- {
- name: "useWindowSize",
- "package": "core",
- lastUpdated: 1662285565000,
- component: true,
- docs: "https://vueuse.org/core/useWindowSize/",
- category: "Elements",
- description: "reactive window size"
- },
- {
- name: "useZoomFactor",
- "package": "electron",
- lastUpdated: 1658645224000,
- 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: 1658645224000,
- 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: 1652598461000,
- internal: true
- },
- {
- name: "watchArray",
- "package": "shared",
- lastUpdated: 1657133473000,
- docs: "https://vueuse.org/shared/watchArray/",
- category: "Watch",
- description: "watch for an array with additions and removals"
- },
- {
- name: "watchAtMost",
- "package": "shared",
- lastUpdated: 1662892188000,
- docs: "https://vueuse.org/shared/watchAtMost/",
- category: "Watch",
- description: "`watch` with the number of times triggered"
- },
- {
- name: "watchDebounced",
- "package": "shared",
- lastUpdated: 1662892188000,
- docs: "https://vueuse.org/shared/watchDebounced/",
- category: "Watch",
- description: "debounced watch",
- alias: [
- "debouncedWatch"
- ]
- },
- {
- name: "watchIgnorable",
- "package": "shared",
- lastUpdated: 1655390134000,
- docs: "https://vueuse.org/shared/watchIgnorable/",
- category: "Watch",
- description: "ignorable watch",
- alias: [
- "ignorableWatch"
- ]
- },
- {
- name: "watchOnce",
- "package": "shared",
- lastUpdated: 1662892188000,
- docs: "https://vueuse.org/shared/watchOnce/",
- category: "Watch",
- description: "`watch` that only triggers once"
- },
- {
- name: "watchPausable",
- "package": "shared",
- lastUpdated: 1662892188000,
- docs: "https://vueuse.org/shared/watchPausable/",
- category: "Watch",
- description: "pausable watch",
- alias: [
- "pausableWatch"
- ]
- },
- {
- name: "watchThrottled",
- "package": "shared",
- lastUpdated: 1657259100000,
- docs: "https://vueuse.org/shared/watchThrottled/",
- category: "Watch",
- description: "throttled watch",
- alias: [
- "throttledWatch"
- ]
- },
- {
- name: "watchTriggerable",
- "package": "shared",
- lastUpdated: 1657077213000,
- docs: "https://vueuse.org/shared/watchTriggerable/",
- category: "Watch",
- description: "watch that can be triggered manually"
- },
- {
- name: "watchWithFilter",
- "package": "shared",
- lastUpdated: 1662892188000,
- docs: "https://vueuse.org/shared/watchWithFilter/",
- category: "Watch",
- description: "`watch` with additional EventFilter control"
- },
- {
- name: "whenever",
- "package": "shared",
- lastUpdated: 1658645224000,
- docs: "https://vueuse.org/shared/whenever/",
- category: "Watch",
- description: "shorthand for watching value to be truthy"
- }
- ];
- var _metadata = {
- packages: packages$1,
- categories: categories$1,
- functions: functions$1
- };
- const categoriesOrder = [
- "State",
- "Elements",
- "Browser",
- "Sensors",
- "Network",
- "Animation",
- "Component",
- "Watch",
- "Reactivity",
- "Array",
- "Time",
- "Utilities"
- ];
- const metadata = _metadata;
- 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("@"));
- const getFunction = (name) => metadata.functions.find((f) => f.name === name);
- 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));
- }
- exports.addonCategoryNames = addonCategoryNames;
- exports.categories = categories;
- exports.categoryNames = categoryNames;
- exports.coreCategoryNames = coreCategoryNames;
- exports.functionNames = functionNames;
- exports.functions = functions;
- exports.getCategories = getCategories;
- exports.getFunction = getFunction;
- exports.metadata = metadata;
- exports.packages = packages;
- exports.uniq = uniq;
|