Skip to content
This repository has been archived by the owner on Feb 2, 2023. It is now read-only.

Commit

Permalink
docs(compodoc): rebuild compodoc api documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
klemenoslaj committed Oct 25, 2018
1 parent 6492fdc commit 282e0c5
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 30 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

# [NgActionOutlet](https://klemenoslaj.github.io/ng-action-outlet/)

The goal of `ActionOutlet` is to provide an easy API to build dynamic actions on runtime
and have the possibility to get notified for each and every change, that happens to any particular action.
*e.g. Title change, icon change, disabled state, etc.*
The goal of `ActionOutlet` is to provide an easy API to build dynamic menus on runtime and have the possibility to get notified for each and every change, that happens to any particular action in the menu (_e.g. Title change, icon change, disabled state, ..._).

The most natural use case is when back-end is in charge over the visibility of actions and menus of the front-end application (_e.g. hide/show actions based on permissions_).

## Getting started

Expand Down
20 changes: 10 additions & 10 deletions docs/classes/ActionAbstract.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@ <h2 id="example">Example</h2>
* this.fire$ = this.handleLivecycle(this.fire.asObservable(), false);
* this.custom$ = this.handleLivecycle(this.custom.asObservable());
* this.changes$ = this.handleLivecycle(Observable.merge(
* this.title$.map(title =&gt; (&lt;ActionCustomOptions&gt;{ title })),
* this.icon$.map(icon =&gt; (&lt;ActionCustomOptions&gt;{ icon })),
* this.visible$.map(visible =&gt; (&lt;ActionCustomOptions&gt;{ visible })),
* this.disabled$.map(disabled =&gt; (&lt;ActionCustomOptions&gt;{ disabled })),
* this.custom$.map(custom =&gt; (&lt;ActionCustomOptions&gt;{ custom }))
* this.title$.pipe(map(title =&gt; (&lt;ActionCustomOptions&gt;{ title }))),
* this.icon$.pipe(map(icon =&gt; (&lt;ActionCustomOptions&gt;{ icon }))),
* this.visible$.pipe(map(visible =&gt; (&lt;ActionCustomOptions&gt;{ visible }))),
* this.disabled$.pipe(map(disabled =&gt; (&lt;ActionCustomOptions&gt;{ disabled }))),
* this.custom$.pipe(map(custom =&gt; (&lt;ActionCustomOptions&gt;{ custom })))
* ));
* }
*
Expand Down Expand Up @@ -1681,11 +1681,11 @@ <h3 id="methods">
* this.fire$ &#x3D; this.handleLivecycle(this.fire.asObservable(), false);
* this.custom$ &#x3D; this.handleLivecycle(this.custom.asObservable());
* this.changes$ &#x3D; this.handleLivecycle(Observable.merge(
* this.title$.map(title &#x3D;&gt; (&lt;ActionCustomOptions&gt;{ title })),
* this.icon$.map(icon &#x3D;&gt; (&lt;ActionCustomOptions&gt;{ icon })),
* this.visible$.map(visible &#x3D;&gt; (&lt;ActionCustomOptions&gt;{ visible })),
* this.disabled$.map(disabled &#x3D;&gt; (&lt;ActionCustomOptions&gt;{ disabled })),
* this.custom$.map(custom &#x3D;&gt; (&lt;ActionCustomOptions&gt;{ custom }))
* this.title$.pipe(map(title &#x3D;&gt; (&lt;ActionCustomOptions&gt;{ title }))),
* this.icon$.pipe(map(icon &#x3D;&gt; (&lt;ActionCustomOptions&gt;{ icon }))),
* this.visible$.pipe(map(visible &#x3D;&gt; (&lt;ActionCustomOptions&gt;{ visible }))),
* this.disabled$.pipe(map(disabled &#x3D;&gt; (&lt;ActionCustomOptions&gt;{ disabled }))),
* this.custom$.pipe(map(custom &#x3D;&gt; (&lt;ActionCustomOptions&gt;{ custom })))
* ));
* }
*
Expand Down
18 changes: 9 additions & 9 deletions docs/dependencies.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,23 +51,23 @@
</ol>
<ul class="dependencies-list">
<li>
<b>@angular/animations</b> : ^6.1.0</li>
<b>@angular/animations</b> : ^7.0.0</li>
<li>
<b>@angular/common</b> : ^6.1.0</li>
<b>@angular/common</b> : ^7.0.0</li>
<li>
<b>@angular/compiler</b> : ^6.1.0</li>
<b>@angular/compiler</b> : ^7.0.0</li>
<li>
<b>@angular/core</b> : ^6.1.0</li>
<b>@angular/core</b> : ^7.0.0</li>
<li>
<b>@angular/forms</b> : ^6.1.0</li>
<b>@angular/forms</b> : ^7.0.0</li>
<li>
<b>@angular/http</b> : ^6.1.0</li>
<b>@angular/http</b> : ^7.0.0</li>
<li>
<b>@angular/platform-browser</b> : ^6.1.0</li>
<b>@angular/platform-browser</b> : ^7.0.0</li>
<li>
<b>@angular/platform-browser-dynamic</b> : ^6.1.0</li>
<b>@angular/platform-browser-dynamic</b> : ^7.0.0</li>
<li>
<b>@angular/router</b> : ^6.1.0</li>
<b>@angular/router</b> : ^7.0.0</li>
<li>
<b>core-js</b> : ^2.5.4</li>
<li>
Expand Down
13 changes: 7 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,14 @@
<div class="content getting-started">
<div class="content-data">

<p><img src="https://img.shields.io/travis/klemenoslaj/ng-action-outlet/master.svg" alt="Travis build" class="img-responsive">
<img src="https://img.shields.io/coveralls/klemenoslaj/ng-action-outlet/master.svg" alt="Coveralls github" class="img-responsive">
<img src="https://img.shields.io/david/klemenoslaj/ng-action-outlet/master.svg" alt="David" class="img-responsive">
<img src="https://img.shields.io/github/tag/klemenoslaj/ng-action-outlet.svg" alt="GitHub tag" class="img-responsive">
<img src="https://img.shields.io/npm/l/@ng-action-outlet/core.svg" alt="License" class="img-responsive"></p>
<p><a href="https://travis-ci.org/klemenoslaj/ng-action-outlet"><img src="https://img.shields.io/travis/klemenoslaj/ng-action-outlet/master.svg" alt="Travis build" class="img-responsive"></a>
<a href="https://coveralls.io/github/klemenoslaj/ng-action-outlet?branch=master"><img src="https://img.shields.io/coveralls/klemenoslaj/ng-action-outlet/master.svg" alt="Coveralls github" class="img-responsive"></a>
<a href="https://david-dm.org/klemenoslaj/ng-action-outlet"><img src="https://img.shields.io/david/klemenoslaj/ng-action-outlet/master.svg" alt="David" class="img-responsive"></a>
<a href="https://github.com/klemenoslaj/ng-action-outlet/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/@ng-action-outlet/core.svg" alt="License" class="img-responsive"></a>
<a href="https://github.com/klemenoslaj/ng-action-outlet/releases"><img src="https://img.shields.io/github/tag/klemenoslaj/ng-action-outlet.svg" alt="GitHub tag" class="img-responsive"></a></p>
<h1 id="ngactionoutlet"><a href="https://klemenoslaj.github.io/ng-action-outlet/">NgActionOutlet</a></h1>
<p>The goal of <code>ActionOutlet</code> is to provide an easy API to build dynamic actions on runtime<br>and have the possibility to get notified for each and every change, that happens to any particular action.<br><em>e.g. Title change, icon change, disabled state, etc.</em></p>
<p>The goal of <code>ActionOutlet</code> is to provide an easy API to build dynamic menus on runtime and have the possibility to get notified for each and every change, that happens to any particular action in the menu (<em>e.g. Title change, icon change, disabled state, ...</em>).</p>
<p>The most natural use case is when back-end is in charge over the visibility of actions and menus of the front-end application (<em>e.g. front-end receives JSON what buttons, dropdowns, etc. to display</em>).</p>
<h2 id="getting-started">Getting started</h2>
<h3 id="step-1-install-ng-action-outlet">Step 1: Install <code>ng-action-outlet</code></h3>
<p>You can use either <strong>npm</strong> or <strong>yarn</strong> command-line tool.<br>Choose the tool that is appropriate for your project.</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/js/search/search_index.js

Large diffs are not rendered by default.

0 comments on commit 282e0c5

Please sign in to comment.