Open History to see the last commit
1{
2 "$schema": "https://raw.githubusercontent.com/TanStack/tanstack.com/main/tanstack-docs-config.schema.json",
3 "docSearch": {
4 "appId": "",
5 "apiKey": "",
6 "indexName": "tanstack-store"
7 },
8 "sections": [
9 {
10 "label": "Getting Started",
11 "children": [
12 {
13 "label": "Overview",
14 "to": "overview"
15 },
16 {
17 "label": "Installation",
18 "to": "installation"
19 },
20 {
21 "label": "Quick Start",
22 "to": "quick-start"
23 }
24 ],
25 "frameworks": [
26 {
27 "label": "react",
28 "children": [
29 {
30 "label": "Quick Start - React",
31 "to": "framework/react/quick-start"
32 }
33 ]
34 },
35 {
36 "label": "vue",
37 "children": [
38 {
39 "label": "Quick Start - Vue",
40 "to": "framework/vue/quick-start"
41 }
42 ]
43 },
44 {
45 "label": "solid",
46 "children": [
47 {
48 "label": "Quick Start - Solid",
49 "to": "framework/solid/quick-start"
50 }
51 ]
52 },
53 {
54 "label": "angular",
55 "children": [
56 {
57 "label": "Quick Start - Angular",
58 "to": "framework/angular/quick-start"
59 }
60 ]
61 },
62 {
63 "label": "svelte",
64 "children": [
65 {
66 "label": "Quick Start - Svelte",
67 "to": "framework/svelte/quick-start"
68 }
69 ]
70 },
71 {
72 "label": "preact",
73 "children": [
74 {
75 "label": "Quick Start - Preact",
76 "to": "framework/preact/quick-start"
77 }
78 ]
79 },
80 {
81 "label": "lit",
82 "children": [
83 {
84 "label": "Quick Start - Lit",
85 "to": "framework/lit/quick-start"
86 }
87 ]
88 },
89 {
90 "label": "octane",
91 "children": [
92 {
93 "label": "Quick Start - Octane",
94 "to": "framework/octane/quick-start"
95 }
96 ]
97 }
98 ]
99 },
100 {
101 "label": "API Reference",
102 "children": [
103 {
104 "label": "Core API Reference",
105 "to": "reference/index"
106 }
107 ],
108 "frameworks": [
109 {
110 "label": "react",
111 "children": [
112 {
113 "label": "React Hooks",
114 "to": "framework/react/reference/index"
115 }
116 ]
117 },
118 {
119 "label": "vue",
120 "children": [
121 {
122 "label": "Vue Hooks",
123 "to": "framework/vue/reference/index"
124 }
125 ]
126 },
127 {
128 "label": "solid",
129 "children": [
130 {
131 "label": "Solid Hooks",
132 "to": "framework/solid/reference/index"
133 }
134 ]
135 },
136 {
137 "label": "angular",
138 "children": [
139 {
140 "label": "Angular Inject API",
141 "to": "framework/angular/reference/index"
142 }
143 ]
144 },
145 {
146 "label": "svelte",
147 "children": [
148 {
149 "label": "Svelte Hooks",
150 "to": "framework/svelte/reference/index"
151 }
152 ]
153 },
154 {
155 "label": "preact",
156 "children": [
157 {
158 "label": "Preact Hooks",
159 "to": "framework/preact/reference/index"
160 }
161 ]
162 },
163 {
164 "label": "lit",
165 "children": [
166 {
167 "label": "Lit Reactive Controllers",
168 "to": "framework/lit/reference/index"
169 }
170 ]
171 },
172 {
173 "label": "octane",
174 "children": [
175 {
176 "label": "Octane Hooks",
177 "to": "framework/octane/reference/index"
178 }
179 ]
180 }
181 ]
182 },
183 {
184 "collapsible": true,
185 "defaultCollapsed": true,
186 "label": "Store API Reference",
187 "children": [
188 {
189 "label": "Store",
190 "to": "reference/classes/Store"
191 },
192 {
193 "label": "ReadonlyStore",
194 "to": "reference/classes/ReadonlyStore"
195 },
196 {
197 "label": "Atom",
198 "to": "reference/interfaces/Atom"
199 },
200 {
201 "label": "AtomOptions",
202 "to": "reference/interfaces/AtomOptions"
203 },
204 {
205 "label": "BaseAtom",
206 "to": "reference/interfaces/BaseAtom"
207 },
208 {
209 "label": "InternalBaseAtom",
210 "to": "reference/interfaces/InternalBaseAtom"
211 },
212 {
213 "label": "InternalReadonlyAtom",
214 "to": "reference/interfaces/InternalReadonlyAtom"
215 },
216 {
217 "label": "InteropSubscribable",
218 "to": "reference/interfaces/InteropSubscribable"
219 },
220 {
221 "label": "Readable",
222 "to": "reference/interfaces/Readable"
223 },
224 {
225 "label": "ReadonlyAtom",
226 "to": "reference/interfaces/ReadonlyAtom"
227 },
228 {
229 "label": "StoreActionsApi",
230 "to": "reference/interfaces/StoreActionsApi"
231 },
232 {
233 "label": "Subscribable",
234 "to": "reference/interfaces/Subscribable"
235 },
236 {
237 "label": "Subscription",
238 "to": "reference/interfaces/Subscription"
239 },
240 {
241 "label": "AnyAtom",
242 "to": "reference/type-aliases/AnyAtom"
243 },
244 {
245 "label": "Observer",
246 "to": "reference/type-aliases/Observer"
247 },
248 {
249 "label": "Selection",
250 "to": "reference/type-aliases/Selection"
251 },
252 {
253 "label": "StoreAction",
254 "to": "reference/type-aliases/StoreAction"
255 },
256 {
257 "label": "StoreActionMap",
258 "to": "reference/type-aliases/StoreActionMap"
259 },
260 {
261 "label": "StoreActionsFactory",
262 "to": "reference/type-aliases/StoreActionsFactory"
263 },
264 {
265 "label": "batch",
266 "to": "reference/functions/batch"
267 },
268 {
269 "label": "createAsyncAtom",
270 "to": "reference/functions/createAsyncAtom"
271 },
272 {
273 "label": "createAtom",
274 "to": "reference/functions/createAtom"
275 },
276 {
277 "label": "createStore",
278 "to": "reference/functions/createStore"
279 },
280 {
281 "label": "flush",
282 "to": "reference/functions/flush"
283 },
284 {
285 "label": "shallow",
286 "to": "reference/functions/shallow"
287 },
288 {
289 "label": "toObserver",
290 "to": "reference/functions/toObserver"
291 }
292 ],
293 "frameworks": [
294 {
295 "label": "react",
296 "children": [
297 {
298 "label": "createStoreContext",
299 "to": "framework/react/reference/functions/createStoreContext"
300 },
301 {
302 "label": "useCreateAtom",
303 "to": "framework/react/reference/functions/useCreateAtom"
304 },
305 {
306 "label": "useCreateStore",
307 "to": "framework/react/reference/functions/useCreateStore"
308 },
309 {
310 "label": "useSelector",
311 "to": "framework/react/reference/functions/useSelector"
312 },
313 {
314 "label": "useSetValue",
315 "to": "framework/react/reference/functions/useSetValue"
316 },
317 {
318 "label": "useAtom",
319 "to": "framework/react/reference/functions/useAtom"
320 },
321 {
322 "label": "useStoreActions",
323 "to": "framework/react/reference/functions/useStoreActions"
324 },
325 {
326 "label": "_useStore (experimental)",
327 "to": "framework/react/reference/functions/useStore"
328 },
329 {
330 "label": "useStore (deprecated)",
331 "to": "framework/react/reference/functions/useStore-1"
332 },
333 {
334 "label": "UseSelectorOptions",
335 "to": "framework/react/reference/interfaces/UseSelectorOptions"
336 }
337 ]
338 },
339 {
340 "label": "vue",
341 "children": [
342 {
343 "label": "useSelector",
344 "to": "framework/vue/reference/functions/useSelector"
345 },
346 {
347 "label": "useSetValue",
348 "to": "framework/vue/reference/functions/useSetValue"
349 },
350 {
351 "label": "useAtom",
352 "to": "framework/vue/reference/functions/useAtom"
353 },
354 {
355 "label": "useStoreActions",
356 "to": "framework/vue/reference/functions/useStoreActions"
357 },
358 {
359 "label": "_useStore (experimental)",
360 "to": "framework/vue/reference/functions/useStore"
361 },
362 {
363 "label": "useStore (deprecated)",
364 "to": "framework/vue/reference/functions/useStore-1"
365 },
366 {
367 "label": "UseSelectorOptions",
368 "to": "framework/vue/reference/interfaces/UseSelectorOptions"
369 }
370 ]
371 },
372 {
373 "label": "solid",
374 "children": [
375 {
376 "label": "useSelector",
377 "to": "framework/solid/reference/functions/useSelector"
378 },
379 {
380 "label": "useSetValue",
381 "to": "framework/solid/reference/functions/useSetValue"
382 },
383 {
384 "label": "useAtom",
385 "to": "framework/solid/reference/functions/useAtom"
386 },
387 {
388 "label": "useStoreActions",
389 "to": "framework/solid/reference/functions/useStoreActions"
390 },
391 {
392 "label": "_useStore (experimental)",
393 "to": "framework/solid/reference/functions/useStore"
394 },
395 {
396 "label": "useStore (deprecated)",
397 "to": "framework/solid/reference/functions/useStore-1"
398 },
399 {
400 "label": "UseSelectorOptions",
401 "to": "framework/solid/reference/interfaces/UseSelectorOptions"
402 }
403 ]
404 },
405 {
406 "label": "angular",
407 "children": [
408 {
409 "label": "injectSelector",
410 "to": "framework/angular/reference/functions/injectSelector"
411 },
412 {
413 "label": "injectSetValue",
414 "to": "framework/angular/reference/functions/injectSetValue"
415 },
416 {
417 "label": "injectAtom",
418 "to": "framework/angular/reference/functions/injectAtom"
419 },
420 {
421 "label": "injectStoreActions",
422 "to": "framework/angular/reference/functions/injectStoreActions"
423 },
424 {
425 "label": "injectStore (deprecated)",
426 "to": "framework/angular/reference/functions/injectStore"
427 },
428 {
429 "label": "InjectSelectorOptions",
430 "to": "framework/angular/reference/interfaces/InjectSelectorOptions"
431 }
432 ]
433 },
434 {
435 "label": "svelte",
436 "children": [
437 {
438 "label": "useSelector",
439 "to": "framework/svelte/reference/functions/useSelector"
440 },
441 {
442 "label": "useSetValue",
443 "to": "framework/svelte/reference/functions/useSetValue"
444 },
445 {
446 "label": "useAtom",
447 "to": "framework/svelte/reference/functions/useAtom"
448 },
449 {
450 "label": "useStoreActions",
451 "to": "framework/svelte/reference/functions/useStoreActions"
452 },
453 {
454 "label": "_useStore (experimental)",
455 "to": "framework/svelte/reference/functions/useStore"
456 },
457 {
458 "label": "useStore (deprecated)",
459 "to": "framework/svelte/reference/functions/useStore-1"
460 },
461 {
462 "label": "UseSelectorOptions",
463 "to": "framework/svelte/reference/interfaces/UseSelectorOptions"
464 }
465 ]
466 },
467 {
468 "label": "preact",
469 "children": [
470 {
471 "label": "createStoreContext",
472 "to": "framework/preact/reference/functions/createStoreContext"
473 },
474 {
475 "label": "useCreateAtom",
476 "to": "framework/preact/reference/functions/useCreateAtom"
477 },
478 {
479 "label": "useCreateStore",
480 "to": "framework/preact/reference/functions/useCreateStore"
481 },
482 {
483 "label": "useSelector",
484 "to": "framework/preact/reference/functions/useSelector"
485 },
486 {
487 "label": "useSetValue",
488 "to": "framework/preact/reference/functions/useSetValue"
489 },
490 {
491 "label": "useAtom",
492 "to": "framework/preact/reference/functions/useAtom"
493 },
494 {
495 "label": "useStoreActions",
496 "to": "framework/preact/reference/functions/useStoreActions"
497 },
498 {
499 "label": "_useStore (experimental)",
500 "to": "framework/preact/reference/functions/useStore"
501 },
502 {
503 "label": "useStore (deprecated)",
504 "to": "framework/preact/reference/functions/useStore-1"
505 },
506 {
507 "label": "UseSelectorOptions",
508 "to": "framework/preact/reference/interfaces/UseSelectorOptions"
509 }
510 ]
511 },
512 {
513 "label": "lit",
514 "children": [
515 {
516 "label": "TanStackStoreSelector",
517 "to": "framework/lit/reference/classes/TanStackStoreSelector"
518 },
519 {
520 "label": "TanStackStoreAtom",
521 "to": "framework/lit/reference/classes/TanStackStoreAtom"
522 },
523 {
524 "label": "UseSelectorOptions",
525 "to": "framework/lit/reference/interfaces/UseSelectorOptions"
526 }
527 ]
528 },
529 {
530 "label": "octane",
531 "children": [
532 {
533 "label": "createStoreContext",
534 "to": "framework/octane/reference/functions/createStoreContext"
535 },
536 {
537 "label": "useCreateAtom",
538 "to": "framework/octane/reference/functions/useCreateAtom"
539 },
540 {
541 "label": "useCreateStore",
542 "to": "framework/octane/reference/functions/useCreateStore"
543 },
544 {
545 "label": "useSelector",
546 "to": "framework/octane/reference/functions/useSelector"
547 },
548 {
549 "label": "useAtom",
550 "to": "framework/octane/reference/functions/useAtom"
551 },
552 {
553 "label": "UseSelectorOptions",
554 "to": "framework/octane/reference/interfaces/UseSelectorOptions"
555 }
556 ]
557 }
558 ]
559 },
560 {
561 "label": "Examples",
562 "children": [],
563 "frameworks": [
564 {
565 "label": "react",
566 "children": [
567 {
568 "label": "Simple",
569 "to": "framework/react/examples/simple"
570 },
571 {
572 "label": "Atoms",
573 "to": "framework/react/examples/atoms"
574 },
575 {
576 "label": "Stores",
577 "to": "framework/react/examples/stores"
578 },
579 {
580 "label": "Store Actions",
581 "to": "framework/react/examples/store-actions"
582 },
583 {
584 "label": "Store Context",
585 "to": "framework/react/examples/store-context"
586 }
587 ]
588 },
589 {
590 "label": "vue",
591 "children": [
592 {
593 "label": "Simple",
594 "to": "framework/vue/examples/simple"
595 },
596 {
597 "label": "Atoms",
598 "to": "framework/vue/examples/atoms"
599 },
600 {
601 "label": "Stores",
602 "to": "framework/vue/examples/stores"
603 },
604 {
605 "label": "Store Actions",
606 "to": "framework/vue/examples/store-actions"
607 },
608 {
609 "label": "Store Context",
610 "to": "framework/vue/examples/store-context"
611 }
612 ]
613 },
614 {
615 "label": "angular",
616 "children": [
617 {
618 "label": "Simple",
619 "to": "framework/angular/examples/simple"
620 },
621 {
622 "label": "Atoms",
623 "to": "framework/angular/examples/atoms"
624 },
625 {
626 "label": "Stores",
627 "to": "framework/angular/examples/stores"
628 },
629 {
630 "label": "Store Actions",
631 "to": "framework/angular/examples/store-actions"
632 },
633 {
634 "label": "Store Context",
635 "to": "framework/angular/examples/store-context"
636 }
637 ]
638 },
639 {
640 "label": "svelte",
641 "children": [
642 {
643 "label": "Simple",
644 "to": "framework/svelte/examples/simple"
645 },
646 {
647 "label": "Atoms",
648 "to": "framework/svelte/examples/atoms"
649 },
650 {
651 "label": "Stores",
652 "to": "framework/svelte/examples/stores"
653 },
654 {
655 "label": "Store Actions",
656 "to": "framework/svelte/examples/store-actions"
657 },
658 {
659 "label": "Store Context",
660 "to": "framework/svelte/examples/store-context"
661 }
662 ]
663 },
664 {
665 "label": "solid",
666 "children": [
667 {
668 "label": "Simple",
669 "to": "framework/solid/examples/simple"
670 },
671 {
672 "label": "Atoms",
673 "to": "framework/solid/examples/atoms"
674 },
675 {
676 "label": "Stores",
677 "to": "framework/solid/examples/stores"
678 },
679 {
680 "label": "Store Actions",
681 "to": "framework/solid/examples/store-actions"
682 },
683 {
684 "label": "Store Context",
685 "to": "framework/solid/examples/store-context"
686 }
687 ]
688 },
689 {
690 "label": "preact",
691 "children": [
692 {
693 "label": "Simple",
694 "to": "framework/preact/examples/simple"
695 },
696 {
697 "label": "Atoms",
698 "to": "framework/preact/examples/atoms"
699 },
700 {
701 "label": "Stores",
702 "to": "framework/preact/examples/stores"
703 },
704 {
705 "label": "Store Actions",
706 "to": "framework/preact/examples/store-actions"
707 },
708 {
709 "label": "Store Context",
710 "to": "framework/preact/examples/store-context"
711 }
712 ]
713 },
714 {
715 "label": "lit",
716 "children": [
717 {
718 "label": "Simple",
719 "to": "framework/lit/examples/simple"
720 }
721 ]
722 },
723 {
724 "label": "octane",
725 "children": [
726 {
727 "label": "Simple",
728 "to": "framework/octane/examples/simple"
729 },
730 {
731 "label": "Atoms",
732 "to": "framework/octane/examples/atoms"
733 },
734 {
735 "label": "Stores",
736 "to": "framework/octane/examples/stores"
737 },
738 {
739 "label": "Store Actions",
740 "to": "framework/octane/examples/store-actions"
741 },
742 {
743 "label": "Store Context",
744 "to": "framework/octane/examples/store-context"
745 }
746 ]
747 }
748 ]
749 }
750 ]
751}