diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..0f2eb81
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,20 @@
+# https://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 80
+indent_brace_style = 1TBS
+spaces_around_operators = true
+quote_type = auto
+
+[package.json]
+indent_style = space
+indent_size = 2
+a
\ No newline at end of file
diff --git a/.eslintrc.json b/.eslintrc.json
deleted file mode 100644
index e1d47ae..0000000
--- a/.eslintrc.json
+++ /dev/null
@@ -1,20 +0,0 @@
-{
- "plugins": ["react", "prettier"],
- "rules": {
- "prettier/prettier": "error",
- "import/no-anonymous-default-export": "off",
- "egegeg": "off"
- },
- "parser":"@babel/eslint-parser",
- "parserOptions": {
- "sourceType": "module",
- "ecmaVersion": 6,
- "ecmaFeatures": {
- "experimentalObjectRestSpread": true
- }
- },
- "env": {
- "es6": true,
- "node": true
- }
-}
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 97c1765..ce472aa 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -1,24 +1,24 @@
name: test
on:
- push:
- branches:
- - master
- pull_request:
- branches:
- - master
+ push:
+ branches:
+ - master
+ pull_request:
+ branches:
+ - master
jobs:
- test:
- runs-on: ubuntu-latest
- steps:
- - name: Checkout
- uses: actions/checkout@v2
- - name: Setup Node.js
- uses: actions/setup-node@v4
- with:
- node-version: lts/*
- - name: Install
- run: npm install --no-package-lock --force
- - name: Test
- run: npm test
+ test:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+ - name: Setup Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: lts/*
+ - name: Install
+ run: npm install --no-package-lock --force
+ - name: Test
+ run: npm test
diff --git a/.prettierrc.json b/.prettierrc.json
deleted file mode 100644
index cdccb6c..0000000
--- a/.prettierrc.json
+++ /dev/null
@@ -1,15 +0,0 @@
-{
- "tabWidth": 4,
- "printWidth": 80,
- "singleQuote": true,
- "trailingComma": "none",
- "bracketSpacing": true,
- "jsxBracketSameLine": false,
- "parser": "babel",
- "semi": true,
- "requirePragma": false,
- "proseWrap": "preserve",
- "arrowParens": "avoid",
- "eslintIntegration": false,
- "endOfLine": "auto"
-}
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 14205ca..158047d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,27 +11,28 @@ All notable changes to this project will be documented in this file. See [standa
### [1.23.2](https://github.com/microlinkhq/react-json-view/compare/v1.23.1...v1.23.2) (2024-09-22)
+- function call ([86bbd60](https://github.com/microlinkhq/react-json-view/commit/86bbd60caef8d80b812a45c8ea9326df62fcb02f))
+
+### [1.23.2](https://github.com/microlinkhq/react-json-view/compare/v1.23.1...v1.23.2) (2024-09-22)
### Bug Fixes
-* add legacy ssl flag ([4005834](https://github.com/microlinkhq/react-json-view/commit/4005834bb4234ddfdef66f2173a53a686641cb21))
+- add legacy ssl flag ([4005834](https://github.com/microlinkhq/react-json-view/commit/4005834bb4234ddfdef66f2173a53a686641cb21))
### [1.23.1](https://github.com/microlinkhq/react-json-view/compare/v1.23.0...v1.23.1) (2024-07-02)
## [1.23.0](https://github.com/microlinkhq/react-json-view/compare/v1.22.2...v1.23.0) (2023-10-26)
-
### Features
-* **dev server:** add example of name as jsx element ([84ada17](https://github.com/microlinkhq/react-json-view/commit/84ada17617ad1df0e748e5cf6383f9cdcefa6e02))
-* **json viewer:** add handling namespace when is an react object ([e11b60a](https://github.com/microlinkhq/react-json-view/commit/e11b60af87fa1755554cb5c846d1d49ea12d131e))
-* **types:** add JSX.Element as name prop type ([ebd8aed](https://github.com/microlinkhq/react-json-view/commit/ebd8aed8246742ebc41776a8a0bb489b8e711138))
-
+- **dev server:** add example of name as jsx element ([84ada17](https://github.com/microlinkhq/react-json-view/commit/84ada17617ad1df0e748e5cf6383f9cdcefa6e02))
+- **json viewer:** add handling namespace when is an react object ([e11b60a](https://github.com/microlinkhq/react-json-view/commit/e11b60af87fa1755554cb5c846d1d49ea12d131e))
+- **types:** add JSX.Element as name prop type ([ebd8aed](https://github.com/microlinkhq/react-json-view/commit/ebd8aed8246742ebc41776a8a0bb489b8e711138))
### Bug Fixes
-* add missed devDeps in new create-react-app ([5275cd4](https://github.com/microlinkhq/react-json-view/commit/5275cd446f7d4202b06f4a0d048092066a6b5f5b))
-* **json viewer:** add support for functional components ([f478f55](https://github.com/microlinkhq/react-json-view/commit/f478f55aa2b9dbe730f9638485d9c584ccbbcc45))
+- add missed devDeps in new create-react-app ([5275cd4](https://github.com/microlinkhq/react-json-view/commit/5275cd446f7d4202b06f4a0d048092066a6b5f5b))
+- **json viewer:** add support for functional components ([f478f55](https://github.com/microlinkhq/react-json-view/commit/f478f55aa2b9dbe730f9638485d9c584ccbbcc45))
### [1.22.2](https://github.com/microlinkhq/react-json-view/compare/v1.22.1...v1.22.2) (2022-06-27)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e2e9b6b..74f71a9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,7 +8,8 @@ npm install --save-dev
# run the dev server with hot reloading
npm run dev
```
-Webpack Dev Server should automatically open up http://localhost:2000 in your web browser. If it does not, open a browser and navigate to port 2000. The hot reloader will automatically reload when files are modified in the `/src/` directory.
+
+Webpack Dev Server should automatically open up http://localhost:2000 in your web browser. If it does not, open a browser and navigate to port 2000. The hot reloader will automatically reload when files are modified in the `/src/` directory.
## Run the Production Build
@@ -16,6 +17,7 @@ Webpack Dev Server should automatically open up http://localhost:2000 in your we
# run the build (note: you may need to use `sudo` priveledges to run the build successfully)
npm run build
```
+
Please add tests for your code before posting a pull request.
You can run the test suite with `npm run test` or `npm run test:watch` to automatically reload when files are modified.
@@ -24,4 +26,4 @@ You can run the test suite with `npm run test` or `npm run test:watch` to automa
I recommend using docker for development because it enforces environmental consistency.
-For information about contributing with Docker, see the [README in ./docker](https://github.com/microlinkhq/react-json-view/blob/master/docker/README.md#contributing-to-this-project-using-docker).
\ No newline at end of file
+For information about contributing with Docker, see the [README in ./docker](https://github.com/microlinkhq/react-json-view/blob/master/docker/README.md#contributing-to-this-project-using-docker).
diff --git a/README.md b/README.md
index eb90bb0..fbd3a69 100644
--- a/README.md
+++ b/README.md
@@ -1,106 +1,93 @@
-![alt text](https://raw.githubusercontent.com/microlinkhq/react-json-view/master/doc/rjv-icon-alt.png)
-
-[![npm](https://img.shields.io/npm/v/%40microlink%2Freact-json-view.svg)](https://www.npmjs.com/package/@microlink/react-json-view) [![npm](https://img.shields.io/npm/l/%40microlink%2Freact-json-view.svg
-)](https://github.com/microlinkhq/react-json-view/blob/master/LICENSE) [![Build Status](https://github.com/microlinkhq/react-json-view/workflows/test/badge.svg)](https://github.com/microlinkhq/react-json-view/actions/workflows/main.yml?query=branch%3Amaster)
-
-# react-json-view
-RJV is a React component for displaying and editing javascript **arrays** and **JSON objects**.
-
-This component provides a responsive interface for displaying arrays or JSON in a web browser. NPM offers a distribution of the source that's transpiled to ES5; so you can include this component with *any web-based javascript application*.
-
-[Check out the Interactive Demo](https://react-json-view.microlink.io/)
-
-
-### Implementation Example
-```js
-// import the react-json-view component
-import ReactJson from '@microlink/react-json-view'
-
-// use the component in your app!
-
-```
-
-### Output Examples
-#### Default Theme
-![alt text](https://raw.githubusercontent.com/microlinkhq/react-json-view/master/doc/output-example-15.png "Output Example 1")
-#### Hopscotch Theme, with Triangle Icons:
-![alt text](https://raw.githubusercontent.com/microlinkhq/react-json-view/master/doc/output-example-14.png "Output Example 2")
-
-### Installation Instructions
-Install this component with [NPM](https://www.npmjs.com/package/@microlink/react-json-view).
-```shell
-npm install --save @microlink/react-json-view
-```
-Or add to your package.json config file:
-```json
-"dependencies": {
- "@microlink/react-json-view": "latest"
-}
-```
-
-### Props
-
-| Name | Type | Default | Description |
-|:-------------------------------|:-------------------------------------------|:--------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `src` | `JSON Object` | None | This property contains your input JSON. |
-| `name` | `string` | `JSX.Element` or `false` | "root" - Contains the name of your root node. Use `null` or `false` for no name. |
-| `theme` | `string` | "rjv-default" | RJV supports base-16 themes. Check out the list of supported themes [in the demo](https://react-json-view.microlink.io/). A custom "rjv-default" theme applies by default. |
-| `style` | `object` | `{}` | Style attributes for react-json-view container. Explicit style attributes will override attributes provided by a theme. |
-| `iconStyle` | `string` | "circle" | Style of expand/collapse icons. Accepted values are "circle", "triangle" or "square". |
-| `indentWidth` | `integer` | 4 | Set the indent-width for nested objects. |
-| `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. |
-| `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. |
-| `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`. |
-| `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. |
-| `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. |
-| `displayObjectSize` | `boolean` | `true` | When set to `true`, objects and arrays are labeled with size. |
-| `displayDataTypes` | `boolean` | `true` | When set to `true`, data type labels prefix values. |
-| `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) |
-| `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) |
-| `defaultValue` | `string \| number \| boolean \| array \| object` | `null` | Sets the default value to be used when adding an item to JSON. |
-| `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) |
-| `onSelect` | `(select)=>{}` | `false` | When a function is passed in, clicking a value triggers the `onSelect` method to be called. |
-| `sortKeys` | `boolean` | `false` | Set to `true` to sort object keys. |
-| `quotesOnKeys` | `boolean` | `true` | Set to `false` to remove quotes from keys (e.g., `"name":` vs. `name:`). |
-| `validationMessage` | `string` | "Validation Error" | Custom message for validation failures to `onEdit`, `onAdd`, or `onDelete` callbacks. |
-| `displayArrayKey` | `boolean` | `true` | When set to `true`, the index of the elements prefix values. |
-
-
-### Features
-* `onEdit`, `onAdd` and `onDelete` props allow users to edit the `src` variable
-* Object, array, string and function values can be collapsed and expanded
-* Object and array nodes display length
-* Object and array nodes support a "Copy to Clipboard" feature
-* String values can be truncated after a specified length
-* Arrays can be subgrouped after a specified length
-* Base-16 Theme Support
+
+
+
+ react-json-view
+
+
+
+
+
+
+
+**react-json-view** (rjv) is a React component for displaying and editing javascript **arrays** and **JSON objects**.
+
+
+
+
+
+
+### Highlights
+
+* `onEdit`, `onAdd` and `onDelete` props allow users to edit the `src` variable.
+* Object, array, string and function values can be collapsed and expanded.
+* Object and array nodes display length.
+* Object and array nodes support a "Copy to Clipboard" feature.
+* String values can be truncated after a specified length.
+* Arrays can be subgrouped after a specified length.
+* Base-16 Theme Support.
* When `onEdit` is enabled:
* `Ctrl/Cmd+Click` Edit Mode
* `Ctrl/Cmd+Enter` Submit
-### Customizing Style
-#### Stock Themes
-RJV now supports base-16 themes!
+### Installation
-You can specify a `theme` name or object when you instantiate your rjv component.
-```jsx
-
+```shell
+npm install @microlink/react-json-view --save
```
-Check out the list of supported themes [in the component demo](https://react-json-view.microlink.io/).
-
-#### Monokai theme example
-![alt text](https://raw.githubusercontent.com/microlinkhq/react-json-view/master/doc/output-example-monokai-2.png "Base-16 Theme Example")
-
-#### Solarized theme example
-![alt text](https://raw.githubusercontent.com/microlinkhq/react-json-view/master/doc/output-example-solarized-2.png "Base-16 Theme Example")
-#### Use Your Own Theme
-You can supply your own base-16 theme object.
+### Usage
-To better understand custom themes, take a look at [my example implementation](https://github.com/microlinkhq/react-json-view/blob/7c154b9a7d83ea89dce2c171ebdf4d163ff49233/dev-server/src/index.js#L135) and the [base-16 theme styling guidelines](https://github.com/chriskempson/base16/blob/master/styling.md).
+```js
+import ReactJsonView from '@microlink/react-json-view'
+
+
+```
-### onEdit, onAdd and onDelete Interaction
-Pass callback methods to `onEdit`, `onAdd` and `onDelete` props. Your method will be invoked when a user attempts to update your `src` object.
+### API
+
+| Name | Type | Default | Description |
+|:-----------------------------|:-------------------------------------------------|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `src` | `JSON Object` | None | This property contains your input JSON. |
+| `name` | `string` | `JSX.Element` or `false` | "root" - Contains the name of your root node. Use `null` or `false` for no name. |
+| `theme` | `string` | `'rjv-default'` | RJV supports base-16 themes. Check out the list of supported themes [in the demo](https://react-json-view.microlink.io/). A custom "rjv-default" theme applies by default. |
+| `style` | `object` | `{}` | Style attributes for react-json-view container. Explicit style attributes will override attributes provided by a theme. |
+| `iconStyle` | `string` | `'circle'` | Style of expand/collapse icons. Accepted values are "circle", "triangle" or "square". |
+| `indentWidth` | `integer` | 4 | Set the indent-width for nested objects. |
+| `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. |
+| `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. |
+| `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`. |
+| `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. |
+| `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. |
+| `displayObjectSize` | `boolean` | `true` | When set to `true`, objects and arrays are labeled with size. |
+| `displayDataTypes` | `boolean` | `true` | When set to `true`, data type labels prefix values. |
+| `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) |
+| `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) |
+| `defaultValue` | `string \| number \| boolean \| array \| object` | `null` | Sets the default value to be used when adding an item to JSON. |
+| `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) |
+| `onSelect` | `(select)=>{}` | `false` | When a function is passed in, clicking a value triggers the `onSelect` method to be called. |
+| `sortKeys` | `boolean` | `false` | Set to `true` to sort object keys. |
+| `quotesOnKeys` | `boolean` | `true` | Set to `false` to remove quotes from keys (e.g., `"name":` vs. `name:`). |
+| `validationMessage` | `string` | "Validation Error" | Custom message for validation failures to `onEdit`, `onAdd`, or `onDelete` callbacks. |
+| `displayArrayKey` | `boolean` | `true` | When set to `true`, the index of the elements prefix values. |
+
+#### Callbacks
+
+You can pass callback methods to `onEdit`, `onAdd` and `onDelete` props.
+
+Your method will be invoked when a user attempts to update your `src` object.
The following object will be passed to your method:
```js
@@ -113,4 +100,22 @@ The following object will be passed to your method:
}
```
-Returning `false` from a callback method will prevent the src from being affected.
\ No newline at end of file
+Returning `false` from a callback method will prevent the src from being affected.
+
+### Theming
+
+#### Builtin theme
+
+You can specify a `theme` name or object when you instantiate your rjv component.
+
+```jsx
+
+```
+
+Check out the list of supported themes [in the component demo](https://react-json-view.microlink.io/).
+
+#### Custom theme
+
+**rjv** supports any base-16 theme. You can supply your own base-16 theme object.
+
+To better understand custom themes, take a look at [my example implementation](https://github.com/microlinkhq/react-json-view/blob/7c154b9a7d83ea89dce2c171ebdf4d163ff49233/dev-server/src/index.js#L135) and the [base-16 theme styling guidelines](https://github.com/chriskempson/base16/blob/master/styling.md).
diff --git a/demo/dist/index.html b/demo/dist/index.html
index 5a21a00..8cb97d9 100644
--- a/demo/dist/index.html
+++ b/demo/dist/index.html
@@ -2,28 +2,49 @@
RJV Demo
-
-
-
-
+
+
+
+
-
-
+
+
-
-