UNPKG

@rxap/table-system

Version:

This package provides a set of Angular directives, components, and services to enhance data tables with features like row expansion, full-text search, and row selection with checkboxes. It includes modules for easy integration of these features into exist

544 lines (432 loc) 19.8 kB
<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>angular-table-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-table-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 component"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Components</li> <li class="breadcrumb-item" > ExpandControlsCellComponent</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="nav-item"> <a href="#info" 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> <li class="nav-item"> <a href="#templateData" class="nav-link" role="tab" id="templateData-tab" data-bs-toggle="tab" data-link="template">Template</a> </li> <li class="nav-item"> <a href="#styleData" class="nav-link" role="tab" id="styleData-tab" data-bs-toggle="tab" data-link="style">Styles</a> </li> <li class="nav-item"> <a href="#tree" class="nav-link" role="tab" id="tree-tab" data-bs-toggle="tab" data-link="dom-tree">DOM Tree</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/expand-row/expand-controls-cell/expand-controls-cell.component.ts</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">changeDetection</td> <td class="col-md-9"><code>ChangeDetectionStrategy.OnPush</code></td> </tr> <tr> <td class="col-md-3">selector</td> <td class="col-md-9"><code>td[rxap-expand-controls-cell]</code></td> </tr> <tr> <td class="col-md-3">imports</td> <td class="col-md-9"> <code>MatButtonModule</code> <code>NgIf</code> <code>MatIconModule</code> <code>AsyncPipe</code> </td> </tr> <tr> <td class="col-md-3">styleUrls</td> <td class="col-md-9"><code>./expand-controls-cell.component.scss</code></td> </tr> <tr> <td class="col-md-3">templateUrl</td> <td class="col-md-9"><code>./expand-controls-cell.component.html</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"></span> <span class="modifier">Public</span> <span class="modifier">Readonly</span> <a href="#expandCell" >expandCell</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="#rxap-expand-controls-cell" >rxap-expand-controls-cell</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(expandCell: <a href="../injectables/ExpandRowService.html" target="_self">ExpandRowService&lt;Data&gt;</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="30" class="link-to-prism">src/lib/expand-row/expand-controls-cell/expand-controls-cell.component.ts:30</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>expandCell</td> <td> <code><a href="../injectables/ExpandRowService.html" target="_self" >ExpandRowService&lt;Data&gt;</a></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="rxap-expand-controls-cell"></a> <b>rxap-expand-controls-cell</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>Data</code> </td> </tr> <tr> <td class="col-md-4"> <i>Required : </i>&nbsp;<b>true</b> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="30" class="link-to-prism">src/lib/expand-row/expand-controls-cell/expand-controls-cell.component.ts:30</a></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="expandCell"></a> <span class="name"> <span class="modifier"></span> <span class="modifier">Public</span> <span class="modifier">Readonly</span> <span ><b>expandCell</b></span> <a href="#expandCell"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../injectables/ExpandRowService.html" target="_self" >ExpandRowService&lt;Data&gt;</a></code> </td> </tr> <tr> <td class="col-md-4"> <b>Decorators : </b> <br /> <code> @Inject(ExpandRowService)<br /> </code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="34" class="link-to-prism">src/lib/expand-row/expand-controls-cell/expand-controls-cell.component.ts:34</a></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 { ChangeDetectionStrategy, Component, Inject, Input, } from &#x27;@angular/core&#x27;; import { ExpandRowService } from &#x27;../expand-row.service&#x27;; import { Required } from &#x27;@rxap/utilities&#x27;; import { MatIconModule } from &#x27;@angular/material/icon&#x27;; import { AsyncPipe, NgIf, } from &#x27;@angular/common&#x27;; import { MatButtonModule } from &#x27;@angular/material/button&#x27;; @Component({ // eslint-disable-next-line @angular-eslint/component-selector selector: &#x27;td[rxap-expand-controls-cell]&#x27;, templateUrl: &#x27;./expand-controls-cell.component.html&#x27;, styleUrls: [&#x27;./expand-controls-cell.component.scss&#x27;], changeDetection: ChangeDetectionStrategy.OnPush, imports: [MatButtonModule, NgIf, MatIconModule, AsyncPipe] }) export class ExpandControlsCellComponent&lt;Data extends Record&lt;string, any&gt;&gt; { @Input({ required: true, alias: &#x27;rxap-expand-controls-cell&#x27;, }) public element!: Data; constructor( @Inject(ExpandRowService) public readonly expandCell: ExpandRowService&lt;Data&gt;, ) { } } </code></pre> </div> <div class="tab-pane fade " id="templateData"> <pre class="line-numbers"><code class="language-html">&lt;button type&#x3D;&quot;button&quot; mat-icon-button&gt; &lt;mat-icon *ngIf&#x3D;&quot;expandCell.isExpanded$(element) | async; else notExpanded&quot;&gt;expand_more&lt;/mat-icon&gt; &lt;ng-template #notExpanded&gt; &lt;mat-icon&gt;keyboard_arrow_right&lt;/mat-icon&gt; &lt;/ng-template&gt; &lt;/button&gt; </code></pre> </div> <div class="tab-pane fade " id="styleData"> <p class="comment"> <code>./expand-controls-cell.component.scss</code> </p> <pre class="line-numbers"><code class="language-scss"></code></pre> </div> <div class="tab-pane fade " id="tree"> <div id="tree-container"></div> <div class="tree-legend"> <div class="title"> <b>Legend</b> </div> <div> <div class="color htmlelement"></div><span>Html element</span> </div> <div> <div class="color component"></div><span>Component</span> </div> <div> <div class="color directive"></div><span>Html element with directive</span> </div> </div> </div> </div> <script src="../js/libs/vis.min.js"></script> <script src="../js/libs/htmlparser.js"></script> <script src="../js/libs/deep-iterator.js"></script> <script> var COMPONENT_TEMPLATE = '<div><button type="button" mat-icon-button> <mat-icon *ngIf="expandCell.isExpanded$(element) | async; else notExpanded">expand_more</mat-icon> <ng-template #notExpanded> <mat-icon>keyboard_arrow_right</mat-icon> </ng-template></button></div>' var COMPONENTS = [{'name': 'CheckboxCellComponent', 'selector': 'td[rxap-checkbox-cell]'},{'name': 'CheckboxHeaderCellComponent', 'selector': 'th[rxap-checkbox-header-cell]'},{'name': 'ExpandControlsCellComponent', 'selector': 'td[rxap-expand-controls-cell]'},{'name': 'ExpandRowContainerComponent', 'selector': 'td[rxap-expand-row]'}]; var DIRECTIVES = [{'name': 'AllRowsSelectedDirective', 'selector': '[rxapAllRowsSelected]'},{'name': 'ExpandRowContentDirective', 'selector': '[rxapExpandRowContent]'},{'name': 'ExpandRowDirective', 'selector': 'tr[rxapExpandRow]'},{'name': 'TableFilterInputDirective', 'selector': 'input[ngModel][rxapTableFilterInput]'}]; var ACTUAL_COMPONENT = {'name': 'ExpandControlsCellComponent'}; </script> <script src="../js/tree.js"></script> </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 = 'component'; var COMPODOC_CURRENT_PAGE_URL = 'ExpandControlsCellComponent.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>