mirror of
https://github.com/TanStack/query.git
synced 2026-11-18 19:33:22 +00:00
* initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2.7 KiB
2.7 KiB
| id | title |
|---|---|
| quick-start | Quick Start |
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.
If you're looking for a fully functioning example, please have a look at our basic codesandbox example
Provide the client to your App
import { provideHttpClient } from '@angular/common/http'
import {
provideTanStackQuery,
QueryClient,
} from '@tanstack/angular-query-experimental'
bootstrapApplication(AppComponent, {
providers: [provideHttpClient(), provideTanStackQuery(new QueryClient())],
})
or in a NgModule-based app
import { provideHttpClient } from '@angular/common/http'
import {
provideTanStackQuery,
QueryClient,
} from '@tanstack/angular-query-experimental'
@NgModule({
declarations: [AppComponent],
imports: [BrowserModule],
providers: [provideTanStackQuery(new QueryClient())],
bootstrap: [AppComponent],
})
export class AppModule {}
Component with query and mutation
import { Component, Injectable, inject } from '@angular/core'
import { HttpClient } from '@angular/common/http'
import { lastValueFrom } from 'rxjs'
import {
injectMutation,
injectQuery,
QueryClient,
} from '@tanstack/angular-query-experimental'
@Component({
template: `
<div>
<button (click)="onAddTodo()">Add Todo</button>
<ul>
@for (todo of query.data(); track todo.title) {
<li>{{ todo.title }}</li>
}
</ul>
</div>
`,
})
export class TodosComponent {
todoService = inject(TodoService)
queryClient = inject(QueryClient)
query = injectQuery(() => ({
queryKey: ['todos'],
queryFn: () => this.todoService.getTodos(),
}))
mutation = injectMutation(() => ({
mutationFn: (todo: Todo) => this.todoService.addTodo(todo),
onSuccess: () => {
this.queryClient.invalidateQueries({ queryKey: ['todos'] })
},
}))
onAddTodo() {
this.mutation.mutate({
id: Date.now().toString(),
title: 'Do Laundry',
})
}
}
@Injectable({ providedIn: 'root' })
export class TodoService {
private http = inject(HttpClient)
getTodos(): Promise<Todo[]> {
return lastValueFrom(
this.http.get<Todo[]>('https://jsonplaceholder.typicode.com/todos'),
)
}
addTodo(todo: Todo): Promise<Todo> {
return lastValueFrom(
this.http.post<Todo>('https://jsonplaceholder.typicode.com/todos', todo),
)
}
}
interface Todo {
id: string
title: string
}