docs(angular-query): add query options from a service example (#8220)

arnoud-dv · web-flow · commit c61ff1e2f803 · 2024-10-25T18:36:45.000+02:00
diff --git a/docs/config.json b/docs/config.json
@@ -1053,6 +1053,10 @@
             {
               "label": "RxJS autocomplete",
               "to": "framework/angular/examples/rxjs"
+            },
+            {
+              "label": "Query options from a service",
+              "to": "framework/angular/examples/query-options-from-a-service"
             }
           ]
         }
diff --git a/examples/angular/query-options-from-a-service/.devcontainer/devcontainer.json b/examples/angular/query-options-from-a-service/.devcontainer/devcontainer.json
@@ -0,0 +1,4 @@
+{
+  "name": "Node.js",
+  "image": "mcr.microsoft.com/devcontainers/javascript-node:18"
+}
diff --git a/examples/angular/query-options-from-a-service/.eslintrc.cjs b/examples/angular/query-options-from-a-service/.eslintrc.cjs
@@ -0,0 +1,6 @@
+// @ts-check
+
+/** @type {import('eslint').Linter.Config} */
+const config = {}
+
+module.exports = config
diff --git a/examples/angular/query-options-from-a-service/README.md b/examples/angular/query-options-from-a-service/README.md
@@ -0,0 +1,6 @@
+# TanStack Query Angular query options from a service example
+
+To run this example:
+
+- `npm install` or `yarn` or `pnpm i` or `bun i`
+- `npm run start` or `yarn start` or `pnpm start` or `bun start`
diff --git a/examples/angular/query-options-from-a-service/angular.json b/examples/angular/query-options-from-a-service/angular.json
@@ -0,0 +1,104 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "cli": {
+    "packageManager": "pnpm",
+    "analytics": false,
+    "cache": {
+      "enabled": false
+    }
+  },
+  "newProjectRoot": "projects",
+  "projects": {
+    "query-options-from-a-service": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "inlineTemplate": true,
+          "inlineStyle": true,
+          "skipTests": true
+        },
+        "@schematics/angular:class": {
+          "skipTests": true
+        },
+        "@schematics/angular:directive": {
+          "skipTests": true
+        },
+        "@schematics/angular:guard": {
+          "skipTests": true
+        },
+        "@schematics/angular:interceptor": {
+          "skipTests": true
+        },
+        "@schematics/angular:pipe": {
+          "skipTests": true
+        },
+        "@schematics/angular:resolver": {
+          "skipTests": true
+        },
+        "@schematics/angular:service": {
+          "skipTests": true
+        }
+      },
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:application",
+          "options": {
+            "outputPath": "dist/query-options-from-a-service",
+            "index": "src/index.html",
+            "browser": "src/main.ts",
+            "polyfills": ["zone.js"],
+            "tsConfig": "tsconfig.app.json",
+            "assets": ["src/favicon.ico", "src/assets"],
+            "styles": [],
+            "scripts": []
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "500kb",
+                  "maximumError": "1mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "2kb",
+                  "maximumError": "4kb"
+                }
+              ],
+              "outputHashing": "all"
+            },
+            "development": {
+              "optimization": false,
+              "extractLicenses": false,
+              "sourceMap": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "configurations": {
+            "production": {
+              "buildTarget": "query-options-from-a-service:build:production"
+            },
+            "development": {
+              "buildTarget": "query-options-from-a-service:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "buildTarget": "query-options-from-a-service:build"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/examples/angular/query-options-from-a-service/package.json b/examples/angular/query-options-from-a-service/package.json
@@ -0,0 +1,30 @@
+{
+  "name": "@tanstack/query-example-angular-query-options-from-a-service",
+  "type": "module",
+  "scripts": {
+    "ng": "ng",
+    "start": "ng serve",
+    "build": "ng build",
+    "watch": "ng build --watch --configuration development"
+  },
+  "private": true,
+  "dependencies": {
+    "@angular/common": "^17.3.12",
+    "@angular/compiler": "^17.3.12",
+    "@angular/core": "^17.3.12",
+    "@angular/platform-browser": "^17.3.12",
+    "@angular/platform-browser-dynamic": "^17.3.12",
+    "@angular/router": "^17.3.12",
+    "@tanstack/angular-query-experimental": "^5.59.16",
+    "rxjs": "^7.8.1",
+    "tslib": "^2.6.3",
+    "zone.js": "^0.14.8"
+  },
+  "devDependencies": {
+    "@angular-devkit/build-angular": "^17.3.8",
+    "@angular/cli": "^17.3.8",
+    "@angular/compiler-cli": "^17.3.12",
+    "@tanstack/angular-query-devtools-experimental": "^5.59.16",
+    "typescript": "5.3.3"
+  }
+}
diff --git a/examples/angular/query-options-from-a-service/src/app/app.component.html b/examples/angular/query-options-from-a-service/src/app/app.component.html
@@ -0,0 +1,12 @@
+<p>
+  As you visit the posts below, you will notice them in a loading state the
+  first time you load them. However, after you return to this list and click on
+  any posts you have already visited again, you will see them load instantly and
+  background refresh right before your eyes!
+  <strong>
+    (You may need to throttle your network speed to simulate longer loading
+    sequences)
+  </strong>
+</p>
+<angular-query-devtools initialIsOpen />
+<router-outlet />
diff --git a/examples/angular/query-options-from-a-service/src/app/app.component.ts b/examples/angular/query-options-from-a-service/src/app/app.component.ts
@@ -0,0 +1,12 @@
+import { Component } from '@angular/core'
+import { RouterOutlet } from '@angular/router'
+import { AngularQueryDevtools } from '@tanstack/angular-query-devtools-experimental'
+
+@Component({
+  selector: 'app-root',
+  standalone: true,
+  imports: [AngularQueryDevtools, RouterOutlet],
+  templateUrl: './app.component.html',
+  styles: [],
+})
+export class AppComponent {}
diff --git a/examples/angular/query-options-from-a-service/src/app/app.config.ts b/examples/angular/query-options-from-a-service/src/app/app.config.ts
@@ -0,0 +1,17 @@
+import { provideHttpClient, withFetch } from '@angular/common/http'
+import { provideRouter, withComponentInputBinding } from '@angular/router'
+import {
+  QueryClient,
+  provideAngularQuery,
+} from '@tanstack/angular-query-experimental'
+
+import { routes } from './app.routes'
+import type { ApplicationConfig } from '@angular/core'
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideAngularQuery(new QueryClient()),
+    provideHttpClient(withFetch()),
+    provideRouter(routes, withComponentInputBinding()),
+  ],
+}
diff --git a/examples/angular/query-options-from-a-service/src/app/app.routes.ts b/examples/angular/query-options-from-a-service/src/app/app.routes.ts
@@ -0,0 +1,15 @@
+import type { Route } from '@angular/router'
+
+// loadComponent lazily loads the component
+// when the component is the default export, there is no need to handle the promise
+
+export const routes: Array<Route> = [
+  {
+    path: '',
+    loadComponent: () => import('./components/posts.component'),
+  },
+  {
+    path: 'post/:postId',
+    loadComponent: () => import('./components/post.component'),
+  },
+]
diff --git a/examples/angular/query-options-from-a-service/src/app/components/post.component.html b/examples/angular/query-options-from-a-service/src/app/components/post.component.html
@@ -0,0 +1,19 @@
+<div>
+  <div>
+    <a routerLink="/" href="#">Back</a>
+  </div>
+  @if (postQuery.isPending()) {
+    Loading...
+  } @else if (postQuery.isError()) {
+    Error: {{ postQuery.error().message }}
+  }
+  @if (postQuery.data(); as post) {
+    <h1>{{ post.title }}</h1>
+    <div>
+      <p>{{ post.body }}</p>
+    </div>
+    @if (postQuery.isFetching()) {
+      Background Updating...
+    }
+  }
+</div>
diff --git a/examples/angular/query-options-from-a-service/src/app/components/post.component.ts b/examples/angular/query-options-from-a-service/src/app/components/post.component.ts
@@ -0,0 +1,27 @@
+import {
+  ChangeDetectionStrategy,
+  Component,
+  inject,
+  input,
+  numberAttribute,
+} from '@angular/core'
+import { RouterLink } from '@angular/router'
+import { injectQuery } from '@tanstack/angular-query-experimental'
+import { QueriesService } from '../services/queries-service'
+
+@Component({
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  selector: 'post',
+  standalone: true,
+  templateUrl: './post.component.html',
+  imports: [RouterLink],
+})
+export default class PostComponent {
+  private queries = inject(QueriesService)
+
+  postId = input.required({
+    transform: numberAttribute,
+  })
+
+  postQuery = injectQuery(() => this.queries.post(this.postId()))
+}
diff --git a/examples/angular/query-options-from-a-service/src/app/components/posts.component.html b/examples/angular/query-options-from-a-service/src/app/components/posts.component.html
@@ -0,0 +1,38 @@
+<div>
+  <h1>Posts</h1>
+  @switch (postsQuery.status()) {
+    @case ('pending') {
+      Loading...
+    }
+    @case ('error') {
+      Error: {{ postsQuery.error()?.message }}
+    }
+    @default {
+      <div class="todo-container">
+        @for (post of postsQuery.data(); track post.id) {
+          <p>
+            <!--          We can access the query data here to show bold links for-->
+            <!--          ones that are cached-->
+            <a
+              routerLink="post/{{ post.id }}"
+              [style]="
+                queryClient.getQueryData(['post', post.id])
+                  ? {
+                      fontWeight: 'bold',
+                      color: 'green',
+                    }
+                  : {}
+              "
+              >{{ post.title }}</a
+            >
+          </p>
+        }
+      </div>
+    }
+  }
+  <div>
+    @if (postsQuery.isFetching()) {
+      Background Updating...
+    }
+  </div>
+</div>
diff --git a/examples/angular/query-options-from-a-service/src/app/components/posts.component.ts b/examples/angular/query-options-from-a-service/src/app/components/posts.component.ts
@@ -0,0 +1,21 @@
+import { ChangeDetectionStrategy, Component, inject } from '@angular/core'
+import { RouterLink } from '@angular/router'
+import {
+  injectQuery,
+  injectQueryClient,
+} from '@tanstack/angular-query-experimental'
+import { QueriesService } from '../services/queries-service'
+
+@Component({
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  selector: 'posts',
+  standalone: true,
+  templateUrl: './posts.component.html',
+  imports: [RouterLink],
+})
+export default class PostsComponent {
+  private queries = inject(QueriesService)
+
+  postsQuery = injectQuery(() => this.queries.posts())
+  queryClient = injectQueryClient()
+}
diff --git a/examples/angular/query-options-from-a-service/src/app/services/posts-service.ts b/examples/angular/query-options-from-a-service/src/app/services/posts-service.ts
@@ -0,0 +1,21 @@
+import { HttpClient } from '@angular/common/http'
+import { Injectable, inject } from '@angular/core'
+
+@Injectable({
+  providedIn: 'root',
+})
+export class PostsService {
+  #http = inject(HttpClient)
+
+  postById$ = (postId: number) =>
+    this.#http.get<Post>(`https://jsonplaceholder.typicode.com/posts/${postId}`)
+
+  allPosts$ = () =>
+    this.#http.get<Array<Post>>('https://jsonplaceholder.typicode.com/posts')
+}
+
+export interface Post {
+  id: number
+  title: string
+  body: string
+}
diff --git a/examples/angular/query-options-from-a-service/src/app/services/queries-service.ts b/examples/angular/query-options-from-a-service/src/app/services/queries-service.ts
@@ -0,0 +1,27 @@
+import { Injectable, inject } from '@angular/core'
+import { lastValueFrom } from 'rxjs'
+import { queryOptions } from '@tanstack/angular-query-experimental'
+import { PostsService } from './posts-service'
+
+@Injectable({
+  providedIn: 'root',
+})
+export class QueriesService {
+  private postsService = inject(PostsService)
+
+  post(postId: number) {
+    return queryOptions({
+      queryKey: ['post', postId],
+      queryFn: () => {
+        return lastValueFrom(this.postsService.postById$(postId))
+      },
+    })
+  }
+
+  posts() {
+    return queryOptions({
+      queryKey: ['posts'],
+      queryFn: () => lastValueFrom(this.postsService.allPosts$()),
+    })
+  }
+}
diff --git a/examples/angular/query-options-from-a-service/src/assets/.gitkeep b/examples/angular/query-options-from-a-service/src/assets/.gitkeep
diff --git a/examples/angular/query-options-from-a-service/src/favicon.ico b/examples/angular/query-options-from-a-service/src/favicon.ico
diff --git a/examples/angular/query-options-from-a-service/src/index.html b/examples/angular/query-options-from-a-service/src/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>TanStack Query Angular query options from a service example</title>
+    <base href="/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link rel="icon" type="image/x-icon" href="favicon.ico" />
+  </head>
+  <body>
+    <app-root></app-root>
+  </body>
+</html>
diff --git a/examples/angular/query-options-from-a-service/src/main.ts b/examples/angular/query-options-from-a-service/src/main.ts
diff --git a/examples/angular/query-options-from-a-service/tsconfig.app.json b/examples/angular/query-options-from-a-service/tsconfig.app.json
diff --git a/examples/angular/query-options-from-a-service/tsconfig.json b/examples/angular/query-options-from-a-service/tsconfig.json
diff --git a/examples/angular/router/angular.json b/examples/angular/router/angular.json
diff --git a/examples/angular/router/src/styles.css b/examples/angular/router/src/styles.css
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1053,6 +1053,10 @@`
`1053`	`1053`	`{`
`1054`	`1054`	`"label": "RxJS autocomplete",`
`1055`	`1055`	`"to": "framework/angular/examples/rxjs"`
	`1056`	`+ },`
	`1057`	`+ {`
	`1058`	`+ "label": "Query options from a service",`
	`1059`	`+ "to": "framework/angular/examples/query-options-from-a-service"`
`1056`	`1060`	`}`
`1057`	`1061`	`]`
`1058`	`1062`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "name": "Node.js",
 +  "image": "mcr.microsoft.com/devcontainers/javascript-node:18"
 +}