@rxap/ngx-changelog
Version:
This package provides Angular components and services to display changelogs within an application. It fetches changelog data from a remote source and presents it in a user-friendly dialog or component, allowing users to view updates and changes. The packa
805 lines (678 loc) • 32.1 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>angular-changelog</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-changelog</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"
>
ChangelogComponent</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/changelog/changelog.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">selector</td>
<td class="col-md-9"><code>rxap-changelog</code></td>
</tr>
<tr>
<td class="col-md-3">imports</td>
<td class="col-md-9">
<code>MethodTemplateDirective</code>
<code>MarkdownModule</code>
<code>NgForOf</code>
<code>NgIf</code>
<code>NgClass</code>
</td>
</tr>
<tr>
<td class="col-md-3">styleUrls</td>
<td class="col-md-9"><code>./changelog.component.scss</code></td>
</tr>
<tr>
<td class="col-md-3">templateUrl</td>
<td class="col-md-9"><code>./changelog.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>
<span class="modifier">Readonly</span>
<a href="#activeIndex" >activeIndex</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#application" >application</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#availableVersions" >availableVersions</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#displayedButtons" >displayedButtons</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#error" >error</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#getChangelogMethod" >getChangelogMethod</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#getChangelogMethodParameters" >getChangelogMethodParameters</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#selectedVersion" >selectedVersion</a>
</li>
</ul>
</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="activeIndex"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>activeIndex</b></span>
<a href="#activeIndex"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>signal(-1)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="35" class="link-to-prism">src/lib/changelog/changelog.component.ts:35</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="application"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>application</b></span>
<a href="#application"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>inject(RXAP_ENVIRONMENT).app</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="70" class="link-to-prism">src/lib/changelog/changelog.component.ts:70</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="availableVersions"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>availableVersions</b></span>
<a href="#availableVersions"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>signal<string[]>([])</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="33" class="link-to-prism">src/lib/changelog/changelog.component.ts:33</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="displayedButtons"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>displayedButtons</b></span>
<a href="#displayedButtons"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>computed(() => {
let activeIndex = this.activeIndex();
if (activeIndex === -1) {
activeIndex = this.availableVersions().length - 1;
}
let start = Math.max(0, activeIndex - 2);
let end = Math.min(this.availableVersions().length, activeIndex + 3);
if (end - start < 5) {
if (start === 0) {
end += 5 - (end - start);
} else {
start -= 5 - (end - start);
}
}
end = Math.min(this.availableVersions().length, end);
start = Math.max(0, start);
return Array.from(
{ length: end - start },
(_, i) => ({
index: start + i,
version: this.availableVersions()[start + i],
}),
);
})</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="45" class="link-to-prism">src/lib/changelog/changelog.component.ts:45</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="error"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>error</b></span>
<a href="#error"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>signal<string | null>(null)</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/changelog/changelog.component.ts:34</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getChangelogMethod"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>getChangelogMethod</b></span>
<a href="#getChangelogMethod"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>inject(ChangelogControllerGetVersionRemoteMethod)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="72" class="link-to-prism">src/lib/changelog/changelog.component.ts:72</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getChangelogMethodParameters"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>getChangelogMethodParameters</b></span>
<a href="#getChangelogMethodParameters"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>computed(() => ({
parameters: {
version: this.selectedVersion(),
application: this.application,
},
}))</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="74" class="link-to-prism">src/lib/changelog/changelog.component.ts:74</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="selectedVersion"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>selectedVersion</b></span>
<a href="#selectedVersion"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>computed(() => {
const activeIndex = this.activeIndex();
const availableVersions = this.availableVersions();
if (activeIndex > -1) {
return availableVersions[activeIndex] ?? 'latest';
}
return availableVersions[availableVersions.length - 1] ?? 'latest';
})</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="36" class="link-to-prism">src/lib/changelog/changelog.component.ts:36</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 {
NgClass,
NgForOf,
NgIf,
} from '@angular/common';
import {
Component,
computed,
inject,
OnInit,
signal,
} from '@angular/core';
import { MethodTemplateDirective } from '@rxap/directives';
import { RXAP_ENVIRONMENT } from '@rxap/environment';
import { MarkdownModule } from 'ngx-markdown';
import { ChangelogControllerGetVersionRemoteMethod } from '../openapi/remote-methods/changelog-controller-get-version.remote-method';
import { ChangelogControllerListRemoteMethod } from '../openapi/remote-methods/changelog-controller-list.remote-method';
@Component({
selector: 'rxap-changelog',
imports: [
MethodTemplateDirective,
MarkdownModule,
NgForOf,
NgIf,
NgClass,
],
templateUrl: './changelog.component.html',
styleUrls: ['./changelog.component.scss']
})
export class ChangelogComponent implements OnInit {
public readonly availableVersions = signal<string[]>([]);
public readonly error = signal<string | null>(null);
public readonly activeIndex = signal(-1);
public readonly selectedVersion = computed(() => {
const activeIndex = this.activeIndex();
const availableVersions = this.availableVersions();
if (activeIndex > -1) {
return availableVersions[activeIndex] ?? 'latest';
}
return availableVersions[availableVersions.length - 1] ?? 'latest';
});
public readonly displayedButtons = computed(() => {
let activeIndex = this.activeIndex();
if (activeIndex === -1) {
activeIndex = this.availableVersions().length - 1;
}
let start = Math.max(0, activeIndex - 2);
let end = Math.min(this.availableVersions().length, activeIndex + 3);
if (end - start < 5) {
if (start === 0) {
end += 5 - (end - start);
} else {
start -= 5 - (end - start);
}
}
end = Math.min(this.availableVersions().length, end);
start = Math.max(0, start);
return Array.from(
{ length: end - start },
(_, i) => ({
index: start + i,
version: this.availableVersions()[start + i],
}),
);
});
public readonly application = inject(RXAP_ENVIRONMENT).app;
public readonly getChangelogMethod = inject(ChangelogControllerGetVersionRemoteMethod);
public readonly getChangelogMethodParameters = computed(() => ({
parameters: {
version: this.selectedVersion(),
application: this.application,
},
}));
private readonly getAvailableVersionsMethod = inject(ChangelogControllerListRemoteMethod);
ngOnInit() {
this.loadAvailableVersions();
}
private async loadAvailableVersions() {
try {
const availableVersions = await this.getAvailableVersionsMethod.call();
this.availableVersions.set(availableVersions);
this.activeIndex.set(availableVersions.length - 1);
} catch (e: any) {
this.error.set(e.message);
}
}
}
</code></pre>
</div>
<div class="tab-pane fade " id="templateData">
<pre class="line-numbers"><code class="language-html"><ng-container *ngIf="error(); else noError">
<h2 class="text-2xl pb-2" i18n>Something has gone wrong!</h2>
<p i18n>Unable to load the application changelog</p>
</ng-container>
<ng-template #noError>
<div class="flex flex-col gap-3">
<ng-container *ngIf="availableVersions().length">
<div class="controls flex justify-center space-x-2 my-4">
<button
(click)="activeIndex.set(activeIndex() - 1)"
[disabled]="activeIndex() <= 0"
[ngClass]="{
'bg-gray-100 dark:bg-gray-900': activeIndex() <= 0,
'hover:bg-gray-300': activeIndex() > 0,
}"
class="px-4 py-2 bg-gray-200 dark:bg-gray-800 dark:hover:bg-gray-900 transition-colors duration-150 rounded">Previous
</button>
<button (click)="activeIndex.set(item.index)"
*ngFor="let item of displayedButtons()"
[ngClass]="{
'bg-primary-500': item.index === activeIndex(),
'bg-gray-200 dark:bg-gray-800 dark:hover:bg-gray-900 hover:bg-gray-300 transition-colors duration-150': item.index !== activeIndex()
}"
class="px-4 py-2 rounded">
{{ item.version }}
</button>
<button
(click)="activeIndex.set(activeIndex() + 1)"
[disabled]="activeIndex() >= availableVersions().length - 1"
[ngClass]="{
'bg-gray-100 dark:bg-gray-900': activeIndex() >= availableVersions().length - 1,
'hover:bg-gray-300': activeIndex() < availableVersions().length - 1,
}"
class="px-4 py-2 bg-gray-200 dark:bg-gray-800 dark:hover:bg-gray-900 hover:bg-gray-300 transition-colors duration-150 rounded">Next
</button>
</div>
<hr>
</ng-container>
<div class="flex flex-col gap-6 p-8 overflow-auto" style="max-height: 60vh">
<ng-container *rxapMethod="let changelog call getChangelogMethod; parameters: getChangelogMethodParameters()">
<markdown *ngFor="let general of changelog.general" [data]="general" class="prose dark:prose-invert">
</markdown>
<markdown *ngFor="let application of changelog.application" [data]="application" class="prose dark:prose-invert">
</markdown>
</ng-container>
</div>
</div>
</ng-template>
</code></pre>
</div>
<div class="tab-pane fade " id="styleData">
<p class="comment">
<code>./changelog.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><ng-container *ngIf="error(); else noError"> <h2 class="text-2xl pb-2" i18n>Something has gone wrong!</h2> <p i18n>Unable to load the application changelog</p></ng-container><ng-template #noError><div class="flex flex-col gap-3"> <ng-container *ngIf="availableVersions().length"> <div class="controls flex justify-center space-x-2 my-4"> <button (click)="activeIndex.set(activeIndex() - 1)" [disabled]="activeIndex() <= 0" [ngClass]="{ \'bg-gray-100 dark:bg-gray-900\': activeIndex() <= 0, \'hover:bg-gray-300\': activeIndex() > 0, }" class="px-4 py-2 bg-gray-200 dark:bg-gray-800 dark:hover:bg-gray-900 transition-colors duration-150 rounded">Previous </button> <button (click)="activeIndex.set(item.index)" *ngFor="let item of displayedButtons()" [ngClass]="{ \'bg-primary-500\': item.index === activeIndex(), \'bg-gray-200 dark:bg-gray-800 dark:hover:bg-gray-900 hover:bg-gray-300 transition-colors duration-150\': item.index !== activeIndex() }" class="px-4 py-2 rounded"> {{ item.version }} </button> <button (click)="activeIndex.set(activeIndex() + 1)" [disabled]="activeIndex() >= availableVersions().length - 1" [ngClass]="{ \'bg-gray-100 dark:bg-gray-900\': activeIndex() >= availableVersions().length - 1, \'hover:bg-gray-300\': activeIndex() < availableVersions().length - 1, }" class="px-4 py-2 bg-gray-200 dark:bg-gray-800 dark:hover:bg-gray-900 hover:bg-gray-300 transition-colors duration-150 rounded">Next </button> </div> <hr> </ng-container> <div class="flex flex-col gap-6 p-8 overflow-auto" style="max-height: 60vh"> <ng-container *rxapMethod="let changelog call getChangelogMethod; parameters: getChangelogMethodParameters()"> <markdown *ngFor="let general of changelog.general" [data]="general" class="prose dark:prose-invert"> </markdown> <markdown *ngFor="let application of changelog.application" [data]="application" class="prose dark:prose-invert"> </markdown> </ng-container> </div></div></ng-template></div>'
var COMPONENTS = [{'name': 'ChangelogComponent', 'selector': 'rxap-changelog'},{'name': 'ChangelogDialogComponent', 'selector': 'rxap-changelog-dialog'}];
var DIRECTIVES = [];
var ACTUAL_COMPONENT = {'name': 'ChangelogComponent'};
</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 = 'ChangelogComponent.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>