Build JSX structures, then decide at runtime which pragma you want to use to render them.
Build JSX structures, then decide at runtime which pragma you want to use to render them.
Because JSX is pretty useful, even without React!
First we'll build a small component. We're not tying ourselves to any particular framework yet, or any render target.
/* @jsx node */
import { node } from "jsx-pragmatic";
function Login({ prefilledEmail }) {
return (
Log In
);
}Let's say we're on the server-side, and we want to render the jsx to html to serve to a client. Just pass html() to the renderer:
/* @jsx node */
import { node, html } from "jsx-pragmatic";
import { Login } from "./components";
function render() {
return ().render(html());
}Now let's render the same jsx template on the client-side, directly to a DOM element:
/* @jsx node */
import { node, dom } from "jsx-pragmatic";
import { Login } from "./components";
function render() {
return ().render(dom());
}Or if we're using the same component in React, we can render it as a React component:
/* @jsx node */
import { node, react } from "jsx-pragmatic";
import { Login } from "./components";
function render() {
return ().render(react({ React }));
}Or if we're using the same component in Preact, we can render it as a Preact component:
/* @jsx node */
import { node, preact } from "jsx-pragmatic";
import { Login } from "./components";
function render() {
return ().render(preact({ Preact }));
}Renderers are just functions!
customDom. This will take some options and return our renderer.name, props and children and renders them in whatever way you want!This example renders the jsx directly to DOM elements:
…Then when you're ready to use your renderer, just pass it into .render() and pass any options you want to use to configure the renderer.
function render() {
return ().render(
customDom({ removeScriptTags: true })
);
}You can either import Fragment from jsx-pragmatic:
/* @jsx node */
import { node, Fragment } from "jsx-pragmatic";
function Login({ prefilledEmail }) {
return (
Log In
);
}Or use the @jsxFrag comment, and the new <> `` syntax for Fragments, providing you're using Babel 7:
/* @jsx node */
/* @jsxFrag Fragment */
import { node, Fragment } from "jsx-pragmatic";
function Login({ prefilledEmail }) {
return (
<>
Log In
);
}JSX is a neat way of parsing and compiling templates to vanilla javascript. Right now most people use JSX with React. But in reality, the technology is decoupled enough from React that it can be used to render anything:
This library helps you do that.
Yep, Babel provides a neat pragma option which lets you choose what your jsx is compiled to; if you don't want to use React.createElement, you can write your own pragma to convert the jsx to anything else.
The only problem with that is, the decision of which pragma to use is made entirely at build-time. Let's say you have a template which needs to be:
jsx-pragmatic helps you achieve that by allowing you decide when you render what your jsx should be transformed into.
It also abstracts away some of the stuff in jsx that's a little tricky to deal with; like nested children arrays, dealing with basic element vs function components, and fragments -- leaving you to focus on the renderer logic.
npm install --save jsx-pragmaticnpm run setup./src and writing tests in ./testsnpm run buildnpm run buildEdit tests in ./test/tests
Run the tests:
npm run testnpm run karma -- --browser=PhantomJS
npm run karma -- --browser=Chrome
npm run karma -- --browser=Safari
npm run karma -- --browser=Firefox
npm run karma -- --browser=PhantomJS,Chrome,Safari,Firefoxnpm run karma -- --browser=Chrome --keep-open./src, ./test/tests and ./demopackage.jsonREADME.md and CONTRIBUTING.mdnpm run release to add a patchnpm run release:path, npm run release:minor, npm run release:majorNo open issues yet, or sync has not completed.