vueuse-core-skilld
Collection of essential Vue Composition Utilities. ALWAYS use when writing code importing "@vueuse/core". Consult for debugging, best practices, or modifying @vueuse/core, vueuse/core, vueuse core, vueuse.
What this skill does
# vueuse/vueuse `@vueuse/[email protected]` **Tags:** vue2: 2.0.35, vue3: 3.0.35, demi: 4.0.0-alpha.0 **References:** [Docs](./references/docs/_INDEX.md) ## API Changes This section documents version-specific API changes — prioritize recent major/minor releases. - BREAKING: `computedAsync` — default `flush` changed from `pre` to `sync` in v14.0.0; code relying on deferred evaluation now runs synchronously by default [source](./references/releases/v14.0.0.md#breaking-changes) - BREAKING: `useThrottleFn` — aligned with traditional throttle behavior in v14.0.0 (trailing call behavior changed); previously called on both leading and trailing by default, verify options match expected behavior [source](./references/releases/v14.0.0.md#breaking-changes) - BREAKING: `createSharedComposable` — on client side, now returns only the shared composable (single value) instead of a tuple/object in v14.0.0 [source](./references/releases/v14.0.0.md#breaking-changes) - BREAKING: `useAsyncState` — in v13.7.0, `globalThis.reportError` is now the default `onError` handler; previously errors were silently swallowed if no handler was provided [source](./references/releases/v13.7.0.md#breaking-changes) - BREAKING: CJS build dropped in v13.0.0 — `@vueuse/core` is now ESM-only; `require('@vueuse/core')` no longer works [source](./references/releases/v13.0.0.md#breaking-changes) - BREAKING: Vue 3.5 is now required as a minimum peer dependency since v14.0.0 [source](./references/releases/v14.0.0.md#breaking-changes) - DEPRECATED: `watchPausable` — will be removed in a future version; Vue 3.5 native `watch()` now returns `{ stop, pause, resume }` directly; use `const { pause, resume } = watch(src, cb)` instead [source](./references/docs/shared/watchPausable/index.md) - DEPRECATED: `computedEager` — will be removed in a future version; Vue 3.4+ `computed()` no longer triggers dependents when the value does not change, making this unnecessary [source](./references/docs/shared/computedEager/index.md) - DEPRECATED: `templateRef(key)` — deprecated in v13.6.0; use Vue's built-in `useTemplateRef()` instead [source](./references/releases/v13.6.0.md#features) - DEPRECATED: `executeTransition()` — use the new `transition()` function instead; `UseTransitionOptions.transition` option also deprecated, use `easing` [source](./references/releases/v14.0.0.md#features) - DEPRECATED: `breakpointsVuetify` — was an alias for `breakpointsVuetifyV2`; now deprecated, explicitly use `breakpointsVuetifyV2` or `breakpointsVuetifyV3` [source](./references/docs/core/useBreakpoints/index.md) - DEPRECATED: `asyncComputed` — alias for `computedAsync`, removed from v14 alias exports; import as `computedAsync` [source](./references/docs/core/computedAsync/index.md) - NEW: `refManualReset(defaultValue)` — added in v14.0.0; creates a ref with a `.reset()` method that restores the initial value [source](./references/releases/v14.0.0.md#features) - NEW: `useCssSupports(property, value)` / `useCssSupports(conditionText)` — added in v14.2.0; reactive wrapper for `CSS.supports()` [source](./references/releases/v14.2.0.md#features) - NEW: `useTimeAgoIntl(time, options)` — added in v13.7.0; Intl-based time-ago formatting using `Intl.RelativeTimeFormat`, supports custom units [source](./references/releases/v13.7.0.md#features) - NEW: `transition(source, from, to, options)` — added in v14.0.0 as the non-deprecated replacement for `executeTransition`; also adds `interpolation` option for custom interpolator functions [source](./references/releases/v14.0.0.md#features) - NEW: `ConfigurableScheduler` interface + `scheduler` option — added in v14.2.0 to timed composables (`useCountdown`, `useNow`, `useTimestamp`, `useTimeAgo`, `useTimeAgoIntl`, `useElementByPoint`, `useMemory`, `useVibrate`); replaces deprecated per-composable `interval`/`immediate` options [source](./references/releases/v14.2.0.md#features) - NEW: `useIdle` — now implements `Stoppable` interface (v14.0.0), returns `{ pause, resume, stop }` in addition to previous return values [source](./references/releases/v14.0.0.md#features) **Also changed:** `useIntersectionObserver` rootMargin is now reactive (v14.2.0) · `useElementVisibility` gains `initialValue` option (v14.1.0) and inherits reactive `rootMargin` (v14.2.0) · `useDropZone` gains `checkValidity` function (v14.1.0) · `useRefHistory` gains `shouldCommit` option (v13.4.0) · `useUrlSearchParams` gains `stringify` option (v13.4.0) · `watchAtMost` now returns `{ pause, resume }` (v14.0.0) · `useStorageAsync` gains `onReady` option and Promise return (v13.6.0) · `useAsyncState` initial value can now be a ref (v14.0.0) · `useSortable` gains `watchElement` option (v14.2.0) · `useWebSocket` `autoConnect.delay` accepts a function (v14.1.0) · `useClipboardItems` exposes `read()` method (v13.7.0) · `useDraggable` gains auto-scroll with container-restricted dragging (v14.2.0) · `useEventSource` gains `serializer` option (v13.8.0) · `onLongPress` `delay` can now be a function (v14.0.0) · `onClickOutside` target can now be a getter function (v14.0.0) ## Best Practices - Pass reactive getters (`() => value`) as arguments instead of plain refs where possible — VueUse 9+ supports getter arguments, enabling derived reactive values without an intermediate `computed` (e.g. `useTitle(() => isDark.value ? 'Night' : 'Day')`) [source](./references/docs/guide/best-practice.md#reactive-getter-argument) - Wrap `useFetch` calls in `createFetch` for app-wide config — sets base URL, auth headers, and CORS mode once; individual call sites inherit it without re-specifying options [source](./references/docs/core/useFetch/index.md#creating-a-custom-instance) - Use `eventFilter` option with `throttleFilter` / `debounceFilter` instead of manually wrapping callbacks — applies rate-limiting at the composable level for `useLocalStorage`, `useMouse`, and other event-driven composables [source](./references/docs/guide/config.md#event-filters) - Enable `mergeDefaults: true` (or pass a custom merge function) on `useStorage` when evolving stored object schemas — without it, new default keys are `undefined` if absent from existing storage data [source](./references/docs/core/useStorage/index.md#merge-defaults) - Use `StorageSerializers` from `@vueuse/core` when the `useStorage` default value is `null` — without a serializer hint, the type cannot be inferred and serialization falls back to raw string [source](./references/docs/core/useStorage/index.md#custom-serialization) - Use `createSharedComposable` to share a single composable instance across components — avoids duplicate event listeners and state. Note: in SSR it automatically falls back to a non-shared instance per call to prevent cross-request pollution [source](./references/docs/shared/createSharedComposable/index.md#usage) - Use `computedWithControl` when a computed value should only update on specific sources, not all its reactive dependencies — `computed` cannot opt out of automatic dependency tracking, but `computedWithControl` decouples the watch source from the getter [source](./references/docs/shared/computedWithControl/index.md#usage) - Wrap VueUse calls outside component scope with `effectScope()` and call `scope.stop()` for cleanup — not all composables return a stop handle; `effectScope` is the universal escape hatch when composables are used in stores or non-component contexts [source](./references/docs/guide/best-practice.md#side-effect-clean-up) - Pass `window` option to browser composables like `useMouse` or `useScroll` to target iframes or mock globals in tests — all browser API composables accept configurable global dependencies via options [source](./references/docs/guide/config.md#global-dependencies) - Pass a custom `scheduler` to time-based composables (`useNow`, `useCountdown`, etc.) to align them with `useRafFn` or throttle their update rate — introduced in v14.1.0 / v14.2.0; without it, timed composables run on their own internal interval in
Related in Web Dev
generating-lwc-components
IncludedLightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc/**/*.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use generating-apex), Aura components, or Visualforce.
tanstack-query
IncludedManage server state in React with TanStack Query v5. Set up queries with useQuery, mutations with useMutation, configure QueryClient caching strategies, implement optimistic updates, and handle infinite scroll with useInfiniteQuery. Use when: setting up data fetching in React projects, migrating from v4 to v5, or fixing object syntax required errors, query callbacks removed issues, cacheTime renamed to gcTime, isPending vs isLoading confusion, keepPreviousData removed problems.
document-processor-api
IncludedProcess documents with Nutrient DWS. Use when the user wants to generate PDFs from HTML or URLs, convert Office/images/PDFs, assemble or split packets, OCR scans, extract text/tables/key-value pairs, redact PII, watermark, sign, fill forms, optimize PDFs, or produce compliance outputs like PDF/A or PDF/UA. Triggers include convert to PDF, merge these PDFs, OCR this scan, extract tables, redact PII, sign this PDF, make this PDF/A, or linearize for web delivery.
nutrient-document-processing
IncludedProcess documents with Nutrient DWS. Use when the user wants to generate PDFs from HTML or URLs, convert Office/images/PDFs, assemble or split packets, OCR scans, extract text/tables/key-value pairs, redact PII, watermark, sign, fill forms, optimize PDFs, or produce compliance outputs like PDF/A or PDF/UA. Triggers include convert to PDF, merge these PDFs, OCR this scan, extract tables, redact PII, sign this PDF, make this PDF/A, or linearize for web delivery.
tanstack-query
IncludedManage server state in React with TanStack Query v5. Covers useMutationState, simplified optimistic updates, throwOnError, network mode (offline/PWA), and infiniteQueryOptions. Use when setting up data fetching, fixing v4→v5 migration errors (object syntax, gcTime, isPending, keepPreviousData), or debugging SSR/hydration issues with streaming server components.
accelint-nextjs-best-practices
IncludedNext.js performance optimization and best practices. Use when writing Next.js code (App Router or Pages Router); implementing Server Components, Server Actions, or API routes; optimizing RSC serialization, data fetching, or server-side rendering; reviewing Next.js code for performance issues; fixing authentication in Server Actions; or implementing Suspense boundaries, parallel data fetching, or request deduplication.