@zerodevx/svelte-json-view
Advanced tools
Readme
View JSON data prettily.
Display JSON data in a tree-like expandable view. Use as a Svelte component or in Vanilla JS.
Here's a demo.
Install the package:
$ npm i @zerodevx/svelte-json-view
If you're using this in a Svelte app:
<script>
import { JsonView } from '@zerodevx/svelte-json-view'
const json = { foo: 'bar' }
</script>
<JsonView {json} />
For other applications with a bundler:
// Import the compiled code from `/dist`
import { JsonView } from '@zerodevx/svelte-json-view/dist'
const app = new JsonView({
target: document.body // node to render into
})
app.$set({
json: { foo: 'bar' }, // object to prettify
... // any other props
})
Or load via CDN:
<head>
...
<!-- Load `JsonView` from CDN -->
<script defer src="https://cdn.jsdelivr.net/npm/@zerodevx/svelte-json-view@1"></script>
<!-- Register the view -->
<script type="module">
const app = new JsonView({
target: document.querySelector('#target'), // node to render into
props: {
json: { foo: 'bar' }, // object to prettify
... // any other props
}
})
</script>
</head>
<body>
<div id="target"></div>
</body>
In general, use CSS variables.
| Name | Default | Description |
|---|---|---|
| --jsonPaddingLeft | 1rem | Amount of left padding to apply at each depth |
| --jsonBorderLeft | 1px dotted | Style applied to left border for each depth |
| --jsonBracketColor | currentcolor | Color for brackets [, {, } and ] |
| --jsonBracketHoverBackground | #e5e7eb | Hover background for brackets |
| --jsonSeparatorColor | currentcolor | Color for separators : and , |
| --jsonKeyColor | currentcolor | Color for keys |
| --jsonValColor | #9ca3af | Default color for values |
| --jsonValStringColor | #059669 | Color for string values |
| --jsonValNumberColor | #d97706 | Color for number values |
| --jsonValBooleanColor | #2563eb | Color for boolean values |
It's recommended to wrap the component to apply your own font family (a monospaced font is recommended) and also to apply custom CSS var overrides.
<div class="wrap">
<JsonView {json} />
</div>
<style>
.wrap {
font-family: monospace;
font-size: 14px;
--jsonBorderLeft: 2px dashed red;
--jsonValColor: blue;
...
}
</style>
| Name | Type | Default | Description |
|---|---|---|---|
| json | Object | undefined | Un-stringified object to display |
| depth | Number | Infinity | Initial expansion depth |
Library is packaged via SvelteKit. Standard Github contribution workflow applies.
End-to-end testing via Playwright. To run tests headlessly:
$ npm run test
Please refer to the releases page.
ISC
FAQs
View JSON data prettily
The npm package @zerodevx/svelte-json-view receives a total of 2,166 weekly downloads. As such, @zerodevx/svelte-json-view popularity was classified as popular.
We found that @zerodevx/svelte-json-view demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.