A simple Angular component to display object data in an expandable JSON tree view.

See it in action on StackBlitz.

• Display JSON objects and arrays in a collapsible tree structure.
• Customize styling with CSS variables.
• Clickable value nodes for custom interactions.
• Control over initial expansion depth.
• Keyboard navigable

npm install ngx-json-treeview

By default, JSON objects are rendered fully expanded:

<ngx-json-treeview[json]="someObject" />

To render the JSON with all nodes initially collapsed:

<ngx-json-treeview[json]="someObject" [expanded]="false" />

Or with nodes expanded up to a certain depth:

<ngx-json-treeview[json]="someObject" [depth]="1" />

You can make values in the JSON tree clickable to trigger custom actions. For convenience, a default click handler is provided for URLs (which will be opened in a new tab, when clicked.)

1. Enable Clickable Values: Set the enableClickableValues input to true. This also enables the default click handler(s) automatically.

   <ngx-json-treeview[json]="someObject" [enableClickableValues]="true" />

2. Provide Click Handlers: Provide your own custom behaviors by passing an array of ValueClickHandler objects to the valueClickHandlers input.

   A ValueClickHandler has two properties:

   • canHandle: A function that returns true if the handler should apply to a given value.
   • handler: The function to execute when the value is clicked.

   Only the first handler in the array where canHandle returns true will be executed.

Here's how you could implement a handler that copies a string value to the clipboard when clicked.

In your component's TypeScript file:

import{Segment,ValueClickHandler}from'ngx-json-treeview';// Define a custom click handler copyToClipboardHandler: ValueClickHandler={canHandle: (segment: Segment)=>typeofsegment.value==='string',handler: (segment: Segment)=>{navigator.clipboard.writeText(segment.value).then(()=>{alert(`Copied "${segment.value}" to clipboard!`);});},}; customValueClickHandlers: ValueClickHandler[]=[this.copyToClipboardHandler,// Add addt'l custom handlers here];

In your component's HTML file:

<ngx-json-treeview[json]="someObject" [enableClickableValues]="true" [valueClickhandlers]="customValueClickHandlers" />

In this example, any string value will be clickable. When clicked, it will be copied to the clipboard.

Custom handlers can be combined alongside the built-in ones (such as the URL handler). To apply all of the default built-in handlers, you can import the VALUE_CLICK_HANDLERS array and spread it into your customValueClickHandlers array. Alternatively, handlers be the imported individually via ValueClickHandlers.

import{ValueClickHandlers,VALUE_CLICK_HANDLERS,}from'ngx-json-treeview'; customValueClickHandlers: ValueClickHandler[]=[ ...VALUE_CLICK_HANDLERS,this.copyToClipboardHandler,];// OR customValueClickHandlers: ValueClickHandler[]=[ValueClickHandlers.followLinkHandler,this.copyToClipboardHandler,];

In this example, any string that matches a URL will trigger the followLinkHandler, and all other strings will trigger the copyToClipboardHandler.

You can customize the appearance of the tree view using these CSS variables:

ngx-json-treeview is originally based on ngx-json-viewer by Vivo Xu and contributors.