Plus · JsonViewer
JsonViewer
Used for displaying and editing JSON data
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 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
JsonViewer supported from v2.71.0
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.Differrent lineHeight
Configure the
lineHeight parameter of options to set a fixed line height (unit: px, default 18).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.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，
API Reference
JsonViewer
| Attribute | Description | Type | Default |
|---|---|---|---|
| value | Display content | string | - |
| height | Height of wrapper DOM | number | - |
| width | Width of wrapper DOM | number | - |
| className | className of wrapper DOM | string | - |
| style | InlineStyle of wrapper DOM | object | - |
| showSearch | Whether to show search icon | boolean | true |
| options | Formatting configuration | JsonViewerOptions | - |
| onChange | Callback for content change | (value: string) => void | - |
JsonViewerOptions
| Attribute | Description | Type | Default |
|---|---|---|---|
| lineHeight | Height of each line of content, unit:px | number | 20 |
| autoWrap | Whether to wrap lines automatically. | boolean | true |
| readOnly | Whether to be read-only. | boolean | false |
| formatOptions | Content format setting | FormattingOptions | - |
FormattingOptions
| Attribute | Description | Type | Default |
|---|---|---|---|
| tabSize | Indent size. Unit: px | number | 4 |
| insertSpaces | Whether to use spaces for indentation | boolean | true |
| eol | Line break character | string | '\n' |
Methods
Methods bound to the component instance can be called via
ref to achieve certain special interactions.| Method | Description |
|---|---|
| getValue() | Get current value |
| format() | Format current content |
Performance
Bundle Size
| Libs Name | Size | Size (Gzip) |
|---|---|---|
| JsonViewer | 203.14kb | 51.23kb |
| MonacoEditor | 5102.0 KB | 1322.7 KB |
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.
| Libs Name | 1k lines | 5k lines | 10 thousand lines | 100 thousand lines | 500 thousand lines | 1 million lines | 3 million lines |
|---|---|---|---|---|---|---|---|
| JsonViewer | 30.42ms | 30.66ms | 36.87ms | 52.73ms | 111.02ms | 178.81ms | 506.25ms |
| ReactMonacoEditor | 72.01ms | 73.76ms | 76.64ms | 97.89ms | 133.31ms | 202.79ms | 495.53ms |
| Performance improvement | 57.70% | 58.41% | 51.87% | 46.11% | - | - | - |