tanstack-vue-store-skilld
Skill184 starsChanged 37 days agoMITView on GitHub
Vue adapter for TanStack Store, a framework agnostic type-safe store. ALWAYS use when writing code importing \"@tanstack/vue-store\" in a Vue app. Covers the useSelector, useAtom, useStore (deprecated), and _useStore hooks, the re-exported @tanstack/store core API (createStore, createAtom, createAsyncAtom, batch, flush, shallow), debugging, best practices, and migration between @tanstack/vue-store versions.
In this repository35 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- floating-ui-vue-skilldSkill
- formkit-core-skilldSkill
- motion-v-skilldSkill
- pinia-colada-skilldSkill
- pinia-skilldSkill
- primevue-skilldSkill
- quasar-skilldSkill
- reka-ui-skilldSkill
- shadcn-vue-skilldSkill
- slidev-cli-skilldSkill
- tanstack-ai-vue-skilldSkill
- tanstack-vue-form-skilldSkill
- tanstack-vue-query-skilldSkill
- tanstack-vue-router-skilldSkill
- tanstack-vue-table-skilldSkill
- tanstack-vue-virtual-skilldSkill
- tresjs-core-skilldSkill
- unhead-vue-skilldSkill
- unovis-ts-skilldSkill
- unovis-vue-skilldSkill
- vee-validate-skilldSkill
- vitepress-skilldSkill
- vue-data-ui-skilldSkill
- vue-i18n-skilldSkill
- vue-router-skilldSkill
- vue-skilldSkill
- vue-test-utils-skilldSkill
- vuetify-skilldSkill
- vueuse-components-skilldSkill
- vueuse-core-skilldSkill
- vueuse-integrations-skilldSkill
- vueuse-math-skilldSkill
- vueuse-motion-skilldSkill
- vueuse-shared-skilldSkill
The file
We split this skill into the rules it gives an agent
8 rules. About 0 are common, 0 are distinctive, and 8 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
8
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 27
Read refs in templates as {{ count }}, in script as count.value.
- Very specific: line 44
Default compare is strict === (src/useSelector.ts:15-17).
- Very specific: line 45
Call the hooks inside component setup or another effect scope.
- Very specific: line 47
Keep selectors cheap. The selector runs on every notification of the source (src/useSelector.ts:46-52).
- Very specific: line 48
Do not import createStoreContext from this package.
- Very specific: line 64
Use useSelector, never the deprecated useStore, for new code (src/useSelector.ts:39).
- Very specific: line 67
Write state through store.setState((prev) => next) updater functions.
- Very specific: line 71
Use createAsyncAtom for async data instead of hand-rolled pending and error flags.
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
@tanstack/vue-store@0.11.1
Vue adapter for TanStack Store. Exact core dependency: @tanstack/store@0.11.1 (package.json:41). src/index.ts:1 re-exports the whole core, so Vue apps import everything from @tanstack/vue-store alone.
Quick start
import { createStore, createAtom, shallow, useAtom, useSelector } from '@tanstack/vue-store'
// Module scope: create once, import anywhere
const counter = createStore({ count: 0 })
const countAtom = createAtom(0)
// Inside <script setup>
const count = useSelector(counter, (s) => s.count) // slice
const pair = useSelector(counter, (s) => ({ n: s.count }), { compare: shallow }) // object slice
const [n, setN] = useAtom(countAtom) // read + write
setN((prev) => prev + 1)Read refs in templates as {{ count }}, in script as count.value.
Hooks (this package's own exports)
| Hook | Signature | Use |
useSelector | (source, selector?, options?) => Readonly<Ref<TSelected>> | Primary read hook. Store, atom, or any { get, subscribe } source. Omit the selector to subscribe to the whole value. |
useAtom | (atom, options?) => [Readonly<Ref<TValue>>, atom.set] | Read plus write for one writable atom. The setter takes a value or an updater function (src/useAtom.ts:20-27). |
_useStore | (store, selector, options?) => [selected, actions or setState] | Experimental read+write tuple. The selector argument is required (src/_useStore.ts:30). Returns store.actions when the store has an actions factory, else store.setState (src/_useStore.ts:37-38). |
useStore | deprecated | Alias for useSelector. Third argument is a bare compare function, not an options object (src/useStore.ts:14-23). Prefer useSelector. |
options is UseSelectorOptions: { compare?: (a, b) => boolean } (src/useSelector.ts:4-6).
Details, behavior notes, and pitfalls: Vue hooks reference
Rules that prevent bugs
- Default compare is strict
===(src/useSelector.ts:15-17). When the selector builds a fresh object or array, pass{ compare: shallow }or the ref updates on every notification. Primitive selectors need no custom compare. - Call the hooks inside component setup or another effect scope.
useSelectorunsubscribes viaonScopeDispose(src/useSelector.ts:54-56); outside a scope, cleanup never runs. - Returned refs are
readonly. Write throughstore.setState,atom.set, storeactions, or the second tuple element ofuseAtom/_useStore. - Keep selectors cheap. The selector runs on every notification of the source (
src/useSelector.ts:46-52); move expensive computation into a derivedcreateStore. - Do not import
createStoreContextfrom this package. The 0.11.0 release notes list it, but the 0.11.1 source exports onlyuseSelector,useAtom,useStore,_useStoreplus the core re-export (src/index.ts,dist/index.d.ts). See release 0.11.0.
Core re-exports from @tanstack/store
createStore(initialValue)->Store<T>;createStore((prev?) => T)->ReadonlyStore<T>(derived);createStore(initialValue, actionsFactory)->Store<T, TActions>with typedstore.actions.Store:stategetter,get(),setState(updater),subscribe(observerOrFn)returning{ unsubscribe }, boundactions.ReadonlyStoreomitssetStateandactions.createAtom(initialValue)-> writableAtom<T>;createAtom(fn)-> computedReadonlyAtom<T>.AtomOptions.comparecontrols change detection.createAsyncAtom(() => Promise<T>)->ReadonlyAtomof a{ status }discriminated union:'pending' | 'done' | 'error'.batch(fn)groups updates into one notification cycle;flush()drains pending effects.shallow(a, b)comparesObject.is, then Map and Set contents, Date timestamps, and own keys including symbols.toObserver()normalizes callbacks or RxJS-style observers forsubscribe.- Types:
Observer,Subscription,Subscribable,Readable,Atom,ReadonlyAtom,AtomOptions,StoreActionMap,StoreActionsFactory, and others.
Full surface with cautions: core API reference
Best practices
- Use
useSelector, never the deprecateduseStore, for new code (src/useSelector.ts:39). - Define stores in plain modules outside components. This is the documented sharing pattern (Vue quick start).
- Select fine-grained slices. The component re-renders only when the selected value changes.
- Write state through
store.setState((prev) => next)updater functions; updates are immutable. - Group multiple updates in
batch(() => { ... })so subscribers notify once with the final state. - Derive with
createStore(() => ...); derived stores recompute when dependencies change, andprevaccumulates values. - Co-locate writes with an actions factory so
_useStorereturns typed actions (src/_useStore.ts:37-38). - Use
createAsyncAtomfor async data instead of hand-rolled pending and error flags. - Observe state outside components with
store.subscribe(() => ...); it returns{ unsubscribe }.
Recipes and full examples: patterns reference
Migration
Version-specific changes and upgrade steps, most recent first: migration reference
Highlights:
- 0.11.x:
useSelectorintroduced as primary hook;useStoredeprecated; default compare is===, replacing the pre-0.11shallowdefault and{ equal }option. - 0.9.0 breaking:
new Store()->createStore();new Derived()-> derivedcreateStore(fn);new Effect()removed in favor ofstore.subscribe().
Environment
- Vue
^3.0.0or^2.5.0throughvue-demi. Vue 2 needs the optional peer@vue/composition-api@^1.2.1(package.json:50-58). - Exact core pin
@tanstack/store@0.11.1; core APIs are re-exported, so no separate core install is needed in Vue apps. - Dual format: ESM via the
importcondition (dist/index.js), CJS viarequire(dist/index.cjs); types atdist/index.d.cts;sideEffects: false. - TypeScript 5.6 through 5.9 are tested (package.json:62-66).
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

