Open History to see the last commit
1---
2id: quick-start
3title: Quick Start
4---
5β
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.
7β
8[//]: # 'Example'
9β
10If you're looking for a fully functioning example, please have a look at our [basic codesandbox example](../examples/basic)
11β
12### Provide the client to your App
13β
14```ts
15import { provideHttpClient } from '@angular/common/http'
16import {
17 provideTanStackQuery,
18 QueryClient,
19} from '@tanstack/angular-query-experimental'
20β
21bootstrapApplication(AppComponent, {
22 providers: [provideHttpClient(), provideTanStackQuery(new QueryClient())],
23})
24```
25β
26or in a NgModule-based app
27β
28```ts
29import { provideHttpClient } from '@angular/common/http'
30import {
31 provideTanStackQuery,
32 QueryClient,
33} from '@tanstack/angular-query-experimental'
34β
35@NgModule({
36 declarations: [AppComponent],
37 imports: [BrowserModule],
38 providers: [provideTanStackQuery(new QueryClient())],
39 bootstrap: [AppComponent],
40})
41export class AppModule {}
42```
43β
44### Component with query and mutation
45β
46```angular-ts
47import { Component, Injectable, inject } from '@angular/core'
48import { HttpClient } from '@angular/common/http'
49import { lastValueFrom } from 'rxjs'
50β
51import {
52 injectMutation,
53 injectQuery,
54 QueryClient
55} from '@tanstack/angular-query-experimental'
56β
57@Component({
58 template: `
59 <div>
60 <button (click)="onAddTodo()">Add Todo</button>
61β
62 <ul>
63 @for (todo of query.data(); track todo.title) {
64 <li>{{ todo.title }}</li>
65 }
66 </ul>
67 </div>
68 `,
69})
70export class TodosComponent {
71 todoService = inject(TodoService)
72 queryClient = inject(QueryClient)
73β
74 query = injectQuery(() => ({
75 queryKey: ['todos'],
76 queryFn: () => this.todoService.getTodos(),
77 }))
78β
79 mutation = injectMutation(() => ({
80 mutationFn: (todo: Todo) => this.todoService.addTodo(todo),
81 onSuccess: () => {
82 this.queryClient.invalidateQueries({ queryKey: ['todos'] })
83 },
84 }))
85β
86 onAddTodo() {
87 this.mutation.mutate({
88 id: Date.now().toString(),
89 title: 'Do Laundry',
90 })
91 }
92}
93β
94@Injectable({ providedIn: 'root' })
95export class TodoService {
96 private http = inject(HttpClient)
97β
98 getTodos(): Promise<Todo[]> {
99 return lastValueFrom(
100 this.http.get<Todo[]>('https://jsonplaceholder.typicode.com/todos'),
101 )
102 }
103β
104 addTodo(todo: Todo): Promise<Todo> {
105 return lastValueFrom(
106 this.http.post<Todo>('https://jsonplaceholder.typicode.com/todos', todo),
107 )
108 }
109}
110β
111interface Todo {
112 id: string
113 title: string
114}
115```
116β
117[//]: # 'Example'