Skip to content

Commit

Permalink
e2cca61a docs(component): remove redundant standalone flag (#4625)
Browse files Browse the repository at this point in the history
  • Loading branch information
web-flow authored Dec 10, 2024
1 parent 3414703 commit cea9569
Show file tree
Hide file tree
Showing 16 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion commit_message
Original file line number Diff line number Diff line change
@@ -1 +1 @@
c24cb334 docs(effects): remove redundant standalone flag (#4626)
e2cca61a docs(component): remove redundant standalone flag (#4625)
2 changes: 1 addition & 1 deletion generated/docs/api/component/LetDirective.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion generated/docs/api/component/PushPipe.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion generated/docs/guide/component/let.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion generated/docs/guide/component/push.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"id": "guide/component/push",
"title": "Push Pipe",
"contents": "\n\n\n <div class=\"github-links\">\n <a href=\"https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/component/push.md?message=docs%3A%20describe%20your%20change...\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n </div>\n\n\n<div class=\"content\">\n<h1 id=\"push-pipe\">Push Pipe<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/component/push#push-pipe\"><i class=\"material-icons\">link</i></a></h1>\n<p>The <code><a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a></code> pipe serves as a drop-in replacement for the <code>async</code> pipe.\nIt contains intelligent handling of change detection to enable us\nrunning in zone-full as well as zone-less mode without any changes to the code.</p>\n<h2 id=\"usage\">Usage<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/component/push#usage\"><i class=\"material-icons\">link</i></a></h2>\n<p>The <code><a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a></code> pipe is a standalone pipe.\nTo use it, add the <code><a href=\"api/component/PushPipe\" class=\"code-anchor\">PushPipe</a></code> to the <code>imports</code> of your standalone component or NgModule:</p>\n<code-example language=\"ts\">\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { Component } from '@angular/core';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { <a href=\"api/component/PushPipe\" class=\"code-anchor\">PushPipe</a> } from '@ngrx/component';\n\n@Component({\n // ... other <a href=\"api/data/EntityDefinition#metadata\" class=\"code-anchor\">metadata</a>\n standalone: true,\n imports: [\n // ... other imports\n <a href=\"api/component/PushPipe\" class=\"code-anchor\">PushPipe</a>,\n ],\n})\n<a href=\"api/store-devtools/DevToolsFeatureOptions#export\" class=\"code-anchor\">export</a> class MyStandaloneComponent {}\n</code-example>\n<h2 id=\"comparison-with-async-pipe\">Comparison with <code>async</code> Pipe<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/component/push#comparison-with-async-pipe\"><i class=\"material-icons\">link</i></a></h2>\n<p>The current way of binding an observable to the view looks like this:</p>\n<code-example language=\"html\">\n&#x3C;p>{{ number$ | async }}&#x3C;/p>\n\n&#x3C;ng-container *ngIf=\"number$ | async as n\">{{ n }}&#x3C;/ng-container>\n\n&#x3C;app-number [number]=\"number$ | async\">&#x3C;/app-number>\n</code-example>\n<p>The <code>async</code> pipe marks the component and all its ancestors as dirty, but does not trigger the change detection mechanism.\nIt needs the <code>zone.js</code> microtask queue to exhaust until <code>ApplicationRef.tick</code> is called to render all dirty marked components.\nTo use the <code>async</code> pipe in zone-less mode, we have to manually trigger the change detection each time an observable\nemits a new value.</p>\n<p>Fortunately, the <code><a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a></code> pipe solves this problem by scheduling a new change detection cycle in zone-less mode when\nan observable emits a new value. It can be used as follows:</p>\n<code-example language=\"html\">\n&#x3C;p>{{ number$ | <a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a> }}&#x3C;/p>\n\n&#x3C;ng-container *ngIf=\"number$ | <a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a> as n\">{{ n }}&#x3C;/ng-container>\n\n&#x3C;app-number [number]=\"number$ | <a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a>\">&#x3C;/app-number>\n</code-example>\n<h2 id=\"combining-multiple-observables\">Combining Multiple Observables<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/component/push#combining-multiple-observables\"><i class=\"material-icons\">link</i></a></h2>\n<p>The <code><a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a></code> pipe can be also used with a dictionary of observables in the\nfollowing way:</p>\n<code-example language=\"html\">\n&#x3C;code>\n {{ { users: users$, query: query$ } | ngrxPush | json }}\n&#x3C;/code>\n</code-example>\n<h2 id=\"included-features\">Included Features<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/component/push#included-features\"><i class=\"material-icons\">link</i></a></h2>\n<ul>\n<li>Takes observables or promises, retrieves their values, and passes the value to the template.</li>\n<li>Allows combining multiple observables in the template.</li>\n<li>Handles <code>null</code> and <code>undefined</code> values in a clean unified/structured way.</li>\n<li>Triggers change detection using the <code><a href=\"api/component/RenderScheduler\" class=\"code-anchor\">RenderScheduler</a></code> that behaves differently in\nzone-full and zone-less mode.</li>\n<li>Distinct the same values in a row for better performance.</li>\n</ul>\n\n</div>\n\n<!-- links to this doc:\n - guide/component\n - guide/component-store/usage\n-->\n<!-- links from this doc:\n - api/component/PushPipe\n - api/component/RenderScheduler\n - api/data/EntityDefinition#metadata\n - api/store-devtools/DevToolsFeatureOptions#export\n - api/store-devtools/DevToolsFeatureOptions#import\n - guide/component/push#combining-multiple-observables\n - guide/component/push#comparison-with-async-pipe\n - guide/component/push#included-features\n - guide/component/push#push-pipe\n - guide/component/push#usage\n - https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/component/push.md?message=docs%3A%20describe%20your%20change...\n-->"
"contents": "\n\n\n <div class=\"github-links\">\n <a href=\"https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/component/push.md?message=docs%3A%20describe%20your%20change...\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n </div>\n\n\n<div class=\"content\">\n<h1 id=\"push-pipe\">Push Pipe<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/component/push#push-pipe\"><i class=\"material-icons\">link</i></a></h1>\n<p>The <code><a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a></code> pipe serves as a drop-in replacement for the <code>async</code> pipe.\nIt contains intelligent handling of change detection to enable us\nrunning in zone-full as well as zone-less mode without any changes to the code.</p>\n<h2 id=\"usage\">Usage<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/component/push#usage\"><i class=\"material-icons\">link</i></a></h2>\n<p>The <code><a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a></code> pipe is a standalone pipe.\nTo use it, add the <code><a href=\"api/component/PushPipe\" class=\"code-anchor\">PushPipe</a></code> to the <code>imports</code> of your standalone component or NgModule:</p>\n<code-example language=\"ts\">\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { Component } from '@angular/core';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { <a href=\"api/component/PushPipe\" class=\"code-anchor\">PushPipe</a> } from '@ngrx/component';\n\n@Component({\n // ... other <a href=\"api/data/EntityDefinition#metadata\" class=\"code-anchor\">metadata</a>\n imports: [\n // ... other imports\n <a href=\"api/component/PushPipe\" class=\"code-anchor\">PushPipe</a>,\n ],\n})\n<a href=\"api/store-devtools/DevToolsFeatureOptions#export\" class=\"code-anchor\">export</a> class MyStandaloneComponent {}\n</code-example>\n<h2 id=\"comparison-with-async-pipe\">Comparison with <code>async</code> Pipe<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/component/push#comparison-with-async-pipe\"><i class=\"material-icons\">link</i></a></h2>\n<p>The current way of binding an observable to the view looks like this:</p>\n<code-example language=\"html\">\n&#x3C;p>{{ number$ | async }}&#x3C;/p>\n\n&#x3C;ng-container *ngIf=\"number$ | async as n\">{{ n }}&#x3C;/ng-container>\n\n&#x3C;app-number [number]=\"number$ | async\">&#x3C;/app-number>\n</code-example>\n<p>The <code>async</code> pipe marks the component and all its ancestors as dirty, but does not trigger the change detection mechanism.\nIt needs the <code>zone.js</code> microtask queue to exhaust until <code>ApplicationRef.tick</code> is called to render all dirty marked components.\nTo use the <code>async</code> pipe in zone-less mode, we have to manually trigger the change detection each time an observable\nemits a new value.</p>\n<p>Fortunately, the <code><a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a></code> pipe solves this problem by scheduling a new change detection cycle in zone-less mode when\nan observable emits a new value. It can be used as follows:</p>\n<code-example language=\"html\">\n&#x3C;p>{{ number$ | <a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a> }}&#x3C;/p>\n\n&#x3C;ng-container *ngIf=\"number$ | <a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a> as n\">{{ n }}&#x3C;/ng-container>\n\n&#x3C;app-number [number]=\"number$ | <a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a>\">&#x3C;/app-number>\n</code-example>\n<h2 id=\"combining-multiple-observables\">Combining Multiple Observables<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/component/push#combining-multiple-observables\"><i class=\"material-icons\">link</i></a></h2>\n<p>The <code><a href=\"api/component/PushPipe\" class=\"code-anchor\">ngrxPush</a></code> pipe can be also used with a dictionary of observables in the\nfollowing way:</p>\n<code-example language=\"html\">\n&#x3C;code>\n {{ { users: users$, query: query$ } | ngrxPush | json }}\n&#x3C;/code>\n</code-example>\n<h2 id=\"included-features\">Included Features<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/component/push#included-features\"><i class=\"material-icons\">link</i></a></h2>\n<ul>\n<li>Takes observables or promises, retrieves their values, and passes the value to the template.</li>\n<li>Allows combining multiple observables in the template.</li>\n<li>Handles <code>null</code> and <code>undefined</code> values in a clean unified/structured way.</li>\n<li>Triggers change detection using the <code><a href=\"api/component/RenderScheduler\" class=\"code-anchor\">RenderScheduler</a></code> that behaves differently in\nzone-full and zone-less mode.</li>\n<li>Distinct the same values in a row for better performance.</li>\n</ul>\n\n</div>\n\n<!-- links to this doc:\n - guide/component\n - guide/component-store/usage\n-->\n<!-- links from this doc:\n - api/component/PushPipe\n - api/component/RenderScheduler\n - api/data/EntityDefinition#metadata\n - api/store-devtools/DevToolsFeatureOptions#export\n - api/store-devtools/DevToolsFeatureOptions#import\n - guide/component/push#combining-multiple-observables\n - guide/component/push#comparison-with-async-pipe\n - guide/component/push#included-features\n - guide/component/push#push-pipe\n - guide/component/push#usage\n - https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/component/push.md?message=docs%3A%20describe%20your%20change...\n-->"
}
6 changes: 3 additions & 3 deletions generated/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -807,12 +807,12 @@
"prerelease": [
"local"
],
"build": "sha.c24cb334",
"build": "sha.e2cca61a",
"version": "19.0.0-local",
"codeName": "snapshot",
"isSnapshot": true,
"full": "19.0.0-local+sha.c24cb334",
"full": "19.0.0-local+sha.e2cca61a",
"branch": "master",
"commitSHA": "c24cb334cc0538fde904300c6e8ac4ead6cacb52"
"commitSHA": "e2cca61aee3364c5c572c2e5506f263fa749be34"
}
}
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified generated/zips/ngrx-start/ngrx-start.zip
Binary file not shown.
Binary file modified generated/zips/router-store-selectors/router-store-selectors.zip
Binary file not shown.
Binary file modified generated/zips/store-walkthrough/store-walkthrough.zip
Binary file not shown.
Binary file modified generated/zips/store/store.zip
Binary file not shown.
Binary file modified generated/zips/testing-store/testing-store.zip
Binary file not shown.
12 changes: 6 additions & 6 deletions ngsw.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"configVersion": 1,
"timestamp": 1733838713213,
"timestamp": 1733838737662,
"index": "/index.html",
"assetGroups": [
{
Expand Down Expand Up @@ -808,8 +808,8 @@
"/generated/docs/api/component-store/SelectorResults.json": "baafa78e8bf2424ca1d287c6aade500a4db5d841",
"/generated/docs/api/component-store/provideComponentStore.json": "534a4e79425fafd54fd64cf7ae15d775d701d451",
"/generated/docs/api/component.json": "1b7e860cbff798e8746547f30da5a58fc5beaf61",
"/generated/docs/api/component/LetDirective.json": "fe93c4ae0090d499ed542e6ae292b9504a3580b6",
"/generated/docs/api/component/PushPipe.json": "0df4a2384f5fb4a9e5fb98b28f00a1654a5645b4",
"/generated/docs/api/component/LetDirective.json": "49701ca85c22a3794195c14453138effae4d9f23",
"/generated/docs/api/component/PushPipe.json": "70b18f17a317f4900f5acf3bc3b527d2f4af6281",
"/generated/docs/api/component/RenderScheduler.json": "cd8d4fe0b024b575fa1518b90d2f3761874b0e8e",
"/generated/docs/api/data.json": "36a8a007636b6f2127b1c70c6b627969c58dd72b",
"/generated/docs/api/data/ChangeSet.json": "5217fc11814a8116823393c6a4936f7bb631f179",
Expand Down Expand Up @@ -1201,8 +1201,8 @@
"/generated/docs/guide/component-store/write.json": "14acc4a1615c138e3bcb0fa07df2593c31b0f604",
"/generated/docs/guide/component.json": "cba4c2a8caab0fdc71329c1ef3ba75286893de82",
"/generated/docs/guide/component/install.json": "d1b698134773207b6f211b6e2654801834a14c91",
"/generated/docs/guide/component/let.json": "d544bfea1cd9e8342cc1a5176efc48332d0d5bf4",
"/generated/docs/guide/component/push.json": "ad754deac7c0f735faee4450d07d3b8185458039",
"/generated/docs/guide/component/let.json": "33ed1fbe06860fb0171cbf206e235849b09f36e1",
"/generated/docs/guide/component/push.json": "274f77b483579c6a9015438a041fa65c3fae7116",
"/generated/docs/guide/data.json": "13eaf97e4330a345f9f977e9dad61ecc99a2f18d",
"/generated/docs/guide/data/architecture-overview.json": "6005c899d8e8301ffda93ebbb68581c9fa66a6f0",
"/generated/docs/guide/data/architecture.json": "20301ab12d8468dbac92ad8b71c25eadb8d08fa5",
Expand Down Expand Up @@ -1407,7 +1407,7 @@
"/generated/images/marketing/concept-icons/universal.svg": "69516bc8a226c9df3c564f7a4f0fec1b66e7711f",
"/generated/images/marketing/features/feature-icon.svg": "2cf6c1c11faee80b101b38c91f02184dada8cbe2",
"/generated/images/marketing/home/ngrx-conf-badge.svg": "f6c369c9c05b4b4df3373a7fb31dd3f4e82c9a44",
"/generated/navigation.json": "d26f3870e2bb290b2fe0cc0ffeb975c0453a2346",
"/generated/navigation.json": "047a37686bce217c176766d8e1728b05f66d8550",
"/generated/resources.json": "187bbb4f63bac415553db8bc033d822bb0b5a47e",
"/index.html": "73dd53940c29a42e824ed49572e37e307dc49f5f",
"/light-theme.css": "af6e8fca0da10e9eed053318ea52c0434ddc7c53",
Expand Down
2 changes: 1 addition & 1 deletion stats.json

Large diffs are not rendered by default.

0 comments on commit cea9569

Please sign in to comment.