diff --git a/docs/framework/angular/installation.md b/docs/framework/angular/installation.md index dc18f68fe80..cd18b9256fb 100644 --- a/docs/framework/angular/installation.md +++ b/docs/framework/angular/installation.md @@ -3,7 +3,7 @@ id: installation title: Installation --- -> 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. +> 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. ### NPM diff --git a/docs/framework/angular/overview.md b/docs/framework/angular/overview.md index ebb2e8907bc..1eb28821240 100644 --- a/docs/framework/angular/overview.md +++ b/docs/framework/angular/overview.md @@ -3,7 +3,7 @@ id: overview title: Overview --- -> 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. +> 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. The `@tanstack/angular-query-experimental` package offers a 1st-class API for using TanStack Query via Angular. diff --git a/docs/framework/angular/quick-start.md b/docs/framework/angular/quick-start.md index c22c1c11761..ff3c29ae6b6 100644 --- a/docs/framework/angular/quick-start.md +++ b/docs/framework/angular/quick-start.md @@ -3,7 +3,7 @@ id: quick-start title: Quick Start --- -> 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. +> 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. [//]: # 'Example' @@ -23,6 +23,24 @@ bootstrapApplication(AppComponent, { }) ``` +or in a NgModule-based app + +```ts +import { provideHttpClient } from '@angular/common/http' +import { + provideAngularQuery, + QueryClient, +} from '@tanstack/angular-query-experimental' + +@NgModule({ + declarations: [AppComponent], + imports: [BrowserModule], + providers: [provideAngularQuery(new QueryClient())], + bootstrap: [AppComponent], +}) +export class AppModule {} +``` + ### Component with query and mutation ```ts diff --git a/packages/angular-query-experimental/README.md b/packages/angular-query-experimental/README.md index 4fdf0fb2773..35d4801295e 100644 --- a/packages/angular-query-experimental/README.md +++ b/packages/angular-query-experimental/README.md @@ -7,13 +7,13 @@ # Angular Query -> 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. +> 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. Functions for fetching, caching and updating asynchronous data in Angular # Documentation -Visit https://tanstack.com/query/latest/docs/angular/overview +Visit https://tanstack.com/query/latest/docs/framework/angular/overview ## Quick Features @@ -54,6 +54,23 @@ Visit https://tanstack.com/query/latest/docs/angular/overview }) ``` + or in a NgModule-based app + + ```ts + import { provideHttpClient } from '@angular/common/http' + import { + provideAngularQuery, + QueryClient, + } from '@tanstack/angular-query-experimental' + + @NgModule({ + declarations: [AppComponent], + imports: [BrowserModule], + providers: [provideAngularQuery(new QueryClient())], + bootstrap: [AppComponent], + }) + ``` + 3. Inject query ```ts