Skip to content

Commit 10bdb08

Browse files
authored
docs(angular-query): update quick start and readme (#7378)
1 parent 3ab92bc commit 10bdb08

File tree

4 files changed

+40
-5
lines changed

4 files changed

+40
-5
lines changed

docs/framework/angular/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: installation
33
title: Installation
44
---
55

6-
> VERY IMPORTANT: This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Use at your own risk. If you choose to rely on this in production in an experimental stage, please lock your version to a patch-level version to avoid unexpected breakages.
6+
> IMPORTANT: This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Upgrade carefully. If you use this in production while in experimental stage, please lock your version to a patch-level version to avoid unexpected breaking changes.
77
88
### NPM
99

docs/framework/angular/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: overview
33
title: Overview
44
---
55

6-
> VERY IMPORTANT: This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Use at your own risk. If you choose to rely on this in production in an experimental stage, please lock your version to a patch-level version to avoid unexpected breakages.
6+
> IMPORTANT: This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Upgrade carefully. If you use this in production while in experimental stage, please lock your version to a patch-level version to avoid unexpected breaking changes.
77
88
The `@tanstack/angular-query-experimental` package offers a 1st-class API for using TanStack Query via Angular.
99

docs/framework/angular/quick-start.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: quick-start
33
title: Quick Start
44
---
55

6-
> VERY IMPORTANT: This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Use at your own risk. If you choose to rely on this in production in an experimental stage, please lock your version to a patch-level version to avoid unexpected breakages.
6+
> IMPORTANT: This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Upgrade carefully. If you use this in production while in experimental stage, please lock your version to a patch-level version to avoid unexpected breaking changes.
77
88
[//]: # 'Example'
99

@@ -23,6 +23,24 @@ bootstrapApplication(AppComponent, {
2323
})
2424
```
2525

26+
or in a NgModule-based app
27+
28+
```ts
29+
import { provideHttpClient } from '@angular/common/http'
30+
import {
31+
provideAngularQuery,
32+
QueryClient,
33+
} from '@tanstack/angular-query-experimental'
34+
35+
@NgModule({
36+
declarations: [AppComponent],
37+
imports: [BrowserModule],
38+
providers: [provideAngularQuery(new QueryClient())],
39+
bootstrap: [AppComponent],
40+
})
41+
export class AppModule {}
42+
```
43+
2644
### Component with query and mutation
2745

2846
```ts

packages/angular-query-experimental/README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88
# Angular Query
99

10-
> This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Use at your own risk. If you choose to rely on this in production in an experimental stage, please lock your version to a patch-level version to avoid unexpected breakages.
10+
> IMPORTANT: This library is currently in an experimental stage. This means that breaking changes will happen in minor AND patch releases. Upgrade carefully. If you use this in production while in experimental stage, please lock your version to a patch-level version to avoid unexpected breaking changes.
1111
1212
Functions for fetching, caching and updating asynchronous data in Angular
1313

1414
# Documentation
1515

16-
Visit https://tanstack.com/query/latest/docs/angular/overview
16+
Visit https://tanstack.com/query/latest/docs/framework/angular/overview
1717

1818
## Quick Features
1919

@@ -54,6 +54,23 @@ Visit https://tanstack.com/query/latest/docs/angular/overview
5454
})
5555
```
5656

57+
or in a NgModule-based app
58+
59+
```ts
60+
import { provideHttpClient } from '@angular/common/http'
61+
import {
62+
provideAngularQuery,
63+
QueryClient,
64+
} from '@tanstack/angular-query-experimental'
65+
66+
@NgModule({
67+
declarations: [AppComponent],
68+
imports: [BrowserModule],
69+
providers: [provideAngularQuery(new QueryClient())],
70+
bootstrap: [AppComponent],
71+
})
72+
```
73+
5774
3. Inject query
5875

5976
```ts

0 commit comments

Comments
 (0)