Skip to content

Commit 63b168c

Browse files
authored
Update README.md
1 parent 46d551d commit 63b168c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This component provides a responsive interface for displaying arrays or JSON in
1010
* Check out an [interactive demo here](https://mac-s-g.github.io/react-json-view/example/example.html).
1111
* Check out a [React implementation example here](https://github.com/mac-s-g/react-json-view/blob/master/example/example.js).
1212
* Check out an [ES5 implementation example here](https://github.com/mac-s-g/react-json-view/blob/master/example/example.html).
13-
* [Installation instructions](#intallation-instructions) are listed below.
13+
* [Installation instructions](#installation-instructions) are listed below.
1414

1515
### Implementation Example:
1616
```
@@ -26,7 +26,7 @@ import ReactJson from 'react-json-view'
2626

2727
[See More Examples](https://mac-s-g.github.io/react-json-view/example/example.html)
2828

29-
### Intallation Instructions
29+
### Installation Instructions
3030
Install this package with npm:
3131
```
3232
npm install --save react-json-view
@@ -49,7 +49,7 @@ Name|Type|Default|Description
4949
`enableClipboard`|`boolean`|`true`|When set to `true`, the user can copy objects and arrays to clipboard
5050
`displayObjectSize`|`boolean`|`true`|When set to `true`, objects and arrays are labeled with size
5151
`displayDataTypes`|`boolean`|`true`|When set to `true`, data type labels prefix values
52-
`onEdit`|`(edit) => {}`|`false`|When a callback function is passed in, value edits are enabled. The callback is invoked when edits are made.
52+
`onEdit`|`(edit) => {}`|`false`|When a callback function is passed in, value edits are enabled. The callback is invoked when edits are made. [see: onEdit docs](#onedit-interaction)
5353

5454
### Features
5555
* Object and array nodes can be collapsed and expanded
@@ -75,12 +75,15 @@ Check out the [list of supported themes here](https://github.com/gaearon/base16-
7575

7676
### onEdit Interaction
7777
Click the pencil icon to initialize an edit
78+
7879
![alt text](https://github.com/mac-s-g/react-json-view/blob/master/doc/edit-init.png?raw=true "initialize an edit")
7980

8081
Input a new value. RJV will attempt to recognize integer and float inputs.
82+
8183
![alt text](https://github.com/mac-s-g/react-json-view/blob/master/doc/edit-input.png?raw=true "input variable value")
8284

8385
Submitting a new value calls your `onEdit` callback method
86+
8487
![alt text](https://github.com/mac-s-g/react-json-view/blob/master/doc/edit-complete.png?raw=true "edit submitted")
8588

8689
The `onEdit` is passed an `edit` variable. The edit variable will have the following contents:

0 commit comments

Comments
 (0)