Skip to content

Commit 1cc6dad

Browse files
committed
README update.
1 parent 9d835d2 commit 1cc6dad

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# jsondiffpatch-for-react
2-
Based on https://github.com/benjamine/jsondiffpatch
3-
42

3+
- Originally forked from archived https://github.com/hero-guo/jsondiffpatch-for-react
4+
- Based on https://github.com/benjamine/jsondiffpatch
55

66
# 1. install
77

@@ -25,33 +25,33 @@ import JsonDiffReact from 'jsondiffpatch-for-react';
2525

2626
# 3. component props
2727

28-
* `left` (array, object, string)
28+
- `left` (array, object, string)
2929

30-
* `right` (array, object, string)
30+
- `right` (array, object, string)
3131

32-
* `show` (bool)
32+
- `show` (bool)
3333

34-
you can show/hide unchanged values
34+
you can show/hide unchanged values
3535

36-
* `annotated` (bool)
36+
- `annotated` (bool)
3737

38-
This will render the original JSON delta in html, with annotations aside explaining the meaning of each part. This attempts to make the JSON delta format self-explained.
38+
This will render the original JSON delta in html, with annotations aside explaining the meaning of each part. This attempts to make the JSON delta format self-explained.
3939

40-
* `tips` (string)
40+
- `tips` (string)
4141

4242
Message that will displayed in case both elements are identical.
4343

44-
* `objectHash` (function)
44+
- `objectHash` (function)
4545

46-
Will be passed to *jsondiffpatch* to improve array comparison performance, as described [here](https://github.com/benjamine/jsondiffpatch/blob/master/docs/arrays.md#an-example-using-objecthash).
46+
Will be passed to _jsondiffpatch_ to improve array comparison performance, as described [here](https://github.com/benjamine/jsondiffpatch/blob/master/docs/arrays.md#an-example-using-objecthash).
4747
Example:
4848

4949
```jsx
5050
<JsonDiffReact
5151
left={left}
5252
right={right}
53-
objectHash={(obj: any) => obj.id || obj._id || obj.name || JSON.stringify(obj)}
53+
objectHash={(obj: any) =>
54+
obj.id || obj._id || obj.name || JSON.stringify(obj)
55+
}
5456
/>
5557
```
56-
57-

0 commit comments

Comments
 (0)