Skip to content

Commit 84ddfd2

Browse files
committed
docs
1 parent 75c276d commit 84ddfd2

2 files changed

Lines changed: 55 additions & 1 deletion

File tree

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,60 @@ viewer.right = { name: "bar" };
5454
viewer.setData(leftObj, rightObj);
5555
```
5656

57+
<details>
58+
<summary>Framework Examples</summary>
59+
60+
### React
61+
62+
```jsx
63+
import { useEffect, useRef } from "react";
64+
import "json-diff-viewer-component";
65+
66+
function DiffViewer({ left, right }) {
67+
const viewerRef = useRef(null);
68+
69+
useEffect(() => {
70+
if (viewerRef.current) {
71+
viewerRef.current.setData(left, right);
72+
}
73+
}, [left, right]);
74+
75+
return <json-diff-viewer ref={viewerRef} />;
76+
}
77+
```
78+
79+
### Vue
80+
81+
```vue
82+
<template>
83+
<json-diff-viewer ref="viewerRef" />
84+
</template>
85+
86+
<script setup>
87+
import { ref, watch } from "vue";
88+
import "json-diff-viewer-component";
89+
90+
const props = defineProps({
91+
left: Object,
92+
right: Object,
93+
});
94+
95+
const viewerRef = ref(null);
96+
97+
watch(
98+
() => [props.left, props.right],
99+
() => {
100+
if (viewerRef.value) {
101+
viewerRef.value.setData(props.left, props.right);
102+
}
103+
},
104+
{ immediate: true }
105+
);
106+
</script>
107+
```
108+
109+
</details>
110+
57111
## Diff Types
58112

59113
| Type | Color | Description |

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "json-diff-viewer-component",
3-
"version": "1.0.0",
3+
"version": "0.1.0",
44
"type": "module",
55
"description": "Vanilla JS web component for side-by-side JSON diff visualization",
66
"keywords": [

0 commit comments

Comments
 (0)