y-vue-js 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.trae/rules/y-vue-js.md +3 -0
- package/.trae/skills/create-adaptable-composable/SKILL.md +71 -0
- package/.trae/skills/vue-best-practices/SKILL.md +150 -0
- package/.trae/skills/vue-best-practices/references/animation-class-based-technique.md +254 -0
- package/.trae/skills/vue-best-practices/references/animation-state-driven-technique.md +291 -0
- package/.trae/skills/vue-best-practices/references/component-async.md +97 -0
- package/.trae/skills/vue-best-practices/references/component-data-flow.md +307 -0
- package/.trae/skills/vue-best-practices/references/component-fallthrough-attrs.md +174 -0
- package/.trae/skills/vue-best-practices/references/component-keep-alive.md +137 -0
- package/.trae/skills/vue-best-practices/references/component-slots.md +216 -0
- package/.trae/skills/vue-best-practices/references/component-suspense.md +228 -0
- package/.trae/skills/vue-best-practices/references/component-teleport.md +108 -0
- package/.trae/skills/vue-best-practices/references/component-transition-group.md +128 -0
- package/.trae/skills/vue-best-practices/references/component-transition.md +125 -0
- package/.trae/skills/vue-best-practices/references/composables.md +290 -0
- package/.trae/skills/vue-best-practices/references/directives.md +162 -0
- package/.trae/skills/vue-best-practices/references/perf-avoid-component-abstraction-in-lists.md +159 -0
- package/.trae/skills/vue-best-practices/references/perf-v-once-v-memo-directives.md +182 -0
- package/.trae/skills/vue-best-practices/references/perf-virtualize-large-lists.md +187 -0
- package/.trae/skills/vue-best-practices/references/plugins.md +166 -0
- package/.trae/skills/vue-best-practices/references/reactivity.md +344 -0
- package/.trae/skills/vue-best-practices/references/render-functions.md +201 -0
- package/.trae/skills/vue-best-practices/references/sfc.md +310 -0
- package/.trae/skills/vue-best-practices/references/state-management.md +135 -0
- package/.trae/skills/vue-best-practices/references/updated-hook-performance.md +187 -0
- package/.trae/skills/vue-debug-guides/SKILL.md +202 -0
- package/.trae/skills/vue-debug-guides/reference/animation-key-for-rerender.md +160 -0
- package/.trae/skills/vue-debug-guides/reference/animation-transitiongroup-performance.md +241 -0
- package/.trae/skills/vue-debug-guides/reference/async-component-error-handling.md +115 -0
- package/.trae/skills/vue-debug-guides/reference/async-component-keepalive-ref-issue.md +112 -0
- package/.trae/skills/vue-debug-guides/reference/async-component-suspense-control.md +84 -0
- package/.trae/skills/vue-debug-guides/reference/async-component-vue-router.md +109 -0
- package/.trae/skills/vue-debug-guides/reference/attrs-event-listener-merging.md +205 -0
- package/.trae/skills/vue-debug-guides/reference/checkbox-true-false-value-form-submission.md +118 -0
- package/.trae/skills/vue-debug-guides/reference/cleanup-side-effects.md +172 -0
- package/.trae/skills/vue-debug-guides/reference/click-events-on-components.md +180 -0
- package/.trae/skills/vue-debug-guides/reference/component-naming-conflicts.md +159 -0
- package/.trae/skills/vue-debug-guides/reference/component-ref-requires-defineexpose.md +176 -0
- package/.trae/skills/vue-debug-guides/reference/composable-avoid-hidden-side-effects.md +208 -0
- package/.trae/skills/vue-debug-guides/reference/composable-call-location-restrictions.md +141 -0
- package/.trae/skills/vue-debug-guides/reference/composable-naming-return-pattern.md +139 -0
- package/.trae/skills/vue-debug-guides/reference/composable-tovalue-inside-watcheffect.md +182 -0
- package/.trae/skills/vue-debug-guides/reference/composition-api-not-functional-programming.md +120 -0
- package/.trae/skills/vue-debug-guides/reference/composition-api-script-setup-async-context.md +203 -0
- package/.trae/skills/vue-debug-guides/reference/composition-api-vs-react-hooks-differences.md +156 -0
- package/.trae/skills/vue-debug-guides/reference/computed-array-mutation.md +148 -0
- package/.trae/skills/vue-debug-guides/reference/computed-conditional-dependencies.md +147 -0
- package/.trae/skills/vue-debug-guides/reference/computed-no-parameters.md +159 -0
- package/.trae/skills/vue-debug-guides/reference/computed-no-side-effects.md +107 -0
- package/.trae/skills/vue-debug-guides/reference/computed-return-value-readonly.md +160 -0
- package/.trae/skills/vue-debug-guides/reference/configure-app-before-mount.md +89 -0
- package/.trae/skills/vue-debug-guides/reference/declare-emits-for-documentation.md +212 -0
- package/.trae/skills/vue-debug-guides/reference/define-expose-before-await.md +192 -0
- package/.trae/skills/vue-debug-guides/reference/define-model-default-value-sync.md +139 -0
- package/.trae/skills/vue-debug-guides/reference/defineEmits-must-be-top-level.md +164 -0
- package/.trae/skills/vue-debug-guides/reference/defineEmits-no-runtime-and-type-mixed.md +170 -0
- package/.trae/skills/vue-debug-guides/reference/definemodel-object-mutation-no-emit.md +148 -0
- package/.trae/skills/vue-debug-guides/reference/dom-update-timing-nexttick.md +90 -0
- package/.trae/skills/vue-debug-guides/reference/dynamic-argument-constraints.md +146 -0
- package/.trae/skills/vue-debug-guides/reference/dynamic-component-registration-vite.md +147 -0
- package/.trae/skills/vue-debug-guides/reference/event-modifier-order-matters.md +101 -0
- package/.trae/skills/vue-debug-guides/reference/exact-modifier-for-precise-shortcuts.md +155 -0
- package/.trae/skills/vue-debug-guides/reference/fallthrough-attrs-overwrite-vue3.md +159 -0
- package/.trae/skills/vue-debug-guides/reference/in-dom-template-parsing-caveats.md +149 -0
- package/.trae/skills/vue-debug-guides/reference/inheritattrs-false-for-wrapper-components.md +230 -0
- package/.trae/skills/vue-debug-guides/reference/keepalive-router-nested-double-mount.md +222 -0
- package/.trae/skills/vue-debug-guides/reference/keepalive-transition-memory-leak.md +144 -0
- package/.trae/skills/vue-debug-guides/reference/keyup-modifier-timing.md +137 -0
- package/.trae/skills/vue-debug-guides/reference/lifecycle-dom-access-timing.md +216 -0
- package/.trae/skills/vue-debug-guides/reference/lifecycle-hooks-synchronous-registration.md +156 -0
- package/.trae/skills/vue-debug-guides/reference/lifecycle-ssr-awareness.md +184 -0
- package/.trae/skills/vue-debug-guides/reference/local-components-not-in-descendants.md +151 -0
- package/.trae/skills/vue-debug-guides/reference/mount-return-value.md +88 -0
- package/.trae/skills/vue-debug-guides/reference/multi-root-component-class-attrs.md +93 -0
- package/.trae/skills/vue-debug-guides/reference/native-event-collision-with-emits.md +162 -0
- package/.trae/skills/vue-debug-guides/reference/no-passive-with-prevent.md +141 -0
- package/.trae/skills/vue-debug-guides/reference/no-v-if-with-v-for.md +136 -0
- package/.trae/skills/vue-debug-guides/reference/perf-computed-object-stability.md +157 -0
- package/.trae/skills/vue-debug-guides/reference/perf-props-stability-update-optimization.md +140 -0
- package/.trae/skills/vue-debug-guides/reference/plugin-global-properties-sparingly.md +109 -0
- package/.trae/skills/vue-debug-guides/reference/plugin-install-before-mount.md +124 -0
- package/.trae/skills/vue-debug-guides/reference/plugin-prefer-provide-inject-over-global-properties.md +120 -0
- package/.trae/skills/vue-debug-guides/reference/plugin-typescript-type-augmentation.md +157 -0
- package/.trae/skills/vue-debug-guides/reference/prop-defineprops-scope-limitation.md +161 -0
- package/.trae/skills/vue-debug-guides/reference/provide-inject-debugging-challenges.md +203 -0
- package/.trae/skills/vue-debug-guides/reference/provide-inject-default-value-factory.md +244 -0
- package/.trae/skills/vue-debug-guides/reference/provide-inject-reactivity-not-automatic.md +226 -0
- package/.trae/skills/vue-debug-guides/reference/provide-inject-synchronous-setup.md +235 -0
- package/.trae/skills/vue-debug-guides/reference/reactive-destructuring.md +89 -0
- package/.trae/skills/vue-debug-guides/reference/reactivity-debugging-hooks.md +132 -0
- package/.trae/skills/vue-debug-guides/reference/reactivity-markraw-for-non-reactive.md +149 -0
- package/.trae/skills/vue-debug-guides/reference/reactivity-proxy-identity-hazard.md +96 -0
- package/.trae/skills/vue-debug-guides/reference/reactivity-same-tick-batching.md +166 -0
- package/.trae/skills/vue-debug-guides/reference/ref-value-access.md +61 -0
- package/.trae/skills/vue-debug-guides/reference/refs-in-collections-need-value.md +81 -0
- package/.trae/skills/vue-debug-guides/reference/render-function-avoid-internal-vnode-properties.md +151 -0
- package/.trae/skills/vue-debug-guides/reference/render-function-vnodes-must-be-unique.md +133 -0
- package/.trae/skills/vue-debug-guides/reference/rendering-render-function-h-import-vue3.md +148 -0
- package/.trae/skills/vue-debug-guides/reference/rendering-render-function-return-from-setup.md +148 -0
- package/.trae/skills/vue-debug-guides/reference/rendering-render-function-slots-as-functions.md +168 -0
- package/.trae/skills/vue-debug-guides/reference/rendering-resolve-component-for-string-names.md +231 -0
- package/.trae/skills/vue-debug-guides/reference/select-initial-value-ios-bug.md +91 -0
- package/.trae/skills/vue-debug-guides/reference/self-referencing-component-name.md +157 -0
- package/.trae/skills/vue-debug-guides/reference/sfc-named-exports-forbidden.md +184 -0
- package/.trae/skills/vue-debug-guides/reference/sfc-scoped-css-child-component-styling.md +156 -0
- package/.trae/skills/vue-debug-guides/reference/sfc-scoped-css-dynamic-content.md +193 -0
- package/.trae/skills/vue-debug-guides/reference/sfc-scoped-css-slot-content.md +242 -0
- package/.trae/skills/vue-debug-guides/reference/sfc-script-setup-reactivity.md +195 -0
- package/.trae/skills/vue-debug-guides/reference/slot-forwarding-to-child-components.md +143 -0
- package/.trae/skills/vue-debug-guides/reference/slot-implicit-default-content.md +155 -0
- package/.trae/skills/vue-debug-guides/reference/slot-name-reserved-prop.md +109 -0
- package/.trae/skills/vue-debug-guides/reference/slot-named-scoped-explicit-default.md +95 -0
- package/.trae/skills/vue-debug-guides/reference/slot-render-scope-parent-only.md +135 -0
- package/.trae/skills/vue-debug-guides/reference/slot-v-slot-on-components-or-templates-only.md +122 -0
- package/.trae/skills/vue-debug-guides/reference/ssr-hydration-mismatch-causes.md +280 -0
- package/.trae/skills/vue-debug-guides/reference/ssr-platform-specific-apis.md +256 -0
- package/.trae/skills/vue-debug-guides/reference/state-ssr-cross-request-pollution.md +276 -0
- package/.trae/skills/vue-debug-guides/reference/suspense-no-builtin-error-handling.md +127 -0
- package/.trae/skills/vue-debug-guides/reference/suspense-ssr-hydration-issues.md +159 -0
- package/.trae/skills/vue-debug-guides/reference/tailwind-dynamic-class-generation.md +144 -0
- package/.trae/skills/vue-debug-guides/reference/teleport-scoped-styles-limitation.md +191 -0
- package/.trae/skills/vue-debug-guides/reference/teleport-ssr-hydration.md +152 -0
- package/.trae/skills/vue-debug-guides/reference/teleport-target-must-exist.md +113 -0
- package/.trae/skills/vue-debug-guides/reference/template-expressions-restrictions.md +114 -0
- package/.trae/skills/vue-debug-guides/reference/template-functions-no-side-effects.md +187 -0
- package/.trae/skills/vue-debug-guides/reference/template-ref-null-with-v-if.md +123 -0
- package/.trae/skills/vue-debug-guides/reference/template-ref-unwrapping-top-level.md +104 -0
- package/.trae/skills/vue-debug-guides/reference/template-ref-v-for-order.md +172 -0
- package/.trae/skills/vue-debug-guides/reference/textarea-no-interpolation.md +72 -0
- package/.trae/skills/vue-debug-guides/reference/transition-group-flip-inline-elements.md +152 -0
- package/.trae/skills/vue-debug-guides/reference/transition-group-move-animation-position-absolute.md +130 -0
- package/.trae/skills/vue-debug-guides/reference/transition-group-no-default-wrapper-vue3.md +152 -0
- package/.trae/skills/vue-debug-guides/reference/transition-js-hooks-done-callback.md +251 -0
- package/.trae/skills/vue-debug-guides/reference/transition-nested-duration.md +182 -0
- package/.trae/skills/vue-debug-guides/reference/transition-reusable-scoped-style.md +245 -0
- package/.trae/skills/vue-debug-guides/reference/transition-router-view-appear.md +193 -0
- package/.trae/skills/vue-debug-guides/reference/transition-type-when-mixed.md +172 -0
- package/.trae/skills/vue-debug-guides/reference/transition-unmount-hook-timing.md +149 -0
- package/.trae/skills/vue-debug-guides/reference/ts-defineprops-boolean-default-false.md +225 -0
- package/.trae/skills/vue-debug-guides/reference/ts-defineprops-imported-types-limitations.md +281 -0
- package/.trae/skills/vue-debug-guides/reference/ts-event-handler-explicit-typing.md +213 -0
- package/.trae/skills/vue-debug-guides/reference/ts-reactive-no-generic-argument.md +196 -0
- package/.trae/skills/vue-debug-guides/reference/ts-shallowref-for-dynamic-components.md +218 -0
- package/.trae/skills/vue-debug-guides/reference/ts-template-ref-null-handling.md +249 -0
- package/.trae/skills/vue-debug-guides/reference/ts-template-type-casting.md +214 -0
- package/.trae/skills/vue-debug-guides/reference/ts-withdefaults-mutable-factory-function.md +171 -0
- package/.trae/skills/vue-debug-guides/reference/undeclared-emits-double-firing.md +195 -0
- package/.trae/skills/vue-debug-guides/reference/use-template-ref-vue35.md +158 -0
- package/.trae/skills/vue-debug-guides/reference/v-else-must-follow-v-if.md +136 -0
- package/.trae/skills/vue-debug-guides/reference/v-for-component-props.md +95 -0
- package/.trae/skills/vue-debug-guides/reference/v-for-computed-reverse-sort.md +86 -0
- package/.trae/skills/vue-debug-guides/reference/v-for-key-attribute.md +90 -0
- package/.trae/skills/vue-debug-guides/reference/v-for-range-starts-at-one.md +66 -0
- package/.trae/skills/vue-debug-guides/reference/v-if-null-check-order.md +171 -0
- package/.trae/skills/vue-debug-guides/reference/v-model-ignores-html-attributes.md +83 -0
- package/.trae/skills/vue-debug-guides/reference/v-model-ime-composition.md +83 -0
- package/.trae/skills/vue-debug-guides/reference/v-model-number-modifier-behavior.md +124 -0
- package/.trae/skills/vue-debug-guides/reference/v-show-template-limitation.md +124 -0
- package/.trae/skills/vue-debug-guides/reference/watch-async-cleanup.md +180 -0
- package/.trae/skills/vue-debug-guides/reference/watch-async-creation-memory-leak.md +176 -0
- package/.trae/skills/vue-debug-guides/reference/watch-deep-same-object-reference.md +165 -0
- package/.trae/skills/vue-debug-guides/reference/watch-flush-timing.md +189 -0
- package/.trae/skills/vue-debug-guides/reference/watch-reactive-property-getter.md +108 -0
- package/.trae/skills/vue-debug-guides/reference/watcheffect-async-dependency-tracking.md +173 -0
- package/.trae/skills/vue-debug-guides/reference/watcheffect-flush-post-for-refs.md +176 -0
- package/.trae/skills/vue-options-api-best-practices/SKILL.md +20 -0
- package/.trae/skills/vue-options-api-best-practices/reference/no-arrow-functions-in-lifecycle-hooks.md +95 -0
- package/.trae/skills/vue-options-api-best-practices/reference/no-arrow-functions-in-methods.md +68 -0
- package/.trae/skills/vue-options-api-best-practices/reference/stateful-methods-lifecycle.md +61 -0
- package/.trae/skills/vue-options-api-best-practices/reference/ts-options-api-arrow-functions-validators.md +141 -0
- package/.trae/skills/vue-options-api-best-practices/reference/ts-options-api-computed-return-types.md +192 -0
- package/.trae/skills/vue-options-api-best-practices/reference/ts-options-api-proptype-complex-types.md +212 -0
- package/.trae/skills/vue-options-api-best-practices/reference/ts-options-api-provide-inject-limitations.md +135 -0
- package/.trae/skills/vue-options-api-best-practices/reference/ts-options-api-type-event-handlers.md +202 -0
- package/.trae/skills/vue-options-api-best-practices/reference/ts-options-api-use-definecomponent.md +172 -0
- package/.trae/skills/vue-options-api-best-practices/reference/ts-strict-mode-options-api.md +197 -0
- package/.trae/skills/vue-pinia-best-practices/SKILL.md +18 -0
- package/.trae/skills/vue-pinia-best-practices/reference/pinia-no-active-pinia-error.md +248 -0
- package/.trae/skills/vue-pinia-best-practices/reference/pinia-setup-store-return-all-state.md +227 -0
- package/.trae/skills/vue-pinia-best-practices/reference/pinia-store-destructuring-breaks-reactivity.md +193 -0
- package/.trae/skills/vue-pinia-best-practices/reference/state-url-for-ephemeral-filters.md +238 -0
- package/.trae/skills/vue-pinia-best-practices/reference/state-use-pinia-for-large-apps.md +262 -0
- package/.trae/skills/vue-pinia-best-practices/reference/store-method-binding-parentheses.md +191 -0
- package/.trae/skills/vue-testing-best-practices/SKILL.md +26 -0
- package/.trae/skills/vue-testing-best-practices/reference/async-component-testing.md +163 -0
- package/.trae/skills/vue-testing-best-practices/reference/teleport-testing-complexity.md +158 -0
- package/.trae/skills/vue-testing-best-practices/reference/testing-async-await-flushpromises.md +175 -0
- package/.trae/skills/vue-testing-best-practices/reference/testing-browser-vs-node-runners.md +208 -0
- package/.trae/skills/vue-testing-best-practices/reference/testing-component-blackbox-approach.md +144 -0
- package/.trae/skills/vue-testing-best-practices/reference/testing-composables-helper-wrapper.md +238 -0
- package/.trae/skills/vue-testing-best-practices/reference/testing-e2e-playwright-recommended.md +242 -0
- package/.trae/skills/vue-testing-best-practices/reference/testing-no-snapshot-only.md +197 -0
- package/.trae/skills/vue-testing-best-practices/reference/testing-pinia-store-setup.md +228 -0
- package/.trae/skills/vue-testing-best-practices/reference/testing-suspense-async-components.md +229 -0
- package/.trae/skills/vue-testing-best-practices/reference/testing-vitest-recommended-for-vue.md +204 -0
- package/.vscode/extensions.json +3 -0
- package/README.md +5 -0
- package/index.html +13 -0
- package/package.json +32 -0
- package/public/vite.svg +1 -0
- package/src/App.vue +30 -0
- package/src/assets/vue.svg +1 -0
- package/src/components/HelloWorld.vue +41 -0
- package/src/main.ts +5 -0
- package/src/package/index.ts +1 -0
- package/src/package/utils/CaseTransUtils.ts +239 -0
- package/src/package/utils/EmptyUtils.ts +208 -0
- package/src/package/utils/MathUtils.ts +192 -0
- package/src/package/utils/ObjectUtils.ts +244 -0
- package/src/package/utils/RegexUtils.ts +199 -0
- package/src/package/utils/UuidUtils.ts +63 -0
- package/src/package/utils/index.ts +25 -0
- package/src/package/utils/request/Request.ts +119 -0
- package/src/package/utils/request/RequestInterfaces.ts +35 -0
- package/src/package/utils/request/RequestMethod.ts +16 -0
- package/src/package/utils/request/RequestTypes.ts +45 -0
- package/src/package/utils/request/example/ApiRequest.ts +99 -0
- package/src/package/utils/request/example/ApiUrl.ts +18 -0
- package/src/package/utils/request/example/DefaultRequestOptions.ts +41 -0
- package/src/package/utils/request/example/RequestAdapter.ts +115 -0
- package/src/package/utils/request/example/RequestIntercept.ts +32 -0
- package/src/package/utils/request/example/Response.ts +21 -0
- package/src/package/utils/request/index.ts +16 -0
- package/src/style.css +79 -0
- package/tsconfig.app.json +16 -0
- package/tsconfig.json +20 -0
- package/tsconfig.node.json +26 -0
- package/vite.config.ts +23 -0
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: create-adaptable-composable
|
|
3
|
+
description: Create a library-grade Vue composable that accepts maybe-reactive inputs (MaybeRef / MaybeRefOrGetter) so callers can pass a plain value, ref, or getter. Normalize inputs with toValue()/toRef() inside reactive effects (watch/watchEffect) to keep behavior predictable and reactive. Use this skill when user asks for creating adaptable or reusable composables.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Create Adaptable Composable
|
|
7
|
+
|
|
8
|
+
Adaptable composables are reusable functions that can accept both reactive and non-reactive inputs. This allows developers to use the composable in a variety of contexts without worrying about the reactivity of the inputs.
|
|
9
|
+
|
|
10
|
+
Steps to design an adaptable composable in Vue.js:
|
|
11
|
+
1. Confirm the composable's purpose and API design and expected inputs/outputs.
|
|
12
|
+
2. Identify inputs params that should be reactive (MaybeRef / MaybeRefOrGetter).
|
|
13
|
+
3. Use `toValue()` or `toRef()` to normalize inputs inside reactive effects.
|
|
14
|
+
4. Implement the core logic of the composable using Vue's reactivity APIs.
|
|
15
|
+
|
|
16
|
+
## Core Type Concepts
|
|
17
|
+
|
|
18
|
+
### Type Utilities
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
/**
|
|
22
|
+
* value or writable ref (value/ref/shallowRef/writable computed)
|
|
23
|
+
*/
|
|
24
|
+
export type MaybeRef<T = any> = T | Ref<T> | ShallowRef<T> | WritableComputedRef<T>;
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* MaybeRef<T> + ComputedRef<T> + () => T
|
|
28
|
+
*/
|
|
29
|
+
export type MaybeRefOrGetter<T = any> = MaybeRef<T> | ComputedRef<T> | (() => T);
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Policy and Rules
|
|
33
|
+
|
|
34
|
+
- Read-only, computed-friendly input: use `MaybeRefOrGetter`
|
|
35
|
+
- Needs to be writable / two-way input: use `MaybeRef`
|
|
36
|
+
- Parameter might be a function value (callback/predicate/comparator): do not use `MaybeRefOrGetter`, or you may accidentally invoke it as a getter.
|
|
37
|
+
- DOM/Element targets: if you want computed/derived targets, use `MaybeRefOrGetter`.
|
|
38
|
+
|
|
39
|
+
When `MaybeRefOrGetter` or `MaybeRef` is used:
|
|
40
|
+
- resolve reactive value using `toRef()` (e.g. watcher source)
|
|
41
|
+
- resolve non-reactive value using `toValue()`
|
|
42
|
+
|
|
43
|
+
### Examples
|
|
44
|
+
|
|
45
|
+
Adaptable `useDocumentTitle` Composable: read-only title parameter
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
import { watch, toRef } from 'vue'
|
|
49
|
+
import type { MaybeRefOrGetter } from 'vue'
|
|
50
|
+
|
|
51
|
+
export function useDocumentTitle(title: MaybeRefOrGetter<string>) {
|
|
52
|
+
watch(toRef(title), (t) => {
|
|
53
|
+
document.title = t
|
|
54
|
+
}, { immediate: true })
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Adaptable `useCounter` Composable: two-way writable count parameter
|
|
59
|
+
|
|
60
|
+
```ts
|
|
61
|
+
import { watch, toRef } from 'vue'
|
|
62
|
+
import type { MaybeRef } from 'vue'
|
|
63
|
+
|
|
64
|
+
function useCounter(count: MaybeRef<number>) {
|
|
65
|
+
const countRef = toRef(count)
|
|
66
|
+
function add() {
|
|
67
|
+
countRef.value++
|
|
68
|
+
}
|
|
69
|
+
return { add }
|
|
70
|
+
}
|
|
71
|
+
```
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: vue-best-practices
|
|
3
|
+
description: "MUST be used for Vue.js tasks. Strongly recommends Composition API with `<script setup>` and TypeScript as the standard approach. Covers Vue 3, SSR, Volar, vue-tsc. Load for any Vue, .vue files, Vue Router, Pinia, or Vite with Vue work. ALWAYS use Composition API unless the project explicitly requires Options API."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Vue Best Practices Workflow
|
|
7
|
+
|
|
8
|
+
Use this skill as an instruction set. Follow the workflow in order unless the user explicitly asks for a different order.
|
|
9
|
+
|
|
10
|
+
## Core Principles
|
|
11
|
+
- **Keep state predictable:** one source of truth, derive everything else.
|
|
12
|
+
- **Make data flow explicit:** Props down, Events up for most cases.
|
|
13
|
+
- **Favor small, focused components:** easier to test, reuse, and maintain.
|
|
14
|
+
- **Avoid unnecessary re-renders:** use computed properties and watchers wisely.
|
|
15
|
+
- **Readability counts:** write clear, self-documenting code.
|
|
16
|
+
|
|
17
|
+
## 1) Confirm architecture before coding (required)
|
|
18
|
+
|
|
19
|
+
- Default stack: Vue 3 + Composition API + `<script setup lang="ts">`.
|
|
20
|
+
- If the project explicitly uses Options API, load `vue-options-api-best-practices` skill if available.
|
|
21
|
+
- If the project explicitly uses JSX, load `vue-jsx-best-practices` skill if available.
|
|
22
|
+
|
|
23
|
+
### 1.1 Must-read core references (required)
|
|
24
|
+
|
|
25
|
+
- Before implementing any Vue task, make sure to read and apply these core references:
|
|
26
|
+
- `references/reactivity.md`
|
|
27
|
+
- `references/sfc.md`
|
|
28
|
+
- `references/component-data-flow.md`
|
|
29
|
+
- `references/composables.md`
|
|
30
|
+
- Keep these references in active working context for the entire task, not only when a specific issue appears.
|
|
31
|
+
|
|
32
|
+
### 1.2 Plan component boundaries before coding (required)
|
|
33
|
+
|
|
34
|
+
Create a brief component map before implementation for any non-trivial feature.
|
|
35
|
+
|
|
36
|
+
- Define each component's single responsibility in one sentence.
|
|
37
|
+
- Keep entry/root and route-level view components as composition surfaces by default.
|
|
38
|
+
- Move feature UI and feature logic out of entry/root/view components unless the task is intentionally a tiny single-file demo.
|
|
39
|
+
- Define props/emits contracts for each child component in the map.
|
|
40
|
+
- Prefer a feature folder layout (`components/<feature>/...`, `composables/use<Feature>.ts`) when adding more than one component.
|
|
41
|
+
|
|
42
|
+
## 2) Apply essential Vue foundations (required)
|
|
43
|
+
|
|
44
|
+
These are essential, must-know foundations. Apply all of them in every Vue task using the core references already loaded in section `1.1`.
|
|
45
|
+
|
|
46
|
+
### Reactivity
|
|
47
|
+
|
|
48
|
+
- Must-read reference from `1.1`: [reactivity](references/reactivity.md)
|
|
49
|
+
- Keep source state minimal (`ref`/`reactive`), derive everything possible with `computed`.
|
|
50
|
+
- Use watchers for side effects if needed.
|
|
51
|
+
- Avoid recomputing expensive logic in templates.
|
|
52
|
+
|
|
53
|
+
### SFC structure and template safety
|
|
54
|
+
|
|
55
|
+
- Must-read reference from `1.1`: [sfc](references/sfc.md)
|
|
56
|
+
- Keep SFC sections in this order: `<script>` → `<template>` → `<style>`.
|
|
57
|
+
- Keep SFC responsibilities focused; split large components.
|
|
58
|
+
- Keep templates declarative; move branching/derivation to script.
|
|
59
|
+
- Apply Vue template safety rules (`v-html`, list rendering, conditional rendering choices).
|
|
60
|
+
|
|
61
|
+
### Keep components focused
|
|
62
|
+
|
|
63
|
+
Split a component when it has **more than one clear responsibility** (e.g. data orchestration + UI, or multiple independent UI sections).
|
|
64
|
+
|
|
65
|
+
- Prefer **smaller components + composables** over one “mega component”
|
|
66
|
+
- Move **UI sections** into child components (props in, events out).
|
|
67
|
+
- Move **state/side effects** into composables (`useXxx()`).
|
|
68
|
+
|
|
69
|
+
Apply objective split triggers. Split the component if **any** condition is true:
|
|
70
|
+
|
|
71
|
+
- It owns both orchestration/state and substantial presentational markup for multiple sections.
|
|
72
|
+
- It has 3+ distinct UI sections (for example: form, filters, list, footer/status).
|
|
73
|
+
- A template block is repeated or could become reusable (item rows, cards, list entries).
|
|
74
|
+
|
|
75
|
+
Entry/root and route view rule:
|
|
76
|
+
|
|
77
|
+
- Keep entry/root and route view components thin: app shell/layout, provider wiring, and feature composition.
|
|
78
|
+
- Do not place full feature implementations in entry/root/view components when those features contain independent parts.
|
|
79
|
+
- For CRUD/list features (todo, table, catalog, inbox), split at least into:
|
|
80
|
+
- feature container component
|
|
81
|
+
- input/form component
|
|
82
|
+
- list (and/or item) component
|
|
83
|
+
- footer/actions or filter/status component
|
|
84
|
+
- Allow a single-file implementation only for very small throwaway demos; if chosen, explicitly justify why splitting is unnecessary.
|
|
85
|
+
|
|
86
|
+
### Component data flow
|
|
87
|
+
|
|
88
|
+
- Must-read reference from `1.1`: [component-data-flow](references/component-data-flow.md)
|
|
89
|
+
- Use props down, events up as the primary model.
|
|
90
|
+
- Use `v-model` only for true two-way component contracts.
|
|
91
|
+
- Use provide/inject only for deep-tree dependencies or shared context.
|
|
92
|
+
- Keep contracts explicit and typed with `defineProps`, `defineEmits`, and `InjectionKey` as needed.
|
|
93
|
+
|
|
94
|
+
### Composables
|
|
95
|
+
|
|
96
|
+
- Must-read reference from `1.1`: [composables](references/composables.md)
|
|
97
|
+
- Extract logic into composables when it is reused, stateful, or side-effect heavy.
|
|
98
|
+
- Keep composable APIs small, typed, and predictable.
|
|
99
|
+
- Separate feature logic from presentational components.
|
|
100
|
+
|
|
101
|
+
## 3) Consider optional features only when requirements call for them
|
|
102
|
+
|
|
103
|
+
### 3.1 Standard optional features
|
|
104
|
+
|
|
105
|
+
Do not add these by default. Load the matching reference only when the requirement exists.
|
|
106
|
+
|
|
107
|
+
- Slots: parent needs to control child content/layout -> [component-slots](references/component-slots.md)
|
|
108
|
+
- Fallthrough attributes: wrapper/base components must forward attrs/events safely -> [component-fallthrough-attrs](references/component-fallthrough-attrs.md)
|
|
109
|
+
- Built-in component `<KeepAlive>` for stateful view caching -> [component-keep-alive](references/component-keep-alive.md)
|
|
110
|
+
- Built-in component `<Teleport>` for overlays/portals -> [component-teleport](references/component-teleport.md)
|
|
111
|
+
- Built-in component `<Suspense>` for async subtree fallback boundaries -> [component-suspense](references/component-suspense.md)
|
|
112
|
+
- Animation-related features: pick the simplest approach that matches the required motion behavior.
|
|
113
|
+
- Built-in component `<Transition>` for enter/leave effects -> [transition](references/component-transition.md)
|
|
114
|
+
- Built-in component `<TransitionGroup>` for animated list mutations -> [transition-group](references/component-transition-group.md)
|
|
115
|
+
- Class-based animation for non-enter/leave effects -> [animation-class-based-technique](references/animation-class-based-technique.md)
|
|
116
|
+
- State-driven animation for user-input-driven animation -> [animation-state-driven-technique](references/animation-state-driven-technique.md)
|
|
117
|
+
|
|
118
|
+
### 3.2 Less-common optional features
|
|
119
|
+
|
|
120
|
+
Use these only when there is explicit product or technical need.
|
|
121
|
+
|
|
122
|
+
- Directives: behavior is DOM-specific and not a good composable/component fit -> [directives](references/directives.md)
|
|
123
|
+
- Async components: heavy/rarely-used UI should be lazy loaded -> [component-async](references/component-async.md)
|
|
124
|
+
- Render functions only when templates cannot express the requirement -> [render-functions](references/render-functions.md)
|
|
125
|
+
- Plugins when behavior must be installed app-wide -> [plugins](references/plugins.md)
|
|
126
|
+
- State management patterns: app-wide shared state crosses feature boundaries -> [state-management](references/state-management.md)
|
|
127
|
+
|
|
128
|
+
## 4) Run performance optimization after behavior is correct
|
|
129
|
+
|
|
130
|
+
Performance work is a post-functionality pass. Do not optimize before core behavior is implemented and verified.
|
|
131
|
+
|
|
132
|
+
- Large list rendering bottlenecks -> [perf-virtualize-large-lists](references/perf-virtualize-large-lists.md)
|
|
133
|
+
- Static subtrees re-rendering unnecessarily -> [perf-v-once-v-memo-directives](references/perf-v-once-v-memo-directives.md)
|
|
134
|
+
- Over-abstraction in hot list paths -> [perf-avoid-component-abstraction-in-lists](references/perf-avoid-component-abstraction-in-lists.md)
|
|
135
|
+
- Expensive updates triggered too often -> [updated-hook-performance](references/updated-hook-performance.md)
|
|
136
|
+
|
|
137
|
+
## 5) Final self-check before finishing
|
|
138
|
+
|
|
139
|
+
- Core behavior works and matches requirements.
|
|
140
|
+
- All must-read references were read and applied.
|
|
141
|
+
- Reactivity model is minimal and predictable.
|
|
142
|
+
- SFC structure and template rules are followed.
|
|
143
|
+
- Components are focused and well-factored, splitting when needed.
|
|
144
|
+
- Entry/root and route view components remain composition surfaces unless there is an explicit small-demo exception.
|
|
145
|
+
- Component split decisions are explicit and defensible (responsibility boundaries are clear).
|
|
146
|
+
- Data flow contracts are explicit and typed.
|
|
147
|
+
- Composables are used where reuse/complexity justifies them.
|
|
148
|
+
- Moved state/side effects into composables if applicable
|
|
149
|
+
- Optional features are used only when requirements demand them.
|
|
150
|
+
- Performance changes were applied only after functionality was complete.
|
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Use Class-based Animations for Non-Enter/Leave Effects
|
|
3
|
+
impact: LOW
|
|
4
|
+
impactDescription: Class-based animations are simpler and more performant for elements that remain in the DOM
|
|
5
|
+
type: best-practice
|
|
6
|
+
tags: [vue3, animation, css, class-binding, state]
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Use Class-based Animations for Non-Enter/Leave Effects
|
|
10
|
+
|
|
11
|
+
**Impact: LOW** - For animations on elements that are not entering or leaving the DOM, use CSS class-based animations triggered by Vue's reactive state. This is simpler than `<Transition>` and more appropriate for feedback animations like shake, pulse, or highlight effects.
|
|
12
|
+
|
|
13
|
+
## Task List
|
|
14
|
+
|
|
15
|
+
- Use class-based animations for elements staying in the DOM
|
|
16
|
+
- Use `<Transition>` only for enter/leave animations
|
|
17
|
+
- Combine CSS animations with Vue's class bindings (`:class`)
|
|
18
|
+
- Consider using `setTimeout` to auto-remove animation classes
|
|
19
|
+
|
|
20
|
+
**When to Use Class-based Animations:**
|
|
21
|
+
- User feedback (shake on error, pulse on success)
|
|
22
|
+
- Attention-grabbing effects (highlight changes)
|
|
23
|
+
- Hover/focus states that need more than CSS transitions
|
|
24
|
+
- Any animation where the element stays mounted
|
|
25
|
+
|
|
26
|
+
**When to Use Transition Component:**
|
|
27
|
+
- Elements entering/leaving the DOM (v-if/v-show)
|
|
28
|
+
- Route transitions
|
|
29
|
+
- List item additions/removals
|
|
30
|
+
|
|
31
|
+
## Basic Pattern
|
|
32
|
+
|
|
33
|
+
```vue
|
|
34
|
+
<template>
|
|
35
|
+
<div :class="{ shake: showError }">
|
|
36
|
+
<button @click="submitForm">Submit</button>
|
|
37
|
+
<span v-if="showError">This feature is disabled!</span>
|
|
38
|
+
</div>
|
|
39
|
+
</template>
|
|
40
|
+
|
|
41
|
+
<script setup>
|
|
42
|
+
import { ref } from 'vue'
|
|
43
|
+
|
|
44
|
+
const showError = ref(false)
|
|
45
|
+
|
|
46
|
+
function submitForm() {
|
|
47
|
+
if (!isValid()) {
|
|
48
|
+
// Trigger shake animation
|
|
49
|
+
showError.value = true
|
|
50
|
+
|
|
51
|
+
// Auto-remove class after animation completes
|
|
52
|
+
setTimeout(() => {
|
|
53
|
+
showError.value = false
|
|
54
|
+
}, 820) // Match animation duration
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
</script>
|
|
58
|
+
|
|
59
|
+
<style>
|
|
60
|
+
.shake {
|
|
61
|
+
animation: shake 0.82s cubic-bezier(0.36, 0.07, 0.19, 0.97) both;
|
|
62
|
+
transform: translate3d(0, 0, 0); /* Enable GPU acceleration */
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
@keyframes shake {
|
|
66
|
+
10%, 90% { transform: translate3d(-1px, 0, 0); }
|
|
67
|
+
20%, 80% { transform: translate3d(2px, 0, 0); }
|
|
68
|
+
30%, 50%, 70% { transform: translate3d(-4px, 0, 0); }
|
|
69
|
+
40%, 60% { transform: translate3d(4px, 0, 0); }
|
|
70
|
+
}
|
|
71
|
+
</style>
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
## Common Animation Patterns
|
|
75
|
+
|
|
76
|
+
### Pulse on Success
|
|
77
|
+
|
|
78
|
+
```vue
|
|
79
|
+
<template>
|
|
80
|
+
<button
|
|
81
|
+
@click="save"
|
|
82
|
+
:class="{ pulse: saved }"
|
|
83
|
+
>
|
|
84
|
+
{{ saved ? 'Saved!' : 'Save' }}
|
|
85
|
+
</button>
|
|
86
|
+
</template>
|
|
87
|
+
|
|
88
|
+
<script setup>
|
|
89
|
+
import { ref } from 'vue'
|
|
90
|
+
|
|
91
|
+
const saved = ref(false)
|
|
92
|
+
|
|
93
|
+
async function save() {
|
|
94
|
+
await saveData()
|
|
95
|
+
saved.value = true
|
|
96
|
+
setTimeout(() => saved.value = false, 1000)
|
|
97
|
+
}
|
|
98
|
+
</script>
|
|
99
|
+
|
|
100
|
+
<style>
|
|
101
|
+
.pulse {
|
|
102
|
+
animation: pulse 0.5s ease-in-out;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
@keyframes pulse {
|
|
106
|
+
0%, 100% { transform: scale(1); }
|
|
107
|
+
50% { transform: scale(1.05); }
|
|
108
|
+
}
|
|
109
|
+
</style>
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Highlight on Change
|
|
113
|
+
|
|
114
|
+
```vue
|
|
115
|
+
<template>
|
|
116
|
+
<div
|
|
117
|
+
:class="{ highlight: justUpdated }"
|
|
118
|
+
>
|
|
119
|
+
Value: {{ value }}
|
|
120
|
+
</div>
|
|
121
|
+
</template>
|
|
122
|
+
|
|
123
|
+
<script setup>
|
|
124
|
+
import { ref, watch } from 'vue'
|
|
125
|
+
|
|
126
|
+
const value = ref(0)
|
|
127
|
+
const justUpdated = ref(false)
|
|
128
|
+
|
|
129
|
+
watch(value, () => {
|
|
130
|
+
justUpdated.value = true
|
|
131
|
+
setTimeout(() => justUpdated.value = false, 1000)
|
|
132
|
+
})
|
|
133
|
+
</script>
|
|
134
|
+
|
|
135
|
+
<style>
|
|
136
|
+
.highlight {
|
|
137
|
+
animation: highlight 1s ease-out;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
@keyframes highlight {
|
|
141
|
+
0% { background-color: yellow; }
|
|
142
|
+
100% { background-color: transparent; }
|
|
143
|
+
}
|
|
144
|
+
</style>
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Bounce Attention
|
|
148
|
+
|
|
149
|
+
```vue
|
|
150
|
+
<template>
|
|
151
|
+
<div
|
|
152
|
+
:class="{ bounce: needsAttention }"
|
|
153
|
+
@animationend="needsAttention = false"
|
|
154
|
+
>
|
|
155
|
+
<BellIcon />
|
|
156
|
+
</div>
|
|
157
|
+
</template>
|
|
158
|
+
|
|
159
|
+
<script setup>
|
|
160
|
+
import { ref } from 'vue'
|
|
161
|
+
|
|
162
|
+
const needsAttention = ref(false)
|
|
163
|
+
|
|
164
|
+
function notifyUser() {
|
|
165
|
+
needsAttention.value = true
|
|
166
|
+
// No setTimeout needed - using animationend event
|
|
167
|
+
}
|
|
168
|
+
</script>
|
|
169
|
+
|
|
170
|
+
<style>
|
|
171
|
+
.bounce {
|
|
172
|
+
animation: bounce 0.5s ease;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
@keyframes bounce {
|
|
176
|
+
0%, 100% { transform: translateY(0); }
|
|
177
|
+
50% { transform: translateY(-10px); }
|
|
178
|
+
}
|
|
179
|
+
</style>
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
## Using animationend Event
|
|
183
|
+
|
|
184
|
+
Instead of `setTimeout`, use the `animationend` event for cleaner code:
|
|
185
|
+
|
|
186
|
+
```vue
|
|
187
|
+
<template>
|
|
188
|
+
<div
|
|
189
|
+
:class="{ animate: isAnimating }"
|
|
190
|
+
@animationend="isAnimating = false"
|
|
191
|
+
>
|
|
192
|
+
Content
|
|
193
|
+
</div>
|
|
194
|
+
</template>
|
|
195
|
+
|
|
196
|
+
<script setup>
|
|
197
|
+
import { ref } from 'vue'
|
|
198
|
+
|
|
199
|
+
const isAnimating = ref(false)
|
|
200
|
+
|
|
201
|
+
function triggerAnimation() {
|
|
202
|
+
isAnimating.value = true
|
|
203
|
+
// Class is automatically removed when animation ends
|
|
204
|
+
}
|
|
205
|
+
</script>
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
## Composable for Reusable Animations
|
|
209
|
+
|
|
210
|
+
```javascript
|
|
211
|
+
// composables/useAnimation.js
|
|
212
|
+
import { ref } from 'vue'
|
|
213
|
+
|
|
214
|
+
export function useAnimation(duration = 500) {
|
|
215
|
+
const isAnimating = ref(false)
|
|
216
|
+
|
|
217
|
+
function trigger() {
|
|
218
|
+
isAnimating.value = true
|
|
219
|
+
setTimeout(() => {
|
|
220
|
+
isAnimating.value = false
|
|
221
|
+
}, duration)
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
return {
|
|
225
|
+
isAnimating,
|
|
226
|
+
trigger
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
```vue
|
|
232
|
+
<script setup>
|
|
233
|
+
import { useAnimation } from '@/composables/useAnimation'
|
|
234
|
+
|
|
235
|
+
const shake = useAnimation(820)
|
|
236
|
+
const pulse = useAnimation(500)
|
|
237
|
+
</script>
|
|
238
|
+
|
|
239
|
+
<template>
|
|
240
|
+
<button
|
|
241
|
+
:class="{ shake: shake.isAnimating.value }"
|
|
242
|
+
@click="shake.trigger()"
|
|
243
|
+
>
|
|
244
|
+
Shake me
|
|
245
|
+
</button>
|
|
246
|
+
|
|
247
|
+
<button
|
|
248
|
+
:class="{ pulse: pulse.isAnimating.value }"
|
|
249
|
+
@click="pulse.trigger()"
|
|
250
|
+
>
|
|
251
|
+
Pulse me
|
|
252
|
+
</button>
|
|
253
|
+
</template>
|
|
254
|
+
```
|