1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491 |
- 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",
- "idb-keyval"
- ],
- 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"
- },
- 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: 1672940168000,
- 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: 1671205540000,
- docs: "https://vueuse.org/shared/createEventHook/",
- category: "Utilities",
- description: "utility for creating event hooks"
- },
- {
- name: "createGenericProjection",
- "package": "math",
- lastUpdated: 1667952962000,
- 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: 1673947341000,
- 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: 1671470212000,
- 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: 1675466376000,
- 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: 1672754414000,
- 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: 1667952962000,
- 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: 1666676013000,
- 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: 1672752994000,
- docs: "https://vueuse.org/shared/resolveRef/",
- category: "Reactivity",
- description: "normalize value/ref/getter to `ref` or `computed`",
- related: [
- "resolveUnref"
- ]
- },
- {
- name: "resolveUnref",
- "package": "shared",
- lastUpdated: 1667054063000,
- 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: 1675070075000,
- 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: 1672753027000,
- 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: "useArrayFindLast",
- "package": "shared",
- lastUpdated: 1676713178000,
- docs: "https://vueuse.org/shared/useArrayFindLast/",
- category: "Array",
- description: "reactive `Array.findLast`"
- },
- {
- 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: "useArrayUnique",
- "package": "shared",
- lastUpdated: 1672753114000,
- docs: "https://vueuse.org/shared/useArrayUnique/",
- category: "Array",
- description: "reactive unique array"
- },
- {
- 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: 1676388144000,
- docs: "https://vueuse.org/core/useAsyncState/",
- category: "State",
- description: "reactive async state"
- },
- {
- name: "useAsyncValidator",
- "package": "integrations",
- lastUpdated: 1676570052000,
- 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: 1676590260000,
- 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: 1676714120000,
- docs: "https://vueuse.org/math/useClamp/",
- category: "@Math",
- description: "reactively clamp a value between two other values"
- },
- {
- name: "useClipboard",
- "package": "core",
- lastUpdated: 1666676330000,
- 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: 1674955241000,
- 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: 1666677599000,
- 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: 1672753228000,
- 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: 1676712461000,
- 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: 1672752994000,
- 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: 1671204368000,
- 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 a zone where files can be dropped"
- },
- {
- name: "useElementBounding",
- "package": "core",
- lastUpdated: 1672422913000,
- 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: 1672852514000,
- docs: "https://vueuse.org/core/useElementByPoint/",
- category: "Sensors",
- description: "reactive element by point"
- },
- {
- name: "useElementHover",
- "package": "core",
- lastUpdated: 1676712131000,
- directive: true,
- docs: "https://vueuse.org/core/useElementHover/",
- category: "Sensors",
- description: "reactive element's hover state"
- },
- {
- name: "useElementSize",
- "package": "core",
- lastUpdated: 1674954789000,
- 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: 1676389922000,
- docs: "https://vueuse.org/core/useEventBus/",
- category: "Utilities",
- description: "a basic event bus"
- },
- {
- name: "useEventListener",
- "package": "core",
- lastUpdated: 1676715818000,
- 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: 1676093591000,
- 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: 1668298845000,
- 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: 1674992405000,
- 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: 1674955241000,
- 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: 1671204138000,
- 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: 1668302379000,
- 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: 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: 1676713336000,
- docs: "https://vueuse.org/shared/useInterval/",
- category: "Animation",
- description: "reactive counter increases on every interval"
- },
- {
- name: "useIntervalFn",
- "package": "shared",
- lastUpdated: 1674954620000,
- 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: 1672752994000,
- 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: 1674853020000,
- 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: 1667952962000,
- 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: 1672753737000,
- component: true,
- docs: "https://vueuse.org/core/useMouse/",
- category: "Sensors",
- description: "reactive mouse position"
- },
- {
- name: "useMouseInElement",
- "package": "core",
- lastUpdated: 1674954670000,
- 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: "usePointerLock",
- "package": "core",
- lastUpdated: 1673941699000,
- 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: 1667953110000,
- 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: 1674662786000,
- 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: "usePrevious",
- "package": "core",
- lastUpdated: 1674951743000,
- docs: "https://vueuse.org/core/usePrevious/",
- category: "Utilities",
- description: "holds the previous value of a ref"
- },
- {
- 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: 1674954620000,
- 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: 1666676087000,
- docs: "https://vueuse.org/router/useRouteHash/",
- category: "@Router",
- description: "shorthand for a reactive `route.hash`"
- },
- {
- name: "useRouteParams",
- "package": "router",
- lastUpdated: 1666676087000,
- docs: "https://vueuse.org/router/useRouteParams/",
- category: "@Router",
- description: "shorthand for a reactive `route.params`"
- },
- {
- name: "useRouteQuery",
- "package": "router",
- lastUpdated: 1674955241000,
- 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: 1676711938000,
- directive: true,
- docs: "https://vueuse.org/core/useScroll/",
- category: "Sensors",
- description: "reactive scroll position and state"
- },
- {
- name: "useScrollLock",
- "package": "core",
- lastUpdated: 1676713396000,
- 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: 1676650547000,
- 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: 1676387907000,
- 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: 1676546331000,
- docs: "https://vueuse.org/core/useStorageAsync/",
- category: "State",
- description: "reactive Storage in with async support",
- related: [
- "useStorage"
- ]
- },
- {
- name: "useStyleTag",
- "package": "core",
- lastUpdated: 1669416726000,
- docs: "https://vueuse.org/core/useStyleTag/",
- category: "Browser",
- description: "inject reactive `style` element in head"
- },
- {
- name: "useSubject",
- "package": "rxjs",
- lastUpdated: 1672752994000,
- 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: 1671205095000,
- 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: 1672753228000,
- docs: "https://vueuse.org/shared/useThrottleFn/",
- category: "Utilities",
- description: "throttle execution of a function",
- related: [
- "refDebounced",
- "refThrottled",
- "useDebounceFn"
- ]
- },
- {
- name: "useTimeAgo",
- "package": "core",
- lastUpdated: 1671824301000,
- 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: 1674954620000,
- 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: 1674955241000,
- 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: 1676174012000,
- 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: 1674954839000,
- 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: 1666677873000,
- 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: 1676590806000,
- 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: 1672752994000,
- 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));
- }
- export { addonCategoryNames, categories, categoryNames, coreCategoryNames, functionNames, functions, getCategories, getFunction, metadata, packages, uniq };
|