-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(component): add component pages to nav menu, and update docs
- Loading branch information
1 parent
e97863d
commit 337824a
Showing
5 changed files
with
58 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,19 @@ | ||
# @ngrx/component | ||
|
||
The Component package is a set of primitive reactive helpers to enable fully reactive, fully zone-less applications. | ||
Component is a set of primitive reactive helpers to enable fully reactive, fully zone-less applications. They give more control over rendering, and provide further reactivity for Angular applications. | ||
|
||
## Introduction | ||
<div class="alert is-critical"> | ||
|
||
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. | ||
This package is experimental and may change during development. | ||
|
||
</div> | ||
|
||
## Key Concepts | ||
|
||
Rendering happens in the template only: | ||
- [Push Pipe](guide/component/push) | ||
- [Let Directive](guide/component/let) | ||
|
||
## Installation | ||
|
||
Detailed installation instructions can be found on the [Installation](guide/component/install) page. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Installation | ||
|
||
## Installing with `npm` | ||
|
||
For more information on using `npm` check out the docs <a href="https://docs.npmjs.com/cli/install" target="_blank">here</a>. | ||
|
||
```sh | ||
npm install github:ngrx/component-builds.git --save | ||
``` | ||
|
||
## Installing with `yarn` | ||
|
||
For more information on using `yarn` check out the docs <a href="https://yarnpkg.com/docs/usage" target="_blank">here</a>. | ||
|
||
```sh | ||
yarn add github:ngrx/component-builds.git | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters