@rxap/form-system
Version:
This package provides a set of directives, decorators, mixins, and validators to simplify the creation of dynamic forms in Angular applications. It offers features such as automatic control creation, data source integration, component customization, and h
935 lines (800 loc) • 36 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>angular-form-system</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">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">angular-form-system</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</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="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content directive">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Directives</li>
<li class="breadcrumb-item" >IsSelectableValueDirective</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/lib/validators/is-selectable-value.directive.ts</code>
</p>
<p class="comment">
<h3>Extends</h3>
</p>
<p class="comment">
<code><a href="../classes/ExtractOptionsDataSourceMixin.html" target="_self" >ExtractOptionsDataSourceMixin</a></code>
</p>
<p class="comment">
<h3>Implements</h3>
</p>
<p class="comment">
<code>Validator</code>
</p>
<section data-compodoc="block-metadata">
<h3>Metadata</h3>
<table class="table table-sm table-hover metadata">
<tbody>
<tr>
<td class="col-md-3">Providers</td>
<td class="col-md-9">
<code>
{
provide: NG_VALIDATORS, multi: true, useExisting: forwardRef(() => IsSelectableValueDirective),
}
</code>
</td>
</tr>
<tr>
<td class="col-md-3">Selector</td>
<td class="col-md-9"><code>[rxapIsSelectableValue]</code></td>
</tr>
<tr>
<td class="col-md-3">Standalone</td>
<td class="col-md-9"><code>true</code></td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Protected</span>
<span class="modifier">Optional</span>
<a href="#dataSource" >dataSource</a>
</li>
<li>
<span class="modifier">Protected</span>
<span class="modifier">Readonly</span>
<a href="#dataSourceLoader" >dataSourceLoader</a>
</li>
<li>
<span class="modifier">Protected</span>
<span class="modifier">Readonly</span>
<a href="#injector" >injector</a>
</li>
<li>
<span class="modifier">Protected</span>
<span class="modifier">Optional</span>
<a href="#metadata" >metadata</a>
</li>
<li>
<span class="modifier">Protected</span>
<span class="modifier">Optional</span>
<a href="#settings" >settings</a>
</li>
<li>
<span class="modifier">Protected</span>
<span class="modifier">Optional</span>
<a href="#useDataSourceValue" >useDataSourceValue</a>
</li>
<li>
<span class="modifier">Protected</span>
<span class="modifier">Optional</span>
<a href="#viewer" >viewer</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Public</span>
<a href="#validate" >validate</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#extractOptionsDatasource" >extractOptionsDatasource</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="#viewer" >viewer</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-constructor">
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(dataSourceLoader: DataSourceLoader, injector: Injector)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="43" class="link-to-prism">src/lib/validators/is-selectable-value.directive.ts:43</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>dataSourceLoader</td>
<td>
<code>DataSourceLoader</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>injector</td>
<td>
<code>Injector</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-inputs">
<h3 id="inputs">Inputs</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="viewer"></a>
<b>viewer</b>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>BaseDataSourceViewer</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{ id: '[rxapIsSelectableValue]' }</code>
</td>
</tr>
<tr>
<td class="col-md-2" colspan="2">
<div class="io-line">Defined in <a href="" data-line="43" class="link-to-prism">src/lib/validators/is-selectable-value.directive.ts:43</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-methods">
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="validate"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>validate</b></span>
<a href="#validate"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>validate(control: AbstractControl)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="53"
class="link-to-prism">src/lib/validators/is-selectable-value.directive.ts:53</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>control</td>
<td>
<code>AbstractControl</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>ValidationErrors | null</code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="extractOptionsDatasource"></a>
<span class="name">
<span class="modifier">Protected</span>
<span ><b>extractOptionsDatasource</b></span>
<a href="#extractOptionsDatasource"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>extractOptionsDatasource(control?: AbstractControl)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../classes/ExtractOptionsDataSourceMixin.html" target="_self" >ExtractOptionsDataSourceMixin</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../classes/ExtractOptionsDataSourceMixin.html#source" target="_self" >ExtractOptionsDataSourceMixin:76</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>control</td>
<td>
<code>AbstractControl</code>
</td>
<td>
Yes
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>BaseDataSource<ControlOptions | Record></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dataSource"></a>
<span class="name">
<span class="modifier">Protected</span>
<span class="modifier">Optional</span>
<span ><b>dataSource</b></span>
<a href="#dataSource"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>BaseDataSource<ControlOptions | Record></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../classes/ExtractOptionsDataSourceMixin.html" target="_self" >ExtractOptionsDataSourceMixin</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../classes/ExtractOptionsDataSourceMixin.html#source" target="_self" >ExtractOptionsDataSourceMixin:70</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dataSourceLoader"></a>
<span class="name">
<span class="modifier">Protected</span>
<span class="modifier">Readonly</span>
<span ><b>dataSourceLoader</b></span>
<a href="#dataSourceLoader"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>DataSourceLoader</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../classes/ExtractOptionsDataSourceMixin.html" target="_self" >ExtractOptionsDataSourceMixin</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../classes/ExtractOptionsDataSourceMixin.html#source" target="_self" >ExtractOptionsDataSourceMixin:64</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="injector"></a>
<span class="name">
<span class="modifier">Protected</span>
<span class="modifier">Readonly</span>
<span ><b>injector</b></span>
<a href="#injector"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Injector</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../classes/ExtractOptionsDataSourceMixin.html" target="_self" >ExtractOptionsDataSourceMixin</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../classes/ExtractOptionsDataSourceMixin.html#source" target="_self" >ExtractOptionsDataSourceMixin:72</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="metadata"></a>
<span class="name">
<span class="modifier">Protected</span>
<span class="modifier">Optional</span>
<span ><b>metadata</b></span>
<a href="#metadata"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>BaseDataSourceMetadata</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../classes/ExtractOptionsDataSourceMixin.html" target="_self" >ExtractOptionsDataSourceMixin</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../classes/ExtractOptionsDataSourceMixin.html#source" target="_self" >ExtractOptionsDataSourceMixin:66</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="settings"></a>
<span class="name">
<span class="modifier">Protected</span>
<span class="modifier">Optional</span>
<span ><b>settings</b></span>
<a href="#settings"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../miscellaneous/typealiases.html#UseOptionsDataSourceSettings" target="_self" >UseOptionsDataSourceSettings<any></a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../classes/ExtractOptionsDataSourceMixin.html" target="_self" >ExtractOptionsDataSourceMixin</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../classes/ExtractOptionsDataSourceMixin.html#source" target="_self" >ExtractOptionsDataSourceMixin:62</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="useDataSourceValue"></a>
<span class="name">
<span class="modifier">Protected</span>
<span class="modifier">Optional</span>
<span ><b>useDataSourceValue</b></span>
<a href="#useDataSourceValue"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/UseDataSourceValue.html" target="_self" >UseDataSourceValue<ControlOptions | Record></a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../classes/ExtractOptionsDataSourceMixin.html" target="_self" >ExtractOptionsDataSourceMixin</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../classes/ExtractOptionsDataSourceMixin.html#source" target="_self" >ExtractOptionsDataSourceMixin:74</a></code>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="viewer"></a>
<span class="name">
<span class="modifier">Protected</span>
<span class="modifier">Optional</span>
<span ><b>viewer</b></span>
<a href="#viewer"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>BaseDataSourceViewer</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Inherited from <code><a href="../classes/ExtractOptionsDataSourceMixin.html" target="_self" >ExtractOptionsDataSourceMixin</a></code>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <code><a href="../classes/ExtractOptionsDataSourceMixin.html#source" target="_self" >ExtractOptionsDataSourceMixin:68</a></code>
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import {
AbstractControl,
NG_VALIDATORS,
ValidationErrors,
Validator,
} from '@angular/forms';
import {
Directive,
forwardRef,
Inject,
INJECTOR,
Injector,
Input,
isDevMode,
} from '@angular/core';
import {
BaseDataSourceViewer,
DataSourceLoader,
} from '@rxap/data-source';
import { Mixin } from '@rxap/mixin';
import { ControlOptions } from '@rxap/utilities';
import { ExtractOptionsDataSourceMixin } from '../mixins/extract-options-data-source.mixin';
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface IsSelectableValueDirective extends ExtractOptionsDataSourceMixin {
}
@Mixin(ExtractOptionsDataSourceMixin)
@Directive({
selector: '[rxapIsSelectableValue]',
providers: [
{
provide: NG_VALIDATORS,
multi: true,
useExisting: forwardRef(() => IsSelectableValueDirective),
},
],
standalone: true,
})
export class IsSelectableValueDirective implements Validator {
@Input()
public viewer: BaseDataSourceViewer = { id: '[rxapIsSelectableValue]' };
constructor(
@Inject(DataSourceLoader)
protected readonly dataSourceLoader: DataSourceLoader,
@Inject(INJECTOR)
protected readonly injector: Injector,
) {
}
public validate(control: AbstractControl): ValidationErrors | null {
if (control.value) {
this.extractOptionsDatasource(control);
const data = this.useDataSourceValue?.lastValue;
if (data) {
let options: ControlOptions;
if (Array.isArray(data)) {
options = data;
} else {
options = Object.entries(data)
.map(([ value, display ]) => ({
value,
display,
}));
}
if (!options.some(option => option.value === control.value)) {
return {
isSelectableValue: {
expected: 'Value should be from the list of provided options',
},
};
}
} else if (isDevMode()) {
console.warn('The last value from the OptionsDataSource is empty', this);
}
}
return null;
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results 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>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'directive';
var COMPODOC_CURRENT_PAGE_URL = 'IsSelectableValueDirective.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.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>