Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add click functionality #32

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,26 @@ To collapse all nodes at first:
```html
<ngx-json-viewer [json]="someObject" [expanded]="false"></ngx-json-viewer>
```

To make the segment clickable

HTML
```html
<ngx-json-viewer [json]="someObject"
[isSegmentClickable]="isClickable"
(segmentClicked)="segmentClickHandler($event)"></ngx-json-viewer>
```
TS
```typescript
const someObject = {users:[{id:123, name:"user1"},{id:234, name:"user2"}]};

function isClickable(segment:NgxJsonSegment):boolean{
return segment.path === "users.0.id";
}
function segmentClickHandler(segment:NgxJsonSegment){
if (segment.path === "users.0.id"){
console.log(`the userId is ${segment.value}`);
}
}
```

2 changes: 1 addition & 1 deletion index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export { NgxJsonViewerModule } from "./src/ngx-json-viewer.module";
export { NgxJsonViewerComponent } from "./src/ngx-json-viewer/ngx-json-viewer.component";
export { NgxJsonViewerComponent, NgxJsonSegment } from "./src/ngx-json-viewer/ngx-json-viewer.component";
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ngx-json-viewer",
"version": "2.4.0",
"version": "2.5.0",
"description": "JSON formatter / viewer for Angular 2/4/5/6/7+",
"keywords": [
"angular",
Expand Down
17 changes: 15 additions & 2 deletions src/ngx-json-viewer/ngx-json-viewer.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,23 @@
<div *ngIf="isExpandable(segment)" class="toggler"></div>
<span class="segment-key">{{ segment.key }}</span>
<span class="segment-separator">: </span>
<span *ngIf="!segment.expanded || !isExpandable(segment)" class="segment-value">{{ segment.description }}</span>
<ng-container *ngIf="!segment.expanded || !isExpandable(segment)">
<div *ngIf="isClickable(segment); then clickableDesc else noClickableDesc"></div>
<ng-template #clickableDesc>
<a class="segment-value" (click)="segmentClickHandler(segment)">{{ segment.description }}</a>
</ng-template>
<ng-template #noClickableDesc>
<span class="segment-value">{{ segment.description }}</span>
</ng-template>
</ng-container>
</section>
<section *ngIf="segment.expanded && isExpandable(segment)" class="children">
<ngx-json-viewer [json]="segment.value" [expanded]="expanded"></ngx-json-viewer>
<ngx-json-viewer [json]="segment.value"
[expanded]="expanded"
[_parent]="segment"
[isSegmentClickable]="isSegmentClickable"
(segmentClicked)="segmentClickHandler($event)"></ngx-json-viewer>
</section>
</section>
</section>

4 changes: 4 additions & 0 deletions src/ngx-json-viewer/ngx-json-viewer.component.scss
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,8 @@ $type-colors: (
.expandable > .toggler {
cursor: pointer;
}
a{
cursor: pointer;
text-decoration: underline;
}
}
33 changes: 25 additions & 8 deletions src/ngx-json-viewer/ngx-json-viewer.component.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
import { Component, OnChanges, Input } from '@angular/core';
import {Component, OnChanges, Input, Output, EventEmitter} from '@angular/core';

export interface Segment {
export interface NgxJsonSegment {
parent: NgxJsonSegment | undefined;
key: string;
value: any;
type: undefined | string;
description: string;
expanded: boolean;
path: string;
}

type IsSegmentClickableFn = (segment: NgxJsonSegment) => boolean;

@Component({
selector: 'ngx-json-viewer',
templateUrl: './ngx-json-viewer.component.html',
Expand All @@ -21,35 +25,48 @@ export class NgxJsonViewerComponent implements OnChanges {
* @deprecated It will be always true and deleted in version 3.0.0
*/
@Input() cleanOnChange = true;
@Input() isSegmentClickable: IsSegmentClickableFn;
@Input() _parent: NgxJsonSegment | undefined = undefined;
@Output() segmentClicked = new EventEmitter<NgxJsonSegment>();

segments: Segment[] = [];
segments: NgxJsonSegment[] = [];

ngOnChanges() {
if (this.cleanOnChange) {
this.segments = [];
}

if (typeof this.json === 'object') {
Object.keys(this.json).forEach( key => {
Object.keys(this.json).forEach(key => {
this.segments.push(this.parseKeyValue(key, this.json[key]));
});
} else {
this.segments.push(this.parseKeyValue(`(${typeof this.json})`, this.json));
}
}

isExpandable(segment: Segment) {
isExpandable(segment: NgxJsonSegment) {
return segment.type === 'object' || segment.type === 'array';
}

toggle(segment: Segment) {
toggle(segment: NgxJsonSegment) {
if (this.isExpandable(segment)) {
segment.expanded = !segment.expanded;
}
}

private parseKeyValue(key: any, value: any): Segment {
const segment: Segment = {
segmentClickHandler(segment: NgxJsonSegment) {
this.segmentClicked.emit(segment);
}

isClickable(segment: NgxJsonSegment): boolean {
return this.isSegmentClickable && this.isSegmentClickable(segment);
}

private parseKeyValue(key: any, value: any): NgxJsonSegment {
const segment: NgxJsonSegment = {
parent: this._parent,
path: this._parent ? `${this._parent.path}.${key}` : key,
key: key,
value: value,
type: undefined,
Expand Down