JsonViewer

When to use

The JsonViewer component can be used for the display and editing of JSON data.

Semi mainly referred to the design concept of the text-buffer data structure of VS Code, reused some utilities and data type definitions (Token parsing, language services, etc.), and implemented the JsonViewer component in combination with our functional/style customization requirements. Visually, it will be more coordinated with other components within the Semi Design Next system, and it will be more convenient for customized rendering and customization of specific data types.

Compared with directly using MonacoEditor, Semi JsonViewer has additional processing in engineering construction, is simpler to use, and there is no need to pay attention to complex configurations such as Webpack plugins and worker loaders. At the same time, since we only focus on the JSON data format, it is more lightweight. While being ready to use out of the box, it has a smaller size (📦-96%), a more extreme loading speed (🚀 -53.5%), and less memory occupation (⬇️71.6% reduction). For data with five million lines and below, data loading and parsing can be completed within 1 second.

Detailed comparison data can be referred to in the Performance section.

• If you only need to preview/edit JSON and don't need to modify other more complex programming languages, we recommend that you choose JsonViewer.
• If you also need to handle data/code files in other formats and the full capabilities of a code editor (syntax highlighting, code completion, error prompts, complex editing, etc.) are essential and the build product size is not a key concern, we recommend that you choose Monaco Editor.

Demos

How to import

import { JsonViewer } from '@fibrous/semi-ui-react';

Basic Usage

Basic usage of JsonViewer. Pass in the height and width parameters to set the height, width and initial value of the component. Pass in the JSON string through the value. onChange is called with the editor's current text when the content changes. The editor is re-created only when value becomes different from the editor's current content, so writing the onChange text back into value (setState) keeps the caret; while value stays the same, the editor keeps what the user typed. If you need to get the component's value, you can get it through ref, please refer to Methods for details.

import { JsonViewer } from '@fibrous/semi-ui-react';
const data = `{
    "name": "Semi",
    "version": "0.0.0"
}`;
export default function JsonViewerDemo() {
    return (
        <div style={{ marginBottom: 16 }}>
            <JsonViewer height={100} width={700} value={data} />
        </div>
    );
}

Different lineHeight

Configure the lineHeight parameter of options to set a fixed line height (unit: px, default 20).

import { JsonViewer } from '@fibrous/semi-ui-react';
const data = `{
    "name": "Semi",
    "version": "0.0.0"
}`;
export default function JsonViewerDemo() {
    return (
        <div>
            <div style={{ marginBottom: 12, overflow: 'hidden' }}>
                <JsonViewer height={100} width={700} value={data} options={{ lineHeight: 20 }} />
            </div>
            <div style={{ marginBottom: 12, overflow: 'hidden' }}>
                <JsonViewer height={120} width={700} value={data} options={{ lineHeight: 24 }} />
            </div>
            <div style={{ marginBottom: 12, overflow: 'hidden' }}>
                <JsonViewer height={120} width={700} value={data} options={{ lineHeight: 26 }} />
            </div>
        </div>
    );
}

Autowrap

Configure the autoWrap parameter of options. When it is set to true, the component will automatically wrap lines according to the length of the content.

import { JsonViewer } from '@fibrous/semi-ui-react';
const data = `{
    "name": "Semi",
    "version": "0.0.0",
    "description": "Semi Design is a design system that defines a set of mid_back design and front_end basic components."
}`;
export default function JsonViewerDemo() {
    return (
        <div style={{ marginBottom: 16 }}>
            <JsonViewer height={120} width={700} value={data} options={{ autoWrap: true }} />
        </div>
    );
}

Format options

Configure options.formatOptions to set the formatting configuration of the component.

• tabSize: number，set the indent size to 4, which means each level of indentation is 4 spaces.
• insertSpaces: boolean，when it is true, it means using spaces for indentation, and when it is false, it means using tabs.
• eol: string，set the line break character, which can be \n，\r\n，

import { useRef } from 'react';
import { JsonViewer, Button, type JsonViewerHandle } from '@fibrous/semi-ui-react';
const data = `{
  "name": "Semi",
  "version": "0.0.0"
}`;
export default function JsonViewerDemo() {
    const jsonviewerRef = useRef<JsonViewerHandle>(null);
    return (
        <div>
            <Button onClick={() => console.log(jsonviewerRef.current?.format())}>格式化</Button>
            <div style={{ marginBottom: 16, marginTop: 16 }}>
                <JsonViewer ref={jsonviewerRef} height={100} width={700} value={data} options={{ formatOptions: { tabSize: 4, insertSpaces: true, eol: '\n' } }} />
            </div>
        </div>
    );
}

Custom Render Rules

By configuring the options.customRenderRule parameter, you can customize how JSON content is rendered (Note: only works in read-only mode).

Behavior notes

path in customRenderRule is computed more accurately: the key token and the value token of the same key-value pair share the same path (they both map to the property path, e.g. root.<key>).

As a result, rules that only rely on path (such as path === 'root.<key>') may match both the key and the value, which can change which rule “wins” compared to previous versions.

If you want to match only the key or only the value, use the third argument tokenType of function match:

const targetPath = 'root.<key>';
// Key only
match: (_value, path, tokenType) => tokenType === 'key' && path === targetPath;
// Value only
match: (value, path, tokenType) => tokenType === 'value' && path === targetPath;

customRenderRule is an array of rules, where each rule contains two properties:

• match: Matching condition, can be one of three types:
  • String: Exact match
  • Regular expression: Match by regex
  • Function: Custom matching logic, with signature (value: string | number | boolean | null, path: string, tokenType: 'key' | 'value') => boolean
    • value: Value to match (JSON key or value). When match is a function, value will be passed as the parsed primitive when possible (number / boolean / null / string), so strict comparisons like === work; when match is a string or RegExp, matching is still based on textual content (string tokens are unquoted)
    • path: Current matching path, format is root.key1.key2.key3[0].key4
    • tokenType: Current token type, 'key' for JSON property name, 'value' for JSON value. Useful for distinguishing between key and value matching

• render: Custom render function, with signature (content: string) => React.ReactNode
  • content: Matched content. For string values, includes double quotes (e.g., "name", "Semi")
  • Returning null, undefined or false skips custom rendering and keeps the token text, so (content) => cond && <X /> works

import { JsonViewer, Rating, Popover, Tag, Image, type JsonViewerCustomRenderRule as CustomRenderRule } from '@fibrous/semi-ui-react';
const data = `{
  "name": "Semi",
  "version": "2.7.4",
  "rating": 5,
  "tags": ["design", "react", "ui"],
  "image": "/assets/root-web-sites/abstract.jpg"
}`;
export default function JsonViewerDemo() {
    const customRenderRule: CustomRenderRule[] = [
        {
            match: 'Semi',
            render: (content) => {
                return (
                    <Popover showArrow content="我是用户自定义的渲染" trigger="hover">
                        <span>{content}</span>
                    </Popover>
                );
            },
        },
        {
            match: (value) => value == 5,
            render: (content) => {
                return <Rating defaultValue={Number(content)} size={10} disabled />;
            },
        },
        {
            match: (_value, path) => path === 'root.tags[0]' || path === 'root.tags[1]' || path === 'root.tags[2]',
            render: (content) => {
                return (
                    <Tag size="small" shape="circle">
                        {content}
                    </Tag>
                );
            },
        },
        {
            match: new RegExp('^http'),
            render: (content) => {
                // content is the raw string token with its quotes; without them it is a valid URL
                return (
                    <Popover showArrow content={<Image width={100} height={100} src={content.replace(/^"|"$/g, '')} />} trigger="hover">
                        <span>{content}</span>
                    </Popover>
                );
            },
        },
    ];
    return (
        <div>
            <div style={{ marginBottom: 16, marginTop: 16 }}>
                <JsonViewer
                    height={200}
                    width={600}
                    value={data}
                    showSearch={false}
                    options={{
                        formatOptions: { tabSize: 4, insertSpaces: true, eol: '\n' },
                        customRenderRule,
                        readOnly: true,
                        autoWrap: true,
                    }}
                />
            </div>
        </div>
    );
}

Custom Search Button

Use the renderSearchButton property to customize the rendering of the search button, enabling fixed positioning, custom styles, and more.

import { IconSearch } from '@fibrous/semi-icons-react';
import { JsonViewer, Button } from '@fibrous/semi-ui-react';

const data = `{
    "name": "Semi",
    "version": "0.0.0"
}`;

export default function JsonViewerDemo() {
    return (
        <div style={{ marginBottom: 16 }}>
            <JsonViewer
                height={200}
                width={700}
                value={data}
                renderSearchButton={(defaultButton, controls) => (
                    <div style={{ position: 'absolute', top: 10, right: 10, zIndex: 10 }}>
                        {!controls.showSearchBar ? (
                            <Button icon={<IconSearch />} onClick={controls.onToggleSearchBar}>
                                搜索
                            </Button>
                        ) : (
                            defaultButton
                        )}
                    </div>
                )}
            />
        </div>
    );
}

API Reference

JsonViewer

Props

Methods

className, style and other native attributes (such as id and aria-label) fall on the root element. When the root has no role and aria-label or aria-labelledby is passed, the root gets role="group"; an explicit role wins.

JsonViewerOptions

CustomRenderRule

FormattingOptions

CompletionOptions

SearchControls

When using renderSearchButton, the second parameter searchControls contains the following properties:

Methods

Methods bound to the component instance can be called via ref to achieve certain special interactions.

Performance

Bundle Size

Time for rendering data of different magnitudes.

For details on the generation method of the test data, please refer to URL
When the data volume exceeds 500,000 lines, ReactMonacoEditor turns off highlighting and other behaviors by default, and the data comparison does not follow the principle of a single variable.