React JSON Syntax - Construct React elements, JSX and HTML with JSON without transpilers. JSONX supports React Function and Class Components, React Lazy and Suspense Components, and full support for React Hooks
npm install jsonx !Build, Test & Coverage
JSONX is a module that creates React Elements, JSX and HTML from JSON.
The JSONX web module comes with batteries included so you can use JSONX in the browser without transpilers or any additional setup/configuration. The JSONX UMD is ideal for JAMstack Applications.
JSONX can also be used in existing react applications if you want to dynamically create elements with JSON. This works great for many scenarios when you want to manage your application views and components in a view management system or if you want to dynamically create React elements without using JSX.
JSONX supports all of Reacts features including Functional (with Hooks), Class-based, Suspense and Lazy components. JSONX supports JSON objects that implement the JXM (JSONX Markup) Spec.
``sh`
$ npm i jsonx
---
javascript
import { * as jsonx } from 'jsonx';
const example_JXM_JSON = {
component:'p',
props:{ style:{ color:'blue' } },
children:'hello world'
};//Rendering React Components
jsonx.getReactElement(example_JXM_JSON); // => JSX Equivalent:
hello world
//Generating HTML strings
jsonx.outputHTML({ jsonx: example_JXM_JSON, }); // => '
hello world
'//Generating JSX strings
jsonx.outputJSX({ jsonx: example_JXM_JSON, }); // => '
hello world
'//Rendering HTML Dom with React
jsonx.jsonxRender({ jsonx: example_JXM_JSON, querySelector:'#myApp', });
//
//
//
// hello world
//
// //you can also use the simplified syntax
const simpleJXM_JSON = {
p:{
props:{ style:{ color:'blue' } },
children:'hello world'
}
}
//or if you have an element with no props, simply use {type:children}
const superSimpleJXM = {
ul:[
{li:'first!'},
{li:'second!'},
]
}
`
$3
JSONX works by using JXM JSON to create react elements. JXM JSON Objects are valid JSON Objects that more or less mimics JSX in JSON notation with a couple of special properties. The properties for JSONX JSON are the arguments passed to React.createElement. The only required property is the component (which is passed as the
argument)`javascript
React.createElement(
type,
[props],
[...children]
)
`You can pass React component libraries for additional components, or you own custom components (see External and Custom Components
and Using Advanced Props for more details).
$3
Note Make sure you have typescript installed
sh
$ npm i -g typescript
`For generating documentation
sh
$ npm run doc
`$3
Check out https://repetere.github.io/jsonx/ for the full jsonx Documentation
$3
sh
$ npm test
``Fork, write tests and create a pull request!
License
----
MIT