Skip to content

Commit

Permalink
API Doc Cosmetics
Browse files Browse the repository at this point in the history
  • Loading branch information
@gucal
gucal committed Oct 11, 2023
1 parent 4ab301e commit 2cf50c9
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 14 deletions.
39 changes: 28 additions & 11 deletions src/app/showcase/layout/doc/docapitable/app.docapitable.component.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,40 @@
</thead>
<tbody>
<tr *ngFor="let prop of data">
<td *ngFor="let entry of getEntries(prop)" [ngClass]="{'doc-option-type': entry[0] === 'type', 'doc-option-default': entry[0] === 'default'}">
<ng-container *ngIf="entry[0] !== 'readonly' && entry[0] !== 'optional' && entry[0] !== 'deprecated'">
<span *ngIf="entry[0] === 'name'" [attr.id]="id + '.' + entry[1]" class="doc-option-name" [ngClass]="{'line-through cursor-pointer': !!prop.deprecated}" [attr.title]="prop.deprecated">{{entry[1] || '-'}}<a (click)="navigate($event, entry[1])" class="doc-option-link"><i class="pi pi-link"></i></a></span>
<span *ngIf="entry[0] === 'type'">{{entry[1] || '-'}}</span>
<td *ngFor="let entry of getEntries(prop)">
<ng-container
*ngIf="entry[0] !== 'readonly' && entry[0] !== 'optional' && entry[0] !== 'deprecated'">
<span *ngIf="entry[0] === 'name'" [attr.id]="id + '.' + entry[1]" class="doc-option-name"
[ngClass]="{'line-through cursor-pointer': !!prop.deprecated}"
[attr.title]="prop.deprecated">{{entry[1] || '-'}}<a
(click)="navigate($event, entry[1])" class="doc-option-link"><i
class="pi pi-link"></i></a></span>
<span *ngIf="entry[0] === 'type'" class="doc-option-type">{{entry[1] || '-'}}</span>
<ng-container *ngIf="entry[0] === 'parameters'">
<ng-container *ngIf="entry[1].name; else nullValue">
<span *ngIf="entry[1].name" [ngClass]="{'parameter-bold': label === 'Templates'}">{{entry[1].name}} :</span>
<ng-container *ngFor="let value of getType(entry[1].type); let i = index;">{{i !== 0 ? ' |' : ' ' }} <a *ngIf="isLinkType(value); else elseBlock" (click)="scrollToLinkedElement($event, value, prop)" class="cursor-pointer text-primary">{{value || '-'}}</a>
<div class="doc-option-params" *ngIf="entry[1].name; else nullValue">
<span *ngIf="entry[1].name"
[ngClass]="{'doc-option-parameter-name': label === 'Emitters', 'text-primary-700':label === 'Templates'}">{{entry[1].name}}
:</span>
<ng-container *ngFor="let value of getType(entry[1].type); let i = index;">{{i !== 0
? ' |' : ' ' }} <a *ngIf="isLinkType(value); else elseBlock"
(click)="scrollToLinkedElement($event, value, prop)"
[ngClass]="{'doc-option-parameter-type':label === 'Emitters', 'text-primary-700':label==='Templates'}">{{value || '-'}}</a>
<ng-template #elseBlock>
<span>{{value}}</span>
<span [ngClass]="{'doc-option-parameter-type':label === 'Emitters', 'text-primary-700':label==='Templates'}">{{value}}</span>
</ng-template>
</ng-container>
</ng-container>
</div>
<ng-template #nullValue>
<span>null</span>
</ng-template>
</ng-container>
<span *ngIf="entry[0] !== 'name' && entry[0] !== 'type' && entry[0] !== 'parameters'" [id]="id + '.' + entry[0]">{{entry[1]}}</span>
<span [ngClass]="{
'doc-option-dark': config.dark && entry[0] === 'default',
'doc-option-light': !config.dark && entry[0] === 'default',
'doc-option-default': entry[0] === 'default',
'doc-option-description': entry[0] === 'description'
}" *ngIf="entry[0] !== 'name' && entry[0] !== 'type' && entry[0] !== 'parameters'"
[id]="id + '.' + entry[0]">{{ entry[1] }}</span>
</ng-container>
</td>
</tr>
Expand All @@ -46,7 +62,8 @@

<ng-container *ngIf="data[0].data && data[0].data.length > 0">
<ng-container *ngFor="let childData of data;">
<app-docapitable [id]="childData.id" [data]="childData.data" [label]="childData.label" [description]="childData.description" [relatedProp]="childData.relatedProp"></app-docapitable>
<app-docapitable [id]="childData.id" [data]="childData.data" [label]="childData.label"
[description]="childData.description" [relatedProp]="childData.relatedProp"></app-docapitable>
</ng-container>
</ng-container>
</ng-container>
25 changes: 22 additions & 3 deletions src/app/showcase/layout/doc/docapitable/app.docapitable.component.ts
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import { Location } from '@angular/common';
import { ChangeDetectionStrategy, Component, Input, OnInit, ViewContainerRef } from '@angular/core';
import { Router } from '@angular/router';
import { Location } from '@angular/common';
import { Subscription } from 'rxjs';
import { AppConfig } from 'src/app/showcase/domain/appconfig';
import { AppConfigService } from 'src/app/showcase/service/appconfigservice';

@Component({
selector: 'app-docapitable',
Expand Down Expand Up @@ -29,9 +32,19 @@ export class AppDocApiTable implements OnInit {

@Input() isInterface: boolean = false;

constructor(public viewContainerRef: ViewContainerRef, public router: Router, public location: Location) {}
config: AppConfig;

subscription: Subscription;

ngOnInit() {}
constructor(public viewContainerRef: ViewContainerRef, public router: Router, public location: Location, public configService: AppConfigService) {}

ngOnInit() {
this.config = this.configService.config;

this.subscription = this.configService.configUpdate$.subscribe((config) => {
this.config = config;
});
}

navigate(event, param) {
if (typeof window !== undefined) {
Expand Down Expand Up @@ -106,4 +119,10 @@ export class AppDocApiTable implements OnInit {
label && label.parentElement.scrollIntoView({ block: 'start', behavior: 'smooth' });
}
}

ngOnDestroy() {
if (this.subscription) {
this.subscription.unsubscribe();
}
}
}

1 comment on commit 2cf50c9

@vercel
Copy link

@vercel vercel bot commented on 2cf50c9 Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

primeng-ssr-test – ./

primeng-ssr-test-git-master-primeng-test.vercel.app
primeng-ssr-test-primeng-test.vercel.app
primeng-ssr-test.vercel.app

Please sign in to comment.