grassrootseconomics/cic-staff-client
5
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity
0567b9b729
cic-staff-client/docs/compodoc/directives/PasswordToggleDirective.html

431 lines
15 KiB
HTML
Raw Normal View History

Add docs.
2021-05-10 20:56:20 +02:00
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>CICADA</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">CICADA</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content directive">
<div class="content-data">
<ol class="breadcrumb">
<li>Directives</li>
<li>PasswordToggleDirective</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/auth/_directives/password-toggle.directive.ts</code>
</p>
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Toggle password form field input visibility </p>
</p>
Add docs.
2021-05-10 20:56:20 +02:00
<section>
<h3>Metadata</h3>
<table class="table table-sm table-hover">
<tbody>
<tr>
<td class="col-md-3">Selector</td>
<td class="col-md-9"><code>[appPasswordToggle]</code></td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#togglePasswordVisibility">togglePasswordVisibility</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Inputs</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#iconId">iconId</a>
</li>
<li>
<a href="#id">id</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(elementRef: <a href="https://angular.io/api/core/ElementRef" target="_blank">ElementRef</a>, renderer: <a href="https://angular.io/api/core/Renderer2" target="_blank">Renderer2</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/app/auth/_directives/password-toggle.directive.ts:15</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<div class="io-description"><p>Handle click events on the html element.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>elementRef</td>
<td>
<code><a href="https://angular.io/api/core/ElementRef" target="_blank" >ElementRef</a></code>
</td>
<td>
No
</td>
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<td>
<code><ul>
<li>A wrapper around a native element inside of a View.</li>
</ul>
</code>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
<tr>
<td>renderer</td>
<td>
<code><a href="https://angular.io/api/core/Renderer2" target="_blank" >Renderer2</a></code>
</td>
<td>
No
</td>
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<td>
<code><ul>
<li>Extend this base class to implement custom rendering.</li>
</ul>
</code>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="inputs">Inputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="iconId"></a>
<b>iconId</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/app/auth/_directives/password-toggle.directive.ts:15</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>The password form field icon id </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="id"></a>
<b>id</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">src/app/auth/_directives/password-toggle.directive.ts:11</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<tr>
<td class="col-md-4">
<div class="io-description"><p>The password form field id </p>
</div>
</td>
</tr>
Add docs.
2021-05-10 20:56:20 +02:00
</tbody>
</table>
</section>
<section>
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="togglePasswordVisibility"></a>
<span class="name">
<b>
togglePasswordVisibility
</b>
<a href="#togglePasswordVisibility"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>togglePasswordVisibility()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<div class="io-line">Defined in <a href="" data-line="30"
class="link-to-prism">src/app/auth/_directives/password-toggle.directive.ts:30</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to directives.
2021-05-15 11:17:11 +02:00
<div class="io-description"><p>Toggle the visibility of the password input field value and accompanying icon. </p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Directive, ElementRef, Input, Renderer2 } from &#x27;@angular/core&#x27;;
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to directives.
2021-05-15 11:17:11 +02:00
/** Toggle password form field input visibility */
Add docs.
2021-05-10 20:56:20 +02:00
@Directive({
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
selector: &#x27;[appPasswordToggle]&#x27;,
Add docs.
2021-05-10 20:56:20 +02:00
})
export class PasswordToggleDirective {
Add documentation to directives.
2021-05-15 11:17:11 +02:00
/** The password form field id */
Add docs.
2021-05-10 20:56:20 +02:00
@Input()
id: string;
Add documentation to directives.
2021-05-15 11:17:11 +02:00
/** The password form field icon id */
Add docs.
2021-05-10 20:56:20 +02:00
@Input()
iconId: string;
Add documentation to directives.
2021-05-15 11:17:11 +02:00
/**
* Handle click events on the html element.
*
* @param elementRef - A wrapper around a native element inside of a View.
* @param renderer - Extend this base class to implement custom rendering.
*/
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
constructor(private elementRef: ElementRef, private renderer: Renderer2) {
Add docs.
2021-05-10 20:56:20 +02:00
this.renderer.listen(this.elementRef.nativeElement, &#x27;click&#x27;, () &#x3D;&gt; {
this.togglePasswordVisibility();
});
}
Add documentation to directives.
2021-05-15 11:17:11 +02:00
/** Toggle the visibility of the password input field value and accompanying icon. */
Add docs.
2021-05-10 20:56:20 +02:00
togglePasswordVisibility(): void {
const password: HTMLElement &#x3D; document.getElementById(this.id);
const icon: HTMLElement &#x3D; document.getElementById(this.iconId);
// @ts-ignore
if (password.type &#x3D;&#x3D;&#x3D; &#x27;password&#x27;) {
// @ts-ignore
password.type &#x3D; &#x27;text&#x27;;
icon.classList.remove(&#x27;fa-eye&#x27;);
icon.classList.add(&#x27;fa-eye-slash&#x27;);
} else {
// @ts-ignore
password.type &#x3D; &#x27;password&#x27;;
icon.classList.remove(&#x27;fa-eye-slash&#x27;);
icon.classList.add(&#x27;fa-eye&#x27;);
}
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'directive';
var COMPODOC_CURRENT_PAGE_URL = 'PasswordToggleDirective.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
<script src="../js/menu-wc.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink