|
1 | | -# json-viewer |
| 1 | +# @textea/json-viewer |
| 2 | + |
| 3 | +`@textea/json-viewer` is a React component for displaying and editing JavaScript/TypeScript **arrays** and **JSON |
| 4 | +objects**. |
| 5 | + |
| 6 | +This component provides a responsive interface for displaying arrays or JSON in a web browser. |
| 7 | + |
| 8 | +## Usage |
| 9 | + |
| 10 | +```shell |
| 11 | +# npm |
| 12 | +npm install @textea/json-viewer |
| 13 | +# yarn |
| 14 | +yarn add @textea/json-viewer |
| 15 | +# pnpm |
| 16 | +pnpm add @textea/json-viewer |
| 17 | +``` |
| 18 | + |
| 19 | +```tsx |
| 20 | +import ReactJson from '@textea/json-viewer' |
| 21 | + |
| 22 | +const json = { /* my json object */ } |
| 23 | +const Component = () => (<ReactJson src={json}/>) |
| 24 | +``` |
| 25 | + |
| 26 | +## Props |
| 27 | + |
| 28 | +| Name | Type | Default | Description | |
| 29 | +|:-----------------------------|:--------------------------|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 30 | +| `src` | `JSON Object` | None | This property contains your input JSON | |
| 31 | +| `name` | `string` or `false` | "root" | Contains the name of your root node. Use `null` or `false` for no name. | |
| 32 | +| `theme` | `string` | "rjv-default" | RJV supports base-16 themes. Check out the list of supported themes [in the demo](https://mac-s-g.github.io/react-json-view/demo/dist/). A custom "rjv-default" theme applies by default. | |
| 33 | +| `style` | `object` | `{}` | Style attributes for react-json-view container. Explicit style attributes will override attributes provided by a theme. | |
| 34 | +| `iconStyle` | `string` | "circle" | Style of expand/collapse icons. Accepted values are "circle", triangle" or "square". | |
| 35 | +| `indentWidth` | `integer` | 4 | Set the indent-width for nested objects | |
| 36 | +| `collapsed` | `boolean` or `integer` | `false` | When set to `true`, all nodes will be collapsed by default. Use an integer value to collapse at a particular depth. | |
| 37 | +| `collapseStringsAfterLength` | `integer` | `false` | When an integer value is assigned, strings will be cut off at that length. Collapsed strings are followed by an ellipsis. String content can be expanded and collapsed by clicking on the string value. | |
| 38 | +| `shouldCollapse` | `(field)=>{}` | `false` | Callback function to provide control over what objects and arrays should be collapsed by default. An object is passed to the callback containing `name`, `src`, `type` ("array" or "object") and `namespace`. | |
| 39 | +| `groupArraysAfterLength` | `integer` | `100` | When an integer value is assigned, arrays will be displayed in groups by count of the value. Groups are displayed with bracket notation and can be expanded and collapsed by clicking on the brackets. | |
| 40 | +| `enableClipboard` | `boolean` or `(copy)=>{}` | `true` | When prop is not `false`, the user can copy objects and arrays to clipboard by clicking on the clipboard icon. Copy callbacks are supported. | |
| 41 | +| `displayObjectSize` | `boolean` | `true` | When set to `true`, objects and arrays are labeled with size | |
| 42 | +| `displayDataTypes` | `boolean` | `true` | When set to `true`, data type labels prefix values | |
| 43 | +| `onEdit` | `(edit)=>{}` | `false` | When a callback function is passed in, `edit` functionality is enabled. The callback is invoked before edits are completed. Returning `false` from `onEdit` will prevent the change from being made. [see: onEdit docs](#onedit-onadd-and-ondelete-interaction) | |
| 44 | +| `onAdd` | `(add)=>{}` | `false` | When a callback function is passed in, `add` functionality is enabled. The callback is invoked before additions are completed. Returning `false` from `onAdd` will prevent the change from being made. [see: onAdd docs](#onedit-onadd-and-ondelete-interaction) | |
| 45 | +| `defaultValue` | `string \ | number \ | boolean \ |array \|object`|`null`|Sets the default value to be used when adding an item to json |
| 46 | +| `onDelete` | `(delete)=>{}` | `false` | When a callback function is passed in, `delete` functionality is enabled. The callback is invoked before deletions are completed. Returning `false` from `onDelete` will prevent the change from being made. [see: onDelete docs](#onedit-onadd-and-ondelete-interaction) | |
| 47 | +| `onSelect` | `(select)=>{}` | `false` | When a function is passed in, clicking a value triggers the `onSelect` method to be called. | |
| 48 | +| `sortKeys` | `boolean` | `false` | set to true to sort object keys | |
| 49 | +| `quotesOnKeys` | `boolean` | `true` | set to false to remove quotes from keys (eg. `"name":` vs. `name:`) | |
| 50 | +| `validationMessage` | `string` | "Validation Error" | Custom message for validation failures to `onEdit`, `onAdd`, or `onDelete` callbacks | |
| 51 | +| `displayArrayKey` | `boolean` | `true` | When set to `true`, the index of the elements prefix values | |
| 52 | + |
| 53 | +## Features |
| 54 | + |
| 55 | +- [X] Support `Next.js` SSR |
| 56 | +- [X] `onEdit`, `onAdd` and `onDelete` props allow users to edit the `src` variable |
| 57 | +- [X] Object, array, string and function values can be collapsed and expanded |
| 58 | +- [X] Object and array nodes display length |
| 59 | +- [X] Object and array nodes support a "Copy to Clipboard" feature |
| 60 | +- [X] String values can be truncated after a specified length |
| 61 | +- [X] Arrays can be subgrouped after a specified length |
| 62 | +- [X] When `onEdit` is enabled: |
| 63 | + * `Ctrl/Cmd+Click` Edit Mode |
| 64 | + * `Ctrl/Cmd+Enter` Submit |
| 65 | + |
| 66 | +## LICENSE |
| 67 | + |
| 68 | +This project is licensed under the terms of the [MIT license](LICENSE). |
0 commit comments