2023-12-01 14:09:39 +01:00
---
id: quick-start
title: Quick Start
---
2024-05-04 20:09:55 +02:00
> 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.
2023-12-01 14:09:39 +01:00
[//]: # 'Example'
2024-04-02 16:46:31 -06:00
If you're looking for a fully functioning example, please have a look at our [basic codesandbox example ](../examples/basic )
2023-12-01 14:09:39 +01:00
### Provide the client to your App
2023-12-12 15:39:09 +01:00
``` ts
2024-01-27 16:46:35 +01:00
import { provideHttpClient } from '@angular/common/http'
import {
2024-11-07 16:18:52 +01:00
provideTanStackQuery ,
2024-01-27 16:46:35 +01:00
QueryClient ,
} from '@tanstack/angular-query-experimental'
2024-01-27 16:33:10 +01:00
2023-12-01 14:09:39 +01:00
bootstrapApplication ( AppComponent , {
2024-11-07 16:18:52 +01:00
providers : [ provideHttpClient ( ) , provideTanStackQuery ( new QueryClient ( ) ) ] ,
2023-12-01 14:09:39 +01:00
} )
```
2024-05-04 20:09:55 +02:00
or in a NgModule-based app
``` ts
import { provideHttpClient } from '@angular/common/http'
import {
2024-11-07 16:18:52 +01:00
provideTanStackQuery ,
2024-05-04 20:09:55 +02:00
QueryClient ,
} from '@tanstack/angular-query-experimental'
@NgModule ( {
declarations : [ AppComponent ] ,
imports : [ BrowserModule ] ,
2024-11-07 16:18:52 +01:00
providers : [ provideTanStackQuery ( new QueryClient ( ) ) ] ,
2024-05-04 20:09:55 +02:00
bootstrap : [ AppComponent ] ,
} )
export class AppModule { }
```
2023-12-01 14:09:39 +01:00
### Component with query and mutation
2024-07-19 02:36:35 -07:00
```angular-ts
2023-12-01 20:01:16 +01:00
import { Component, Injectable, inject } from '@angular/core'
import { HttpClient } from '@angular/common/http'
import { lastValueFrom } from 'rxjs'
2023-12-01 14:09:39 +01:00
import {
injectMutation,
injectQuery,
2024-11-15 18:35:16 +01:00
QueryClient
2023-12-01 14:09:39 +01:00
} from '@tanstack/angular-query-experimental'
2023-12-01 20:01:16 +01:00
2023-12-01 14:09:39 +01:00
@Component({
standalone: true,
template: `
<div>
2023-12-01 20:01:16 +01:00
<button (click)="onAddTodo()">Add Todo</button>
2023-12-01 14:09:39 +01:00
<ul>
2023-12-01 20:01:16 +01:00
@for (todo of query.data(); track todo.title) {
2023-12-01 14:09:39 +01:00
<li>{{ todo.title }}</li>
}
</ul>
</div>
`,
})
export class TodosComponent {
2024-01-27 16:33:10 +01:00
todoService = inject(TodoService)
2024-11-14 22:48:46 +01:00
queryClient = inject(QueryClient)
2023-12-01 14:09:39 +01:00
query = injectQuery(() => ({
queryKey: ['todos'],
2023-12-01 20:01:16 +01:00
queryFn: () => this.todoService.getTodos(),
2023-12-01 14:09:39 +01:00
}))
2024-11-19 19:32:49 +01:00
mutation = injectMutation(() => ({
2023-12-01 20:01:16 +01:00
mutationFn: (todo: Todo) => this.todoService.addTodo(todo),
2023-12-01 14:09:39 +01:00
onSuccess: () => {
2024-11-19 19:32:49 +01:00
this.queryClient.invalidateQueries({ queryKey: ['todos'] })
2023-12-12 15:39:09 +01:00
},
2023-12-01 14:09:39 +01:00
}))
onAddTodo() {
2023-12-30 01:03:59 +01:00
this.mutation.mutate({
2023-12-01 20:01:16 +01:00
id: Date.now().toString(),
2023-12-01 14:09:39 +01:00
title: 'Do Laundry',
})
}
2023-12-03 17:27:23 +01:00
}
2023-12-12 15:39:09 +01:00
@Injectable({ providedIn: 'root' })
2023-12-01 20:01:16 +01:00
export class TodoService {
2023-12-12 15:39:09 +01:00
private http = inject(HttpClient)
2023-12-01 20:01:16 +01:00
getTodos(): Promise<Todo[]> {
2023-12-12 15:39:09 +01:00
return lastValueFrom(
this.http.get<Todo[]>('https://jsonplaceholder.typicode.com/todos'),
)
2023-12-01 20:01:16 +01:00
}
addTodo(todo: Todo): Promise<Todo> {
2023-12-12 15:39:09 +01:00
return lastValueFrom(
this.http.post<Todo>('https://jsonplaceholder.typicode.com/todos', todo),
)
2023-12-01 20:01:16 +01:00
}
}
interface Todo {
2023-12-12 15:39:09 +01:00
id: string
title: string
2023-12-01 14:09:39 +01:00
}
` ``
[//]: # 'Example'
