Title: Signal for TransferState data · Issue #58128 · angular/angular · GitHub
Open Graph Title: Signal for TransferState data · Issue #58128 · angular/angular
X Title: Signal for TransferState data · Issue #58128 · angular/angular
Description: Which @angular/* package(s) are relevant/related to the feature request? core Description When creating an app that uses Signals and TransferState, it was found that we had to do a fair amount of boilerplate for this to work with persist...
Open Graph Description: Which @angular/* package(s) are relevant/related to the feature request? core Description When creating an app that uses Signals and TransferState, it was found that we had to do a fair amount of b...
X Description: Which @angular/* package(s) are relevant/related to the feature request? core Description When creating an app that uses Signals and TransferState, it was found that we had to do a fair amount of b...
Opengraph URL: https://github.com/angular/angular/issues/58128
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Signal for TransferState data","articleBody":"### Which @angular/* package(s) are relevant/related to the feature request?\n\ncore\n\n### Description\n\nWhen creating an app that uses Signals and TransferState, it was found that we had to do a fair amount of boilerplate for this to work with persisting the signal state to TransferState and then loading it again on the browser: \n\n- Create a state key with `makeStateKey` that requires a new constant with duplicated type and string key\n- Inject TransferState\n- Create a signal property\n- Set the signal on the server once data is loaded\n- Set the TransferState data keys for each signal\n- Set the signal on the browser from TransferState data\n\nIt would be handy if there is a signal that wraps TransferState and can remove some of this boilerplate to just:\n\n- Create a `transferStateSignal` property, giving it the key and initial value\n- Set the signal on the server once data is loaded\n- (Signal is automatically loaded on the browser from TransferState data)\n\nNo state key, TransferState injection, or setting/loading TransferState is needed.\n\n### Proposed solution\n\nHere is a quick example of a prototype of what this could look like:\n\n```ts\nimport { inject, makeStateKey, signal, TransferState, WritableSignal } from \"@angular/core\";\n\nexport function transferStateSignal\u003cT>(key: string, initialValue: T): WritableSignal\u003cT> {\n const stateKey = makeStateKey\u003cT>(key);\n const transferState = inject(TransferState);\n\n const value = transferState.hasKey(stateKey)\n ? transferState.get(stateKey, initialValue)\n : initialValue;\n\n const signalValue = signal(value);\n\n const signalProxy = new Proxy(signalValue, {\n // override `set` method of signalValue to set on TransferState\n get: (target, prop, receiver) => {\n if (prop === 'set') {\n return (newValue: T) => {\n transferState.set(stateKey, newValue);\n target.set(newValue);\n };\n }\n return Reflect.get(target, prop, receiver);\n }\n });\n\n return signalProxy;\n}\n```\n\nExample usage:\n```ts\nimport { isPlatformBrowser, isPlatformServer } from '@angular/common';\nimport { ChangeDetectionStrategy, Component, computed, Inject, PLATFORM_ID } from '@angular/core';\nimport { transferStateSignal } from '../transferStateSignal';\n\n@Component({\n selector: 'app-transfer-state-signal',\n standalone: true,\n imports: [],\n template: `\n \u003ch1>TransferStateSignal Example\u003c/h1>\n \u003cp>String: {{dataString()}}\u003c/p>\n \u003cp>Number: {{dataNumber()}}\u003c/p>\n \u003cp>Boolean: {{dataBoolean()}}\u003c/p>\n \u003cp>Object.key: {{dataObject().key}}\u003c/p>\n \u003cp>Computed: {{computedNumber()}}\u003c/p>\n `,\n changeDetection: ChangeDetectionStrategy.OnPush,\n})\nexport class TransferStateSignalComponent {\n readonly dataString = transferStateSignal\u003cstring>('dataString', 'Hello, World!');\n readonly dataNumber = transferStateSignal\u003cnumber>('dataNumber', 42);\n readonly dataBoolean = transferStateSignal\u003cboolean>('dataBoolean', true);\n readonly dataObject = transferStateSignal\u003c{ key: string }>('dataObject', { key: 'value' });\n\n readonly computedNumber = computed\u003cnumber>(() => this.dataNumber() * 100);\n\n constructor(\n @Inject(PLATFORM_ID) private readonly platformId: Object\n ) { }\n\n ngOnInit(): void {\n if (isPlatformServer(this.platformId)) {\n // pretend we load data on the server here, then set in signals for SSR,\n // and no need to set on TransferState as it's done in transferStateSignal\n this.dataString.set('Hello, Server!');\n this.dataNumber.set(24);\n this.dataBoolean.set(false);\n this.dataObject.set({ key: 'server' });\n } else if (isPlatformBrowser(this.platformId)) {\n setInterval(() => {\n this.dataNumber.set(this.dataNumber() + 1);\n }, 1000);\n }\n }\n}\n```\n\nCompare this to what is required to do this without `transferStateSignal`:\n\n```ts\nimport { isPlatformBrowser, isPlatformServer } from '@angular/common';\nimport { ChangeDetectionStrategy, Component, computed, Inject, makeStateKey, PLATFORM_ID, signal, TransferState } from '@angular/core';\n\n// duplicated effort of having to make a state key for each and ensure data types match\nconst dataStringKey = makeStateKey\u003cstring>('dataStringCurrent');\nconst dataNumberKey = makeStateKey\u003cnumber>('dataNumberCurrent');\nconst dataBooleanKey = makeStateKey\u003cboolean>('dataBooleanCurrent');\nconst dataObjectKey = makeStateKey\u003c{ key: string }>('dataObjectCurrent');\n\n@Component({\n selector: 'app-current',\n standalone: true,\n imports: [],\n template: `\n \u003ch1>Current Example\u003c/h1>\n \u003cp>String: {{dataString()}}\u003c/p>\n \u003cp>Number: {{dataNumber()}}\u003c/p>\n \u003cp>Boolean: {{dataBoolean()}}\u003c/p>\n \u003cp>Object.key: {{dataObject().key}}\u003c/p>\n \u003cp>Computed: {{computedNumber()}}\u003c/p>\n `,\n changeDetection: ChangeDetectionStrategy.OnPush,\n})\nexport class CurrentComponent {\n readonly dataString = signal\u003cstring>('Hello, World!');\n readonly dataNumber = signal\u003cnumber>(42);\n readonly dataBoolean = signal\u003cboolean>(true);\n readonly dataObject = signal\u003c{ key: string }>({ key: 'value' });\n\n readonly computedNumber = computed\u003cnumber>(() => this.dataNumber() * 100);\n\n constructor(\n @Inject(PLATFORM_ID) private readonly platformId: Object,\n private readonly transferState: TransferState, // extra import\n ) { }\n\n ngOnInit(): void {\n if (isPlatformServer(this.platformId)) {\n // pretend we load data on the server here, then set in signals for SSR\n this.dataString.set('Hello, Server!');\n this.dataNumber.set(24);\n this.dataBoolean.set(false);\n this.dataObject.set({ key: 'server' });\n\n // duplicated effort of setting on TransferState\n this.transferState.set(dataStringKey, this.dataString());\n this.transferState.set(dataNumberKey, this.dataNumber());\n this.transferState.set(dataBooleanKey, this.dataBoolean());\n this.transferState.set(dataObjectKey, this.dataObject());\n } else if (isPlatformBrowser(this.platformId)) {\n // duplicated effort of getting from TransferState\n this.dataString.set(this.transferState.get(dataStringKey, this.dataString()));\n this.dataNumber.set(this.transferState.get(dataNumberKey, this.dataNumber()));\n this.dataBoolean.set(this.transferState.get(dataBooleanKey, this.dataBoolean()));\n this.dataObject.set(this.transferState.get(dataObjectKey, this.dataObject()));\n\n setInterval(() => {\n this.dataNumber.set(this.dataNumber() + 1);\n }, 1000);\n }\n }\n}\n```\n\n### Alternatives considered\n\nWill consider creating this as a third-party OSS library if the Angular team is not interested in adding something like this to the framework.","author":{"url":"https://github.com/paulirwin","@type":"Person","name":"paulirwin"},"datePublished":"2024-10-08T22:43:30Z","url":"https://github.com/angular/angular/issues/58128"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:463e5c87-c7d4-644a-3e06-7f0217fa0fe8 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9A76:1CCECA:FC118B:1506C85:6B01E8C6 |
| html-safe-nonce | 9029246b55082b3aeec9179d473ec3a7e6dced787760a502c7a31638a8dca91f |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5QTc2OjFDQ0VDQTpGQzExOEI6MTUwNkM4NTo2QjAxRThDNiIsInZpc2l0b3JfaWQiOiIxMTY1NDg0NTkwNjg1NjEyMjMwIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 360cb62f1d877703d7f86b26f2fed95048ed8eeab9fa27d66ab6f49a5d98e8e6 |
| hovercard-subject-tag | issue:2574354063 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/angular/angular/58128/issue_layout |
| twitter:image | https://opengraph.githubassets.com/25bac6f8197d6959c4a461891e15146cc491825b3eca0dc261ceec56296808e4/angular/angular/issues/58128 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/25bac6f8197d6959c4a461891e15146cc491825b3eca0dc261ceec56296808e4/angular/angular/issues/58128 |
| og:image:alt | Which @angular/* package(s) are relevant/related to the feature request? core Description When creating an app that uses Signals and TransferState, it was found that we had to do a fair amount of b... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | paulirwin |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| go-import | github.com/angular/angular git https://github.com/angular/angular.git |
| octolytics-dimension-user_id | 139426 |
| octolytics-dimension-user_login | angular |
| octolytics-dimension-repository_id | 24195339 |
| octolytics-dimension-repository_nwo | angular/angular |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 24195339 |
| octolytics-dimension-repository_network_root_nwo | angular/angular |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width