jsx-async-runtime
v2.0.2
Published
An asynchronous JSX runtime without dependencies to be used as html template engine.
Downloads
1,678
Maintainers
mjablonskiReadme
jsx-async-runtime
An asynchronous JSX runtime without dependencies to be used as html template engine for server or browser.
Breaking change
With jsx-async-runtime >= v2.x.x HTML entities are escaped per default. Read more...
Introduction
This runtime was initially developed for Jeasx, but has a value of its own. Its main focus is to keep things simple, reliable, secure and fast.
You can find more information about using this runtime as template engine in the Jeasx documentation.
Installation
npm i jsx-async-runtimeTo make use of the jsx-async-runtime, you need to configure your transpiler to utilize this package for transforming the JSX syntax. If you are using TypeScript or esbuild for transpiling your code base, simply add the following options in your tsconfig.json:
{
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "jsx-async-runtime"
}
}The example project provides a complete tsconfig.json with all required options for a proper project setup.
Now you can create a simple test file (e.g. src/HelloWorld.jsx) and execute it via npx tsx src/HelloWorld.jsx:
import { jsxToString } from "jsx-async-runtime";
export default function HelloWorld({ greeting }) {
return (
<>
{{ html: `<!DOCTYPE html>` }}
<html>
<head>
<meta charset="utf-8" />
<title>{greeting}</title>
</head>
<body>
<h1>{greeting}</h1>
</body>
</html>
</>
);
}
// Use jsxToString#call with {} to create a 'this' context
console.log(await jsxToString.call({}, <HelloWorld greeting="Hello World" />));Usage
If you're using jsx-async-runtime as template engine, you might want to include data from an asynchronous operation in the resulting markup. To simplify this process, you can make your components asynchronous and send async requests from within them.
export default async function Todos() {
const { todos } = await (await fetch("https://dummyjson.com/todos")).json();
return (
<ul>
{todos.map(({ todo, completed }) => (
<li>
{todo} ({completed ? "yes" : "no"})
</li>
))}
</ul>
);
}jsx-async-runtime >= v2.x.x escapes all HTML entities for texts per default to prevent cross site scripting. If you want or need to opt out this security feature to include literal HTML snippets in your template (e.g. WYSIWYG content from a CMS), you can provide an object with a single key called html containing the code snippet as a string in your JSX template:
<div>{{ html: "<p>Some <b>HTML</b> from a CMS</p>"}}</div>If you want to disable the automatic escaping of HTML completely to restore the behaviour of jsx-async-runtime < v2.x.x, you can turn off text escaping with a compatibilty switch via the this context:
export default function () {
this.jsxEscapeHTML = false;
return <div>{"<p><b>HTML</b> from a trusted CMS</p>"}</div>
}If you opt out of automatic escaping, you can use a built-in utility function to escape markup from untrusted external sources:
import { escapeEntities } from "jsx-async-runtime";
export default function () {
this.jsxEscapeHTML = false;
return <div>{escapeEntities("<p><b>HTML</b> from user input</p>")}</div>
}Example project
You can study the example project to learn more about all existing features. Here is a shortened version to give you the idea:
import { jsxToString } from "jsx-async-runtime";
export default function App() {
return (
<>
{{ html: `<!DOCTYPE html>`}}
<html>
<head>
<meta charset="utf-8" />
<title>Todos</title>
</head>
<body>
<Header label="<Todos>" />
<TodoList quantity={3} />
</body>
</html>
</>
);
}
function Header({ label }) {
return (
<section
style={{
"background-color": "red",
"padding-bottom": "1rem",
}}
>
<h1 style="color: white; text-align: center">{label}</h1>
</section>
);
}
async function TodoList({ quantity }) {
const { todos } = await (await fetch("https://dummyjson.com/todos")).json();
return (
<table class="table">
<thead class={{ thead: true, striped: false, sticky: true }}>
<tr>
<th>Label</th>
<th>Status</th>
</tr>
</thead>
<tbody class="tbody striped">
{todos.slice(0, quantity).map(({ todo, completed }) => (
<tr>
<td>
<label for="todo">{todo}</label>
</td>
<td>
<label for="status">{completed ? "yes" : "no"}</label>
</td>
</tr>
))}
</tbody>
</table>
);
}
// Use jsxToString#call with {} to create a 'this' context
console.log(await jsxToString.call({}, <App />));