documentation/index.html
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>ngx-dhis2-validation-rule-filter-library documentation</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">ngx-dhis2-validation-rule-filter-library documentation</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 getting-started">
<div class="content-data">
<h1 id="dhis2-validation-rule-group-filter-library">Dhis2 Validation Rule Group Filter Library</h1>
<p><a href="https://travis-ci.org/interactive-apps/ngx-dhis2-validation-rule-filter"><img src="https://travis-ci.org/interactive-apps/ngx-dhis2-validation-rule-filter.svg?branch=master" alt="Build Status" class="img-responsive"></a>
<a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" class="img-responsive"></a>
<a href="https://gitter.im/interactive-apps/community"><img src="https://badges.gitter.im/interactive-apps/gitter.png" alt="Gitter chat" class="img-responsive"></a>
<img src="https://img.shields.io/github/license/interactive-apps/ngx-dhis2-validation-rule-filter.svg" alt="GitHub" class="img-responsive"></p>
<h2 id="introduction">Introduction</h2>
<p>Dhis2 Validation Rule Group(DVRG) is a user interface component library for developing <a href="http://www.dhis2.org/">DHIS2</a> applications. DHIS2 Team from UDSM uses and maintain this component to ensure visual and usability consistency where it is used in the process of developing different DHIS2 web application.</p>
<h2 id="features">Features</h2>
<ul>
<li>Fetching all the validation rules group from the <a href="http://www.dhis2.org/">DHIS2</a> Instance where the you have installed the Web app you are developing and use this library as part of it.</li>
<li>Give support to use to select the validation rule group available withing the instance and proceed with the analysis process.</li>
<li>Give support to De-select the validation rule group if it wrong selection.</li>
<li>It give support to select and de-select all the selection i.e validation rule group all at once.</li>
</ul>
<h2 id="information">Information</h2>
<p>This project was generated with <a href="https://github.com/angular/angular-cli">Angular CLI</a> version 7.3.9.</p>
<p>Run <code>ng serve</code> for a dev server. Navigate to <code>http://localhost:4200/</code>. The app will automatically reload if you change any of the source files.</p>
<p>Run <code>ng test</code> to execute the unit tests via <a href="https://karma-runner.github.io">Karma</a>.</p>
<p>Run <code>ng e2e</code> to execute the end-to-end tests via <a href="http://www.protractortest.org/">Protractor</a>.</p>
<p>To get more help on the Angular CLI use <code>ng help</code> or go check out the <a href="https://github.com/angular/angular-cli/blob/master/README.md">Angular CLI README</a>.</p>
<h2 id="quickstart-guide">Quickstart Guide</h2>
<h3 id="installation">Installation</h3>
<div><pre class="line-numbers"><code class="language-none">npm install @iapps/ngx-dhis2-validation-rule-filter</code></pre></div><h3 id="how-to-use">How to use</h3>
<p>After installation you can use the following tags to start using it in your project.</p>
<div><pre class="line-numbers"><code class="language-none"><lib-ngx-dhis2-validation-rule-filter
(update)="onUpdateValidationRule($event)"
(close)="onUpdateValidationRule($event)">
<lib-ngx-dhis2-validation-rule-filter></code></pre></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 = 0;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'getting-started';
var COMPODOC_CURRENT_PAGE_URL = 'index.html';
</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>