react-json-editor-ajrm - npm Package Compare versions

Comparing version 1.0.4 to 2.0.0

package.json

 {
   "name": "react-json-editor-ajrm",
-  "version": "1.0.4",
-  "description": "A stylish, modular, react component for viewing, editing, json and more!",
+  "version": "2.0.0",
+  "description": "A stylish, editor-like, modular, react component for viewing, editing, and debugging javascript object syntax!",
   "author": "[e-mail]",
@@ -30,19 +30,12 @@ "license": "ISC",
     "mitsuketajs.org",
-    "mitsuketa"
+    "mitsuketa",
+    "javascript object viewer",
+    "javascript object notation",
+    "json validator",
+    "javascript object syntax validator",
+    "json debug"
   ],
   "dependencies": {
-    "babel-plugin-transform-object-rest-spread": "^6.26.0",
-    "react": "^16.2.0",
-    "react-dom": "^16.2.0"
-  },
-  "devDependencies": {
-    "babel-core": "^6.26.0",
-    "babel-loader": "^7.1.2",
-    "babel-polyfill": "^6.26.0",
-    "babel-preset-env": "^1.6.1",
-    "babel-preset-react": "^6.24.1",
-    "webpack": "^3.10.0",
-    "webpack-dev-server": "^2.9.7",
-    "webpack-merge": "^4.1.1"
+    "react": "^16.2.0"
   }
 }

readme.md

 # react-json-editor-ajrm
 
-<p align="center"><img src=http://i.imgur.com/rDgFRtY.gif><br /><br />A stylish, modular, react component for viewing, editing, json and more!</p>
+<p align="center"><img src=https://i.imgur.com/ewtebIW.gif><br /><br />A stylish, editor-like, modular, react component for viewing, editing, and debugging javascript object syntax!</p>
 
-Using npm:
+## Installing Dependency
 
+* Using node package manager:
+
 ```
-$ npm i -g npm
-$ npm i --save react-json-editor-ajrm
+   $ npm i --save react-json-editor-ajrm
 ```
@@ -15,3 +16,3 @@
 ```
-    import JSONInput from './src/components/jsoninput';
+    import JSONInput from 'react-json-editor-ajrm';
 
@@ -24,15 +25,29 @@ <JSONInput
 ```
-[**See full working example**](https://github.com/AndrewRedican/react-json-editor-ajrm/tree/master/src/index.js)
 
-## Latest Release Notes
-1. Fixed: Component now re-renders when `placeholder` property is updated.
-2. Now accepts `border` property for any color theme to specify the color of the border separating the status bar and the code viewer.
+## Live Demo ? Test it right away!
 
-## Set Up
-If you'd like to interact with it right away. Follow these instructions.
-1. Clone github repository
-2. Run the following on the command line tool in the local directory of the repo to install dev dependencies: `npm i`
-3. Run the following on the command line tool in the local directory of the repo to launch: `npm start`
-4. Open browser and set web address to: `localhost:8080`
+1. Clone or fork this Github repository
+2. Go to [footFolder/example/](https://github.com/AndrewRedican/react-json-editor-ajrm/tree/master/example):
+```
+    $ cd path/to/repo/example
+```
+3. Install example project dependencies:
+```
+    $ npm i
+```
+4. Serve sample website to port 8080:
+```
+   $ npm start
+```
+5. Open `http://localhost:8080` in the web browser
 
+
+## Latest Release Notes - May 8, 2018
+1. Enhanced validations and information.
+2. Previous issue where the content format changed to due errors in syntax, has been fixed.
+3. Includes additional properties to further customize component.
+4. Version 2.0.0, contains a do-over of logic core mechanics. It is advised to update this dependency as soon as possible.
+5. Component now contains some subtle transitions effects based on the syntax's status.
+6. New light theme included in example files. Enjoy!
+
 ## Features
@@ -46,6 +61,17 @@
 
+## Component Properties
+
+| Name   | Description | Type   | Required |
+| ------ |-------------| :-----:| :-----:  |
+| [id]()          | A unique id to identify component.                                                     | string  | Mandatory |
+| [colors]()      | Contains the following properties to customize the color palette used: ``              | object  | Optional  |
+| [confirmGood]() | Send `false` if you would like for the checkmark to confirm good syntax to be hidden.  | boolean | Optional  |
+| [height]()      | Set a specific height for the entire component                                         | string  | Optional  |
+| [viewOnly]()    | Send `true` if you would like for content shown not to be editable.                    | boolean | Optional  |
+| [placeholder]() | Send a valid javascript object to be shown once when component is mounted              | object  | Optional  |
+| [onChange]()    | Whenever `onBlur` event takes place it will return content values                      | object  | Optional  |
+
 ## Built With
 
 * [**React.js**](https://reactjs.org/) and Vanilla Javascript [**Javascript**](https://betterexplained.com/articles/the-single-page-javascript-overview/), ES5, [**ES6**](http://es6-features.org/#Constants)
-* Also requires: ``` "babel-plugin-transform-object-rest-spread": "^6.26.0" ```
 
@@ -58,2 +84,2 @@ ## Authors
 
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Dependency count

1

decreased by-66.67%

Dev dependency count

0

decreased by-100%

Number of package files

13

increased by8.33%

Number of lines in readme file

81

increased by44.64%

Worsened metrics

Total package byte prevSize

85030

decreased by-8.56%

Lines of code

1697

decreased by-11.06%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removedbabel-plugin-transform-object-rest-spread@^6.26.0

• - Removedreact-dom@^16.2.0

• - Removedbabel-plugin-syntax-object-rest-spread@6.13.0(transitive)

• - Removedbabel-plugin-transform-object-rest-spread@6.26.0(transitive)

• - Removedbabel-runtime@6.26.0(transitive)

• - Removedcore-js@2.6.12(transitive)

• - Removedreact-dom@16.14.0(transitive)

• - Removedregenerator-runtime@0.11.1(transitive)

• - Removedscheduler@0.19.1(transitive)