@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
653 lines (522 loc) • 24 kB
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"
>
CheckboxHeaderCellComponent</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/select-row/checkbox-header-cell/checkbox-header-cell.component.ts</code>
</p>
<p class="comment">
<h3>Implements</h3>
</p>
<p class="comment">
<code>OnInit</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>th[rxap-checkbox-header-cell]</code></td>
</tr>
<tr>
<td class="col-md-3">imports</td>
<td class="col-md-9">
<code>MatCheckboxModule</code>
<code>AsyncPipe</code>
</td>
</tr>
<tr>
<td class="col-md-3">styleUrls</td>
<td class="col-md-9"><code>./checkbox-header-cell.component.scss</code></td>
</tr>
<tr>
<td class="col-md-3">templateUrl</td>
<td class="col-md-9"><code>./checkbox-header-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">Public</span>
<a href="#checked$" >checked$</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#indeterminate$" >indeterminate$</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="#onChange" >onChange</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(cdkTable: CdkTable<Data>, selectRow: <a href="../injectables/SelectRowService.html" target="_self">SelectRowService<Data></a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="31" class="link-to-prism">src/lib/select-row/checkbox-header-cell/checkbox-header-cell.component.ts:31</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>cdkTable</td>
<td>
<code>CdkTable<Data></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>selectRow</td>
<td>
<code><a href="../injectables/SelectRowService.html" target="_self" >SelectRowService<Data></a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</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="onChange"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>onChange</b></span>
<a href="#onChange"><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>onChange($event: MatCheckboxChange)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="49"
class="link-to-prism">src/lib/select-row/checkbox-header-cell/checkbox-header-cell.component.ts:49</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>$event</td>
<td>
<code>MatCheckboxChange</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<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>
<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="checked$"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>checked$</b></span>
<a href="#checked$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Observable<boolean></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>EMPTY</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="31" class="link-to-prism">src/lib/select-row/checkbox-header-cell/checkbox-header-cell.component.ts:31</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="indeterminate$"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>indeterminate$</b></span>
<a href="#indeterminate$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Observable<boolean></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>EMPTY</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/select-row/checkbox-header-cell/checkbox-header-cell.component.ts:30</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,
OnInit,
} from '@angular/core';
import { SelectRowService } from '../select-row.service';
import {
EMPTY,
Observable,
} from 'rxjs';
import { map } from 'rxjs/operators';
import {
MatCheckboxChange,
MatCheckboxModule,
} from '@angular/material/checkbox';
import { CdkTable } from '@angular/cdk/table';
import { AsyncPipe } from '@angular/common';
@Component({
// eslint-disable-next-line @angular-eslint/component-selector
selector: 'th[rxap-checkbox-header-cell]',
templateUrl: './checkbox-header-cell.component.html',
styleUrls: ['./checkbox-header-cell.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
imports: [MatCheckboxModule, AsyncPipe]
})
export class CheckboxHeaderCellComponent<Data extends Record<string, any>> implements OnInit {
public indeterminate$: Observable<boolean> = EMPTY;
public checked$: Observable<boolean> = EMPTY;
constructor(
@Inject(CdkTable)
private readonly cdkTable: CdkTable<Data>,
private readonly selectRow: SelectRowService<Data>,
) {
}
public ngOnInit() {
this.indeterminate$ = this.selectRow.selectedRows$.pipe(
map(selectedRows => !!selectedRows.length && this.cdkTable['_data'].length !== selectedRows.length),
);
this.checked$ = this.selectRow.selectedRows$.pipe(
map(selectedRows => !!selectedRows.length && this.cdkTable['_data'].length === selectedRows.length),
);
}
public onChange($event: MatCheckboxChange) {
if ($event.checked) {
this.selectRow.selectionModel.select(...this.cdkTable['_data']);
} else {
this.selectRow.selectionModel.clear();
}
}
}
</code></pre>
</div>
<div class="tab-pane fade " id="templateData">
<pre class="line-numbers"><code class="language-html"><mat-checkbox
(change)="onChange($event)"
[checked]="(checked$ | async) ?? false"
[indeterminate]="indeterminate$ | async">
</mat-checkbox>
</code></pre>
</div>
<div class="tab-pane fade " id="styleData">
<p class="comment">
<code>./checkbox-header-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><mat-checkbox (change)="onChange($event)" [checked]="(checked$ | async) ?? false" [indeterminate]="indeterminate$ | async"></mat-checkbox></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': 'CheckboxHeaderCellComponent'};
</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 = 'CheckboxHeaderCellComponent.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>