Skip to content

Commit a279dd1

Browse files
fix(component): add docs overview (#2444)
* fix(component): add docs overview closes #2442 * Update projects/ngrx.io/content/guide/component/index.md Co-Authored-By: Tim Deschryver <28659384+timdeschryver@users.noreply.github.com> Co-authored-by: Tim Deschryver <28659384+timdeschryver@users.noreply.github.com>
1 parent 7dc97f8 commit a279dd1

File tree

4 files changed

+17
-1
lines changed

4 files changed

+17
-1
lines changed
Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
11
# @ngrx/component
22

3-
Placeholder
3+
The Component package is a set of primitive reactive helpers to enable fully reactive, fully zone-less applications.
4+
5+
## Introduction
6+
7+
This package includes primitives that act as the glue in reactive Angular applications.
8+
They take over rendering and provide reactivity to parts where Angular doesn't out of the box.
9+
10+
## Key Concepts
11+
12+
Rendering happens in the template only:
13+
- [Push Pipe](guide/component/push)
14+
- [Let Directive](guide/component/let)

projects/ngrx.io/content/guide/component/let.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
The `*ngrxLet` directive serves a convenient way of binding observables to a view context (a dom element scope).
44
It also helps with several internal processing under the hood.
55

6+
Same as [PushPipe](guide/component/push), it also respects ViewEngine as well as Ivy's new rendering API.
7+
68
The current way of binding an observable to the view looks like that:
79
```html
810
<ng-container *ngIf="observableNumber$ as n">

projects/ngrx.io/content/guide/component/push.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ The `ngrxPush` pipe serves as a drop-in replacement for the `async` pipe.
44
It contains intelligent handling of change detection to enable us
55
running in zone-full as well as zone-less mode without any changes to the code.
66

7+
Same as [LetDirective](guide/component/let), it also respects ViewEngine as well as Ivy's new rendering API.
8+
79
The current way of binding an observable to the view looks like that:
810

911
```html

projects/ngrx.io/content/marketing/docs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,5 @@ It is also often require a steep learning curve, including some good understandi
6262
- [Router Store](guide/router-store) - Bindings to connect the Angular Router to @ngrx/store.
6363
- [Entity](guide/entity) - Entity State adapter for managing record collections.
6464
- [NgRx Data](guide/data) - Extension for simplified entity data management.
65+
- [NgRx Component](guide/component) - Extension for fully reactive, fully zone-less applications.
6566
- [Schematics](guide/schematics) - Scaffolding library for Angular applications using NgRx libraries.

0 commit comments

Comments
 (0)