Skip to content
Draft
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
12 changes: 5 additions & 7 deletions docs/framework/lit/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,30 @@ title: Installation

> IMPORTANT: The Lit adapter is currently experimental and v0.1. Pin exact versions if you need extra release stability while the API is early.

Install Lit Query with Lit and TanStack Query Core:
Install Lit Query:

```sh
npm i @tanstack/lit-query @tanstack/query-core lit
npm i @tanstack/lit-query
```

or

```sh
pnpm add @tanstack/lit-query @tanstack/query-core lit
pnpm add @tanstack/lit-query
```

or

```sh
yarn add @tanstack/lit-query @tanstack/query-core lit
yarn add @tanstack/lit-query
```

or

```sh
bun add @tanstack/lit-query @tanstack/query-core lit
bun add @tanstack/lit-query
```

`@tanstack/query-core` is a peer dependency of `@tanstack/lit-query`. Even though the Lit docs import user-facing APIs from `@tanstack/lit-query`, your app should install `@tanstack/query-core` explicitly.

## Requirements

Lit Query is intended for Lit 2.8 and newer, including Lit 3. It uses Lit reactive controllers and Lit context, so query consumers should be `ReactiveControllerHost` instances such as `LitElement`.
Expand Down
2 changes: 1 addition & 1 deletion packages/lit-query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ it in production while the API is early.
## Install

```bash
npm install @tanstack/lit-query @tanstack/query-core lit
npm install @tanstack/lit-query
```

For local development in this repository:
Expand Down
Loading