Skip to content

Commit 7050576

Browse files
committed
docs(angular-query): angular version compatibility
1 parent c1b8b99 commit 7050576

File tree

4 files changed

+28
-5
lines changed

4 files changed

+28
-5
lines changed

docs/config.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,10 @@
145145
"label": "Installation",
146146
"to": "framework/angular/installation"
147147
},
148+
{
149+
"label": "Angular Version Compatibility",
150+
"to": "framework/angular/angular-version-compatibility"
151+
},
148152
{
149153
"label": "Quick Start",
150154
"to": "framework/angular/quick-start"
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
id: angular-version-compatibility
3+
title: Angular Version Compatibility
4+
---
5+
6+
The TanStack Query Angular adapter's dependency range will specify at least the oldest Angular version under active or LTS support.
7+
8+
```json
9+
{
10+
"peerDependencies": {
11+
"@angular/common": ">=16.0.0",
12+
"@angular/core": ">=16.0.0"
13+
}
14+
}
15+
```
16+
17+
As of the time of writing, Angular 17 is the oldest version under LTS support but there has not been a reason yet to remove support for Angular 16.
18+
19+
Support for older versions not under LTS support will be dropped from the adapter's dependency range when supporting both the older- and more recent versions becomes impractical. Bugs that only affect Angular versions not under LTS support will in principle not be fixed.
20+
21+
## Pre-Release Versions of Angular
22+
23+
As only the minimum version and not a maximum version of Angular is specified, pre-release versions of Angular are not excluded but are not guaranteed to work.

docs/framework/angular/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Installation
55

66
### NPM
77

8-
_Angular Query is compatible with Angular v16 and higher_
8+
TanStack Angular Query is compatible with Angular v16 and higher. See [Angular Version Compatibility](./angular-version-compatibility) for more details.
99

1010
```bash
1111
npm i @tanstack/angular-query

docs/framework/angular/overview.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ title: Overview
55

66
The `@tanstack/angular-query` package offers a 1st-class API for using TanStack Query via Angular.
77

8-
## Supported Angular Versions
9-
10-
TanStack Query is compatible with Angular v16 and higher.
11-
128
TanStack Query (FKA React Query) is often described as the missing data-fetching library for web applications, but in more technical terms, it makes **fetching, caching, synchronizing and updating server state** in your web applications a breeze.
139

1410
## Motivation

0 commit comments

Comments
 (0)