Skip to content

Commit f1bb50c

Browse files
docs: added export size in FunctionInfo (vueuse#2082)
1 parent 42dd901 commit f1bb50c

File tree

4 files changed

+373
-3
lines changed

4 files changed

+373
-3
lines changed

packages/.vitepress/theme/components/FunctionInfo.vue

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
import { useTimeAgo } from '@vueuse/core'
33
import { computed } from 'vue'
44
import { functions } from '@vueuse/metadata'
5+
import exportSizes from '../../../export-size.json'
56
67
const props = defineProps<{ fn: string }>()
7-
88
const info = computed(() => functions.find(i => i.name === props.fn))
99
const format = (ts: number) => ago(-1, 'day')
1010
const lastUpdated = useTimeAgo(new Date(info.value?.lastUpdated || 0))
1111
const link = computed(() => `/functions\#category=${encodeURIComponent(info.value.category)}`)
1212
13+
const exportSize = exportSizes[info.value?.name]
1314
const getFunctionLink = (fn: string) => {
1415
const info = functions.find(i => i.name === fn)
1516
return info?.docs.replace(/https?:\/\/vueuse\.org\//g, '/')
@@ -22,6 +23,10 @@ const getFunctionLink = (fn: string) => {
2223
Category
2324
</div>
2425
<div><a :href="link">{{ info.category }}</a></div>
26+
<div opacity="50">
27+
Export Size
28+
</div>
29+
<div> {{ exportSize }}</div>
2530
<template v-if="info.package !== 'core' && info.package !== 'shared'">
2631
<div opacity="50">
2732
Package

packages/export-size.json

Lines changed: 363 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,363 @@
1+
{
2+
"createFetch": "3.08 kB",
3+
"useDark": "3.02 kB",
4+
"useColorMode": "2.86 kB",
5+
"useFetch": "2.85 kB",
6+
"useMediaControls": "2.75 kB",
7+
"useLocalStorage": "2.19 kB",
8+
"useSessionStorage": "2.19 kB",
9+
"useThrottledRefHistory": "2.17 kB",
10+
"useStorage": "2.16 kB",
11+
"useDebouncedRefHistory": "2.12 kB",
12+
"useUrlSearchParams": "1.98 kB",
13+
"useInfiniteScroll": "1.96 kB",
14+
"useParallax": "1.96 kB",
15+
"useTimeAgo": "1.93 kB",
16+
"useRefHistory": "1.91 kB",
17+
"useStorageAsync": "1.83 kB",
18+
"useVirtualList": "1.76 kB",
19+
"useGamepad": "1.73 kB",
20+
"useWebSocket": "1.7 kB",
21+
"useScroll": "1.68 kB",
22+
"useDraggable": "1.68 kB",
23+
"useTransition": "1.66 kB",
24+
"useDevicesList": "1.63 kB",
25+
"useScreenSafeArea": "1.57 kB",
26+
"useMagicKeys": "1.57 kB",
27+
"useMouseInElement": "1.56 kB",
28+
"usePointer": "1.55 kB",
29+
"useElementBounding": "1.54 kB",
30+
"useSwipe": "1.53 kB",
31+
"usePointerSwipe": "1.52 kB",
32+
"useFullscreen": "1.48 kB",
33+
"useWebNotification": "1.48 kB",
34+
"useIdle": "1.43 kB",
35+
"useClipboard": "1.41 kB",
36+
"useDevicePixelRatio": "1.41 kB",
37+
"useTitle": "1.41 kB",
38+
"useBase64": "1.39 kB",
39+
"useBreakpoints": "1.38 kB",
40+
"useTextDirection": "1.38 kB",
41+
"useWebWorkerFn": "1.37 kB",
42+
"useOnline": "1.37 kB",
43+
"useNetwork": "1.35 kB",
44+
"onClickOutside": "1.34 kB",
45+
"useFileSystemAccess": "1.32 kB",
46+
"usePermission": "1.3 kB",
47+
"useMouse": "1.29 kB",
48+
"useScriptTag": "1.29 kB",
49+
"useSpeechSynthesis": "1.28 kB",
50+
"useWakeLock": "1.27 kB",
51+
"useElementSize": "1.27 kB",
52+
"useBattery": "1.27 kB",
53+
"onKeyPressed": "1.27 kB",
54+
"onKeyUp": "1.27 kB",
55+
"onKeyDown": "1.26 kB",
56+
"useOffsetPagination": "1.26 kB",
57+
"useSpeechRecognition": "1.25 kB",
58+
"useScreenOrientation": "1.25 kB",
59+
"onStartTyping": "1.24 kB",
60+
"useImage": "1.24 kB",
61+
"useVibrate": "1.23 kB",
62+
"useScrollLock": "1.23 kB",
63+
"useTimestamp": "1.23 kB",
64+
"useTextSelection": "1.22 kB",
65+
"useElementVisibility": "1.22 kB",
66+
"useDeviceMotion": "1.21 kB",
67+
"useFocus": "1.21 kB",
68+
"useMousePressed": "1.21 kB",
69+
"useEventSource": "1.21 kB",
70+
"useNow": "1.21 kB",
71+
"useUserMedia": "1.2 kB",
72+
"onLongPress": "1.2 kB",
73+
"useDeviceOrientation": "1.2 kB",
74+
"useResizeObserver": "1.19 kB",
75+
"useBluetooth": "1.18 kB",
76+
"useMutationObserver": "1.18 kB",
77+
"useBrowserLocation": "1.17 kB",
78+
"useNavigatorLanguage": "1.17 kB",
79+
"useDropZone": "1.16 kB",
80+
"useWindowSize": "1.16 kB",
81+
"onKeyStroke": "1.16 kB",
82+
"useFocusWithin": "1.14 kB",
83+
"useMemory": "1.14 kB",
84+
"useIntersectionObserver": "1.14 kB",
85+
"useManualRefHistory": "1.14 kB",
86+
"useKeyModifier": "1.13 kB",
87+
"usePageLeave": "1.11 kB",
88+
"usePreferredColorScheme": "1.1 kB",
89+
"useGeolocation": "1.1 kB",
90+
"useDisplayMedia": "1.1 kB",
91+
"useWindowScroll": "1.1 kB",
92+
"useVModels": "1.09 kB",
93+
"usePreferredReducedMotion": "1.09 kB",
94+
"useStyleTag": "1.09 kB",
95+
"useActiveElement": "1.08 kB",
96+
"useDocumentVisibility": "1.07 kB",
97+
"useWindowFocus": "1.07 kB",
98+
"usePreferredLanguages": "1.07 kB",
99+
"useBroadcastChannel": "1.07 kB",
100+
"useVModel": "1.06 kB",
101+
"usePreferredDark": "1.06 kB",
102+
"useElementByPoint": "1.05 kB",
103+
"useElementHover": "1.05 kB",
104+
"useAsyncState": "1.04 kB",
105+
"useFps": "1.04 kB",
106+
"useStepper": "1.03 kB",
107+
"useMediaQuery": "1.02 kB",
108+
"useShare": "1.02 kB",
109+
"useAsyncQueue": "1.02 kB",
110+
"useTimeoutPoll": "1.02 kB",
111+
"useMemoize": "1 kB",
112+
"useEventListener": "997 B",
113+
"useCssVar": "990 B",
114+
"useConfirmDialog": "985 B",
115+
"useFileDialog": "978 B",
116+
"asyncComputed": "960 B",
117+
"computedAsync": "960 B",
118+
"useEventBus": "948 B",
119+
"useEyeDropper": "940 B",
120+
"useCycleList": "931 B",
121+
"useFavicon": "930 B",
122+
"useRafFn": "928 B",
123+
"useWebWorker": "927 B",
124+
"mapGamepadToXbox360Controller": "911 B",
125+
"templateRef": "905 B",
126+
"useTextareaAutosize": "889 B",
127+
"useObjectUrl": "884 B",
128+
"StorageSerializers": "874 B",
129+
"useSupported": "823 B",
130+
"useCurrentElement": "813 B",
131+
"computedInject": "803 B",
132+
"DefaultMagicKeysAliasMap": "793 B",
133+
"useTemplateRefsList": "793 B",
134+
"useCached": "792 B",
135+
"unrefElement": "783 B",
136+
"breakpointsSematic": "780 B",
137+
"useMounted": "777 B",
138+
"createUnrefFn": "770 B",
139+
"breakpointsAntDesign": "769 B",
140+
"breakpointsBootstrapV5": "767 B",
141+
"breakpointsTailwind": "763 B",
142+
"breakpointsQuasar": "762 B",
143+
"breakpointsVuetify": "754 B",
144+
"getSSRHandler": "745 B",
145+
"setSSRHandler": "743 B",
146+
"defaultNavigator": "735 B",
147+
"defaultLocation": "732 B",
148+
"defaultDocument": "731 B",
149+
"defaultWindow": "731 B",
150+
"SwipeDirection": "724 B",
151+
"TransitionPresets": "723 B",
152+
"VOnClickOutside": "7.75 kB",
153+
"vOnClickOutside": "7.75 kB",
154+
"vScroll": "7.53 kB",
155+
"vOnKeyStroke": "7.52 kB",
156+
"vElementSize": "7.52 kB",
157+
"vElementVisibility": "7.51 kB",
158+
"vElementHover": "7.5 kB",
159+
"VOnLongPress": "7.5 kB",
160+
"vOnLongPress": "7.5 kB",
161+
"vIntersectionObserver": "7.49 kB",
162+
"vInfiniteScroll": "7.48 kB",
163+
"UseDraggable": "7.48 kB",
164+
"UseEyeDropper": "7.47 kB",
165+
"UseFullscreen": "7.47 kB",
166+
"UseDeviceOrientation": "7.46 kB",
167+
"UseDevicesList": "7.46 kB",
168+
"UseOnline": "7.46 kB",
169+
"UseGeolocation": "7.46 kB",
170+
"UseMouseInElement": "7.46 kB",
171+
"UseColorMode": "7.46 kB",
172+
"UsePreferredDark": "7.46 kB",
173+
"UseTimestamp": "7.46 kB",
174+
"OnLongPress": "7.46 kB",
175+
"UseNetwork": "7.46 kB",
176+
"UseBrowserLocation": "7.46 kB",
177+
"UseActiveElement": "7.46 kB",
178+
"UseMousePressed": "7.46 kB",
179+
"OnClickOutside": "7.45 kB",
180+
"vScrollLock": "7.45 kB",
181+
"UsePreferredLanguages": "7.45 kB",
182+
"UseDocumentVisibility": "7.45 kB",
183+
"UseElementVisibility": "7.45 kB",
184+
"UseTimeAgo": "7.45 kB",
185+
"UseWindowSize": "7.45 kB",
186+
"UseBattery": "7.45 kB",
187+
"UsePointer": "7.45 kB",
188+
"UseObjectUrl": "7.45 kB",
189+
"UsePageLeave": "7.45 kB",
190+
"UseIdle": "7.44 kB",
191+
"UseMouse": "7.44 kB",
192+
"UseDark": "7.44 kB",
193+
"UseWindowFocus": "7.44 kB",
194+
"UseVirtualList": "7.44 kB",
195+
"UseScreenSafeArea": "7.42 kB",
196+
"UseElementBounding": "7.42 kB",
197+
"UseNow": "7.41 kB",
198+
"UsePreferredReducedMotion": "7.41 kB",
199+
"UseDevicePixelRatio": "7.41 kB",
200+
"UseElementSize": "7.41 kB",
201+
"UseImage": "7.4 kB",
202+
"UsePreferredColorScheme": "7.4 kB",
203+
"UseDeviceMotion": "7.4 kB",
204+
"UseOffsetPagination": "7.4 kB",
205+
"useToFixed": "300 B",
206+
"useProjection": "278 B",
207+
"useMath": "274 B",
208+
"useAverage": "273 B",
209+
"useSum": "270 B",
210+
"useMin": "266 B",
211+
"createProjection": "264 B",
212+
"useMax": "261 B",
213+
"useClamp": "259 B",
214+
"usePrecision": "246 B",
215+
"createGenericProjection": "210 B",
216+
"and": "204 B",
217+
"logicAnd": "204 B",
218+
"useTrunc": "204 B",
219+
"useCeil": "202 B",
220+
"logicOr": "201 B",
221+
"or": "201 B",
222+
"useRound": "200 B",
223+
"useAbs": "199 B",
224+
"useFloor": "199 B",
225+
"logicNot": "192 B",
226+
"not": "192 B",
227+
"default": "671 B",
228+
"useRouteQuery": "461 B",
229+
"useRouteParams": "454 B",
230+
"useRouteHash": "185 B",
231+
"useAxios": "1.4 kB",
232+
"useAsyncValidator": "1.2 kB",
233+
"useDrauu": "957 B",
234+
"createCookies": "771 B",
235+
"useCookies": "730 B",
236+
"useFocusTrap": "681 B",
237+
"useFuse": "490 B",
238+
"useNProgress": "462 B",
239+
"useChangeCase": "447 B",
240+
"useJwt": "359 B",
241+
"useQRCode": "339 B",
242+
"useSubject": "310 B",
243+
"useObservable": "279 B",
244+
"useSubscription": "222 B",
245+
"fromEvent": "210 B",
246+
"from": "153 B",
247+
"toObserver": "88 B",
248+
"useFirestore": "506 B",
249+
"useRTDB": "287 B",
250+
"useAuth": "164 B",
251+
"useIpcRenderer": "535 B",
252+
"useZoomFactor": "393 B",
253+
"useZoomLevel": "358 B",
254+
"useIpcRendererOn": "336 B",
255+
"useIpcRendererInvoke": "303 B",
256+
"watchTriggerable": "987 B",
257+
"throttledWatch": "824 B",
258+
"watchThrottled": "824 B",
259+
"debouncedWatch": "786 B",
260+
"watchDebounced": "786 B",
261+
"ignorableWatch": "763 B",
262+
"watchIgnorable": "763 B",
263+
"useDateFormat": "734 B",
264+
"pausableWatch": "714 B",
265+
"watchPausable": "714 B",
266+
"until": "653 B",
267+
"useInterval": "638 B",
268+
"useTimeout": "621 B",
269+
"watchAtMost": "561 B",
270+
"toRefs": "525 B",
271+
"controlledRef": "523 B",
272+
"refWithControl": "516 B",
273+
"computedEager": "468 B",
274+
"eagerComputed": "468 B",
275+
"formatDate": "458 B",
276+
"refThrottled": "454 B",
277+
"throttledRef": "454 B",
278+
"useThrottle": "454 B",
279+
"makeDestructurable": "430 B",
280+
"watchWithFilter": "421 B",
281+
"debouncedRef": "415 B",
282+
"refDebounced": "415 B",
283+
"useDebounce": "415 B",
284+
"reactiveOmit": "407 B",
285+
"useThrottleFn": "400 B",
286+
"useIntervalFn": "394 B",
287+
"reactifyObject": "374 B",
288+
"useDebounceFn": "368 B",
289+
"useTimeoutFn": "347 B",
290+
"reactiveComputed": "342 B",
291+
"normalizeDate": "332 B",
292+
"computedWithControl": "330 B",
293+
"controlledComputed": "330 B",
294+
"extendRef": "330 B",
295+
"watchArray": "330 B",
296+
"toReactive": "320 B",
297+
"autoResetRef": "315 B",
298+
"refAutoReset": "315 B",
299+
"syncRef": "315 B",
300+
"throttleFilter": "313 B",
301+
"debounceFilter": "289 B",
302+
"createSharedComposable": "287 B",
303+
"useToggle": "285 B",
304+
"useToNumber": "278 B",
305+
"useCounter": "258 B",
306+
"createReactiveFn": "250 B",
307+
"reactify": "250 B",
308+
"useArrayReduce": "246 B",
309+
"increaseWithUnit": "239 B",
310+
"syncRefs": "236 B",
311+
"createEventHook": "232 B",
312+
"pausableFilter": "224 B",
313+
"useArrayFindIndex": "220 B",
314+
"useArrayFind": "218 B",
315+
"useLastChanged": "218 B",
316+
"useArrayJoin": "215 B",
317+
"useArraySome": "215 B",
318+
"set": "214 B",
319+
"useArrayEvery": "210 B",
320+
"useArrayFilter": "209 B",
321+
"useArrayMap": "208 B",
322+
"createSingletonPromise": "203 B",
323+
"reactivePick": "201 B",
324+
"createInjectionState": "200 B",
325+
"__onlyVue3": "199 B",
326+
"directiveHooks": "198 B",
327+
"createGlobalState": "197 B",
328+
"useToString": "195 B",
329+
"createFilterWrapper": "193 B",
330+
"objectPick": "193 B",
331+
"refDefault": "193 B",
332+
"tryOnBeforeMount": "192 B",
333+
"tryOnMounted": "191 B",
334+
"promiseTimeout": "189 B",
335+
"resolveRef": "188 B",
336+
"watchOnce": "187 B",
337+
"tryOnScopeDispose": "183 B",
338+
"get": "179 B",
339+
"rand": "177 B",
340+
"resolveUnref": "176 B",
341+
"isWindow": "175 B",
342+
"whenever": "174 B",
343+
"tryOnBeforeUnmount": "173 B",
344+
"tryOnUnmounted": "169 B",
345+
"clamp": "165 B",
346+
"containsProp": "165 B",
347+
"isObject": "164 B",
348+
"isDefined": "158 B",
349+
"assert": "155 B",
350+
"isBoolean": "151 B",
351+
"now": "151 B",
352+
"isFunction": "148 B",
353+
"bypassFilter": "147 B",
354+
"isString": "146 B",
355+
"invoke": "145 B",
356+
"isNumber": "145 B",
357+
"timestamp": "145 B",
358+
"noop": "144 B",
359+
"isDef": "143 B",
360+
"identity": "138 B",
361+
"isIOS": "136 B",
362+
"isClient": "133 B"
363+
}

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy