Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions docs/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
{
"$schema": "https://raw.githubusercontent.com/TanStack/tanstack.com/main/tanstack-docs-config.schema.json",
"docSearch": {
"appId": "",
"apiKey": "",
"indexName": "tanstack-db"
},
"sections": [
{
"label": "Getting Started",
"children": [
{
"label": "Overview",
"to": "overview"
},
{
"label": "Quick Start",
"to": "quick-start"
},
{
"label": "Installation",
"to": "installation"
}
],
"frameworks": [
{
"label": "react",
"children": [
{
"label": "React Adapter",
"to": "framework/react/adapter"
}
]
},
{
"label": "vue",
"children": [
{
"label": "Vue Adapter",
"to": "framework/vue/adapter"
}
]
}
]
},
{
"label": "Guides",
"children": [

]
},
{
"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": "Examples",
"children": [],
"frameworks": [
{
"label": "react",
"children": [
{
"label": "Todo List",
"to": "framework/react/examples/todo"
}
]
}
]
}
]
}
17 changes: 17 additions & 0 deletions docs/framework/react/adapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: TanStack DB React Adapter
id: adapter
---

## Installation

```sh
npm install @tanstack/react-db
```

## React Hooks

See the [React Functions Reference](../reference/index.md) to see the full list of hooks available in the React Adapter.

## Basic Usage

8 changes: 8 additions & 0 deletions docs/framework/solid/adapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: TanStack DB Solid Adapter
ref: docs/framework/react/adapter.md
replace: {
"React": "Solid",
"react": "solid"
}
---
8 changes: 8 additions & 0 deletions docs/framework/svelte/adapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: TanStack DB Svelte Adapter
ref: docs/framework/react/adapter.md
replace: {
"React": "Svelte",
"react": "svelte"
}
---
8 changes: 8 additions & 0 deletions docs/framework/vue/adapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: TanStack DB Vue Adapter
ref: docs/framework/react/adapter.md
replace: {
"React": "Vue",
"react": "vue"
}
---
48 changes: 48 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Installation
id: installation
---

You can install TanStack DB with any [NPM](https://npmjs.com) package manager.

Only install one of the following packages depending on your use case:

## React

```sh
npm install @tanstack/react-db
```

TanStack DB is compatible with React v16.8+

## Solid

```sh
npm install @tanstack/solid-db
```

COMING SOON

## Svelte

```sh
npm install @tanstack/svelte-db
```

COMING SOON

## Vue

```sh
npm install @tanstack/vue-db
```

TanStack DB is compatible with Vue v3.3.0+

## Vanilla JS

```sh
npm install @tanstack/db
```

Install the the core `@tanstack/db` package to use with any framework or without a framework. Each framework package up above will also re-export everything from this core package.
Loading