Skip to content

Commit 089d5bd

Browse files
committed
rc3
1 parent aa37327 commit 089d5bd

File tree

3 files changed

+25
-18
lines changed

3 files changed

+25
-18
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# json-diff-viewer
22

3-
Vanilla JS web component for side-by-side JSON diff visualization.
3+
**Compare JSON side-by-side, visually**
4+
5+
A zero-dependency web component for visualizing JSON differences with synchronized scrolling, collapsible nodes, and syntax highlighting. Perfect for debugging, API comparisons, and configuration diffs
46

57
## Features
68

@@ -24,41 +26,41 @@ npm i json-diff-viewer-component
2426
### ES Module
2527

2628
```js
27-
import 'json-diff-viewer-component'
29+
import "json-diff-viewer-component";
2830

29-
const viewer = document.querySelector('json-diff-viewer')
30-
viewer.setData(leftObj, rightObj)
31+
const viewer = document.querySelector("json-diff-viewer");
32+
viewer.setData(leftObj, rightObj);
3133
```
3234

3335
### HTML Attributes
3436

3537
```html
36-
<json-diff-viewer
37-
left='{"name":"foo"}'
38+
<json-diff-viewer
39+
left='{"name":"foo"}'
3840
right='{"name":"bar"}'
3941
></json-diff-viewer>
4042
```
4143

4244
### Properties
4345

4446
```js
45-
viewer.left = { name: 'foo' }
46-
viewer.right = { name: 'bar' }
47+
viewer.left = { name: "foo" };
48+
viewer.right = { name: "bar" };
4749
```
4850

4951
### Method
5052

5153
```js
52-
viewer.setData(leftObj, rightObj)
54+
viewer.setData(leftObj, rightObj);
5355
```
5456

5557
## Diff Types
5658

57-
| Type | Color | Description |
58-
|------|-------|-------------|
59-
| Added | Green | Key exists only in right |
60-
| Removed | Red | Key exists only in left |
61-
| Modified | Yellow | Value changed |
59+
| Type | Color | Description |
60+
| ------------ | ------ | ------------------------------------ |
61+
| Added | Green | Key exists only in right |
62+
| Removed | Red | Key exists only in left |
63+
| Modified | Yellow | Value changed |
6264
| Type Changed | Orange | Type mismatch (e.g. number → string) |
6365

6466
## Styling
@@ -93,7 +95,7 @@ json-diff-viewer {
9395

9496
/* Layout */
9597
--radius: 12px;
96-
--font: 'JetBrains Mono', monospace;
98+
--font: "JetBrains Mono", monospace;
9799
}
98100
```
99101

@@ -130,4 +132,4 @@ npm run build # build for production
130132

131133
## License
132134

133-
MIT
135+
[MIT](LICENSE)

src/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ import "./style.css";
55
const viewer = document.querySelector("json-diff-viewer");
66

77
Promise.all([
8-
fetch("/data/a1.json").then((r) => r.json()),
9-
fetch("/data/a2.json").then((r) => r.json()),
8+
fetch(`${import.meta.env.BASE_URL}data/a1.json`).then((r) => r.json()),
9+
fetch(`${import.meta.env.BASE_URL}data/a2.json`).then((r) => r.json()),
1010
]).then(([left, right]) => viewer.setData(left, right));

vite.config.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import { defineConfig } from 'vite';
2+
3+
export default defineConfig({
4+
base: '/json-diff-viewer-component/',
5+
});

0 commit comments

Comments
 (0)