Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(component): add docs overview #2444

Merged
merged 2 commits into from
Mar 29, 2020
Merged

fix(component): add docs overview #2444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1837dd
fix(component): add docs overview
BioPhoton Mar 20, 2020
af0e3ec
Update projects/ngrx.io/content/guide/component/index.md
BioPhoton Mar 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion projects/ngrx.io/content/guide/component/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# @ngrx/component

Placeholder
The Component package is a set of primitive reactive helpers to enable fully reactive, fully zone-less applications.

## Introduction

This package includes primitives that act as the glue in reactive Angular applications.
They take over rendering and provide reactivity to parts where Angular doesn't out of the box.

## Key Concepts

Rendering happens in the template only:
- [Push Pipe](guide/component/push)
- [Let Directive](guide/component/let)
2 changes: 2 additions & 0 deletions projects/ngrx.io/content/guide/component/let.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
The `*ngrxLet` directive serves a convenient way of binding observables to a view context (a dom element scope).
It also helps with several internal processing under the hood.

Same as [PushPipe](guide/component/push), it also respects ViewEngine as well as Ivy's new rendering API.

The current way of binding an observable to the view looks like that:
```html
<ng-container *ngIf="observableNumber$ as n">
Expand Down
2 changes: 2 additions & 0 deletions projects/ngrx.io/content/guide/component/push.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ The `ngrxPush` pipe serves as a drop-in replacement for the `async` pipe.
It contains intelligent handling of change detection to enable us
running in zone-full as well as zone-less mode without any changes to the code.

Same as [LetDirective](guide/component/let), it also respects ViewEngine as well as Ivy's new rendering API.

The current way of binding an observable to the view looks like that:

```html
Expand Down
1 change: 1 addition & 0 deletions projects/ngrx.io/content/marketing/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,5 @@ It is also often require a steep learning curve, including some good understandi
- [Router Store](guide/router-store) - Bindings to connect the Angular Router to @ngrx/store.
- [Entity](guide/entity) - Entity State adapter for managing record collections.
- [NgRx Data](guide/data) - Extension for simplified entity data management.
- [NgRx Component](guide/component) - Extension for fully reactive, fully zone-less applications.
- [Schematics](guide/schematics) - Scaffolding library for Angular applications using NgRx libraries.