{ "$schema": "https://raw.githubusercontent.com/TanStack/tanstack.com/main/tanstack-docs-config.schema.json", "docSearch": { "appId": "", "apiKey": "", "indexName": "tanstack-store" }, "sections": [ { "label": "Getting Started", "children": [ { "label": "Overview", "to": "overview" }, { "label": "Installation", "to": "installation" }, { "label": "Quick Start", "to": "quick-start" } ], "frameworks": [ { "label": "react", "children": [ { "label": "Quick Start - React", "to": "framework/react/quick-start" } ] }, { "label": "vue", "children": [ { "label": "Quick Start - Vue", "to": "framework/vue/quick-start" } ] }, { "label": "solid", "children": [ { "label": "Quick Start - Solid", "to": "framework/solid/quick-start" } ] }, { "label": "angular", "children": [ { "label": "Quick Start - Angular", "to": "framework/angular/quick-start" } ] }, { "label": "svelte", "children": [ { "label": "Quick Start - Svelte", "to": "framework/svelte/quick-start" } ] }, { "label": "preact", "children": [ { "label": "Quick Start - Preact", "to": "framework/preact/quick-start" } ] }, { "label": "lit", "children": [ { "label": "Quick Start - Lit", "to": "framework/lit/quick-start" } ] }, { "label": "octane", "children": [ { "label": "Quick Start - Octane", "to": "framework/octane/quick-start" } ] } ] }, { "label": "API Reference", "children": [ { "label": "Core API Reference", "to": "reference/index" } ], "frameworks": [ { "label": "react", "children": [ { "label": "React Hooks", "to": "framework/react/reference/index" } ] }, { "label": "vue", "children": [ { "label": "Vue Hooks", "to": "framework/vue/reference/index" } ] }, { "label": "solid", "children": [ { "label": "Solid Hooks", "to": "framework/solid/reference/index" } ] }, { "label": "angular", "children": [ { "label": "Angular Inject API", "to": "framework/angular/reference/index" } ] }, { "label": "svelte", "children": [ { "label": "Svelte Hooks", "to": "framework/svelte/reference/index" } ] }, { "label": "preact", "children": [ { "label": "Preact Hooks", "to": "framework/preact/reference/index" } ] }, { "label": "lit", "children": [ { "label": "Lit Reactive Controllers", "to": "framework/lit/reference/index" } ] }, { "label": "octane", "children": [ { "label": "Octane Hooks", "to": "framework/octane/reference/index" } ] } ] }, { "collapsible": true, "defaultCollapsed": true, "label": "Store API Reference", "children": [ { "label": "Store", "to": "reference/classes/Store" }, { "label": "ReadonlyStore", "to": "reference/classes/ReadonlyStore" }, { "label": "Atom", "to": "reference/interfaces/Atom" }, { "label": "AtomOptions", "to": "reference/interfaces/AtomOptions" }, { "label": "BaseAtom", "to": "reference/interfaces/BaseAtom" }, { "label": "InternalBaseAtom", "to": "reference/interfaces/InternalBaseAtom" }, { "label": "InternalReadonlyAtom", "to": "reference/interfaces/InternalReadonlyAtom" }, { "label": "InteropSubscribable", "to": "reference/interfaces/InteropSubscribable" }, { "label": "Readable", "to": "reference/interfaces/Readable" }, { "label": "ReadonlyAtom", "to": "reference/interfaces/ReadonlyAtom" }, { "label": "StoreActionsApi", "to": "reference/interfaces/StoreActionsApi" }, { "label": "Subscribable", "to": "reference/interfaces/Subscribable" }, { "label": "Subscription", "to": "reference/interfaces/Subscription" }, { "label": "AnyAtom", "to": "reference/type-aliases/AnyAtom" }, { "label": "Observer", "to": "reference/type-aliases/Observer" }, { "label": "Selection", "to": "reference/type-aliases/Selection" }, { "label": "StoreAction", "to": "reference/type-aliases/StoreAction" }, { "label": "StoreActionMap", "to": "reference/type-aliases/StoreActionMap" }, { "label": "StoreActionsFactory", "to": "reference/type-aliases/StoreActionsFactory" }, { "label": "batch", "to": "reference/functions/batch" }, { "label": "createAsyncAtom", "to": "reference/functions/createAsyncAtom" }, { "label": "createAtom", "to": "reference/functions/createAtom" }, { "label": "createStore", "to": "reference/functions/createStore" }, { "label": "flush", "to": "reference/functions/flush" }, { "label": "shallow", "to": "reference/functions/shallow" }, { "label": "toObserver", "to": "reference/functions/toObserver" } ], "frameworks": [ { "label": "react", "children": [ { "label": "createStoreContext", "to": "framework/react/reference/functions/createStoreContext" }, { "label": "useCreateAtom", "to": "framework/react/reference/functions/useCreateAtom" }, { "label": "useCreateStore", "to": "framework/react/reference/functions/useCreateStore" }, { "label": "useSelector", "to": "framework/react/reference/functions/useSelector" }, { "label": "useSetValue", "to": "framework/react/reference/functions/useSetValue" }, { "label": "useAtom", "to": "framework/react/reference/functions/useAtom" }, { "label": "useStoreActions", "to": "framework/react/reference/functions/useStoreActions" }, { "label": "_useStore (experimental)", "to": "framework/react/reference/functions/useStore" }, { "label": "useStore (deprecated)", "to": "framework/react/reference/functions/useStore-1" }, { "label": "UseSelectorOptions", "to": "framework/react/reference/interfaces/UseSelectorOptions" } ] }, { "label": "vue", "children": [ { "label": "useSelector", "to": "framework/vue/reference/functions/useSelector" }, { "label": "useSetValue", "to": "framework/vue/reference/functions/useSetValue" }, { "label": "useAtom", "to": "framework/vue/reference/functions/useAtom" }, { "label": "useStoreActions", "to": "framework/vue/reference/functions/useStoreActions" }, { "label": "_useStore (experimental)", "to": "framework/vue/reference/functions/useStore" }, { "label": "useStore (deprecated)", "to": "framework/vue/reference/functions/useStore-1" }, { "label": "UseSelectorOptions", "to": "framework/vue/reference/interfaces/UseSelectorOptions" } ] }, { "label": "solid", "children": [ { "label": "useSelector", "to": "framework/solid/reference/functions/useSelector" }, { "label": "useSetValue", "to": "framework/solid/reference/functions/useSetValue" }, { "label": "useAtom", "to": "framework/solid/reference/functions/useAtom" }, { "label": "useStoreActions", "to": "framework/solid/reference/functions/useStoreActions" }, { "label": "_useStore (experimental)", "to": "framework/solid/reference/functions/useStore" }, { "label": "useStore (deprecated)", "to": "framework/solid/reference/functions/useStore-1" }, { "label": "UseSelectorOptions", "to": "framework/solid/reference/interfaces/UseSelectorOptions" } ] }, { "label": "angular", "children": [ { "label": "injectSelector", "to": "framework/angular/reference/functions/injectSelector" }, { "label": "injectSetValue", "to": "framework/angular/reference/functions/injectSetValue" }, { "label": "injectAtom", "to": "framework/angular/reference/functions/injectAtom" }, { "label": "injectStoreActions", "to": "framework/angular/reference/functions/injectStoreActions" }, { "label": "injectStore (deprecated)", "to": "framework/angular/reference/functions/injectStore" }, { "label": "InjectSelectorOptions", "to": "framework/angular/reference/interfaces/InjectSelectorOptions" } ] }, { "label": "svelte", "children": [ { "label": "useSelector", "to": "framework/svelte/reference/functions/useSelector" }, { "label": "useSetValue", "to": "framework/svelte/reference/functions/useSetValue" }, { "label": "useAtom", "to": "framework/svelte/reference/functions/useAtom" }, { "label": "useStoreActions", "to": "framework/svelte/reference/functions/useStoreActions" }, { "label": "_useStore (experimental)", "to": "framework/svelte/reference/functions/useStore" }, { "label": "useStore (deprecated)", "to": "framework/svelte/reference/functions/useStore-1" }, { "label": "UseSelectorOptions", "to": "framework/svelte/reference/interfaces/UseSelectorOptions" } ] }, { "label": "preact", "children": [ { "label": "createStoreContext", "to": "framework/preact/reference/functions/createStoreContext" }, { "label": "useCreateAtom", "to": "framework/preact/reference/functions/useCreateAtom" }, { "label": "useCreateStore", "to": "framework/preact/reference/functions/useCreateStore" }, { "label": "useSelector", "to": "framework/preact/reference/functions/useSelector" }, { "label": "useSetValue", "to": "framework/preact/reference/functions/useSetValue" }, { "label": "useAtom", "to": "framework/preact/reference/functions/useAtom" }, { "label": "useStoreActions", "to": "framework/preact/reference/functions/useStoreActions" }, { "label": "_useStore (experimental)", "to": "framework/preact/reference/functions/useStore" }, { "label": "useStore (deprecated)", "to": "framework/preact/reference/functions/useStore-1" }, { "label": "UseSelectorOptions", "to": "framework/preact/reference/interfaces/UseSelectorOptions" } ] }, { "label": "lit", "children": [ { "label": "TanStackStoreSelector", "to": "framework/lit/reference/classes/TanStackStoreSelector" }, { "label": "TanStackStoreAtom", "to": "framework/lit/reference/classes/TanStackStoreAtom" }, { "label": "UseSelectorOptions", "to": "framework/lit/reference/interfaces/UseSelectorOptions" } ] }, { "label": "octane", "children": [ { "label": "createStoreContext", "to": "framework/octane/reference/functions/createStoreContext" }, { "label": "useCreateAtom", "to": "framework/octane/reference/functions/useCreateAtom" }, { "label": "useCreateStore", "to": "framework/octane/reference/functions/useCreateStore" }, { "label": "useSelector", "to": "framework/octane/reference/functions/useSelector" }, { "label": "useAtom", "to": "framework/octane/reference/functions/useAtom" }, { "label": "UseSelectorOptions", "to": "framework/octane/reference/interfaces/UseSelectorOptions" } ] } ] }, { "label": "Examples", "children": [], "frameworks": [ { "label": "react", "children": [ { "label": "Simple", "to": "framework/react/examples/simple" }, { "label": "Atoms", "to": "framework/react/examples/atoms" }, { "label": "Stores", "to": "framework/react/examples/stores" }, { "label": "Store Actions", "to": "framework/react/examples/store-actions" }, { "label": "Store Context", "to": "framework/react/examples/store-context" } ] }, { "label": "vue", "children": [ { "label": "Simple", "to": "framework/vue/examples/simple" }, { "label": "Atoms", "to": "framework/vue/examples/atoms" }, { "label": "Stores", "to": "framework/vue/examples/stores" }, { "label": "Store Actions", "to": "framework/vue/examples/store-actions" }, { "label": "Store Context", "to": "framework/vue/examples/store-context" } ] }, { "label": "angular", "children": [ { "label": "Simple", "to": "framework/angular/examples/simple" }, { "label": "Atoms", "to": "framework/angular/examples/atoms" }, { "label": "Stores", "to": "framework/angular/examples/stores" }, { "label": "Store Actions", "to": "framework/angular/examples/store-actions" }, { "label": "Store Context", "to": "framework/angular/examples/store-context" } ] }, { "label": "svelte", "children": [ { "label": "Simple", "to": "framework/svelte/examples/simple" }, { "label": "Atoms", "to": "framework/svelte/examples/atoms" }, { "label": "Stores", "to": "framework/svelte/examples/stores" }, { "label": "Store Actions", "to": "framework/svelte/examples/store-actions" }, { "label": "Store Context", "to": "framework/svelte/examples/store-context" } ] }, { "label": "solid", "children": [ { "label": "Simple", "to": "framework/solid/examples/simple" }, { "label": "Atoms", "to": "framework/solid/examples/atoms" }, { "label": "Stores", "to": "framework/solid/examples/stores" }, { "label": "Store Actions", "to": "framework/solid/examples/store-actions" }, { "label": "Store Context", "to": "framework/solid/examples/store-context" } ] }, { "label": "preact", "children": [ { "label": "Simple", "to": "framework/preact/examples/simple" }, { "label": "Atoms", "to": "framework/preact/examples/atoms" }, { "label": "Stores", "to": "framework/preact/examples/stores" }, { "label": "Store Actions", "to": "framework/preact/examples/store-actions" }, { "label": "Store Context", "to": "framework/preact/examples/store-context" } ] }, { "label": "lit", "children": [ { "label": "Simple", "to": "framework/lit/examples/simple" } ] }, { "label": "octane", "children": [ { "label": "Simple", "to": "framework/octane/examples/simple" }, { "label": "Atoms", "to": "framework/octane/examples/atoms" }, { "label": "Stores", "to": "framework/octane/examples/stores" }, { "label": "Store Actions", "to": "framework/octane/examples/store-actions" }, { "label": "Store Context", "to": "framework/octane/examples/store-context" } ] } ] } ] }