@lumeland/ssx
v0.1.13
Published
Fast and simple JSX library for server side
Downloads
166
Readme
SSX
JSX is terrible for frontend. But it's an acceptable way to create HTML code in server side, specially if it's supported by default by TypeScript and Deno.
Most of the current JSX libraries are designed to work in server and client sides. They do complicated things like a virtual DOM, reactivity, hooks, hydration, events, etc, in order to create interactive user interfaces.
SSX is a minimal JSX library designed to be used ONLY in server side and output plain HTML code.
- Created in TypeScript, for Deno.
- Very fast. It's compatible with the
precompileoption available in Deno.7-20x faster rendering times and a 50% reduction in Garbage Collection times.
- Run
deno task benchto compare SSX with React, Hono and Preact. - Designed to output HTML. It uses real HTML attributes (no more
className). - Great HTML and CSS documentation. Every element and property has a description and even links to MDN documentation. Types are generated using the data from VSCode Custom Data.
- It supports async components (components returning a Promise).
- Allows to insert raw HTML code easily (without patronizing you).
- You can add the
<!doctype html>declaration.
Configuration
In your deno.json file:
{
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "ssx"
},
"imports": {
"ssx/jsx-runtime": "https://deno.land/x/ssx/jsx-runtime.ts"
}
}Alternatively, you can use JsDelivr as CDN.
Using NPM specifier
SSX is also
published on NPM as @lumeland/ssx:
{
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "npm:@lumeland/ssx"
}
}Use with Node and Bun
If you want to use SSX with Node.js or Bun, see the /node folder for an
example setup using this package in a Node environment.
Example:
// Main component
function Main() {
return (
<div id="main">
<Header>
<p>Welcome to SSX</p>
{{ __html: "Raw <b>HTML</b> code" }}
</Header>
</div>
);
}
// Async component
async function Header({ children }: { children: JSX.Children }) {
const res = await fetch(
`https://api.dictionaryapi.dev/api/v2/entries/en/${name}`,
);
const json = await res.json();
const def = json[0]?.meanings[0]?.definitions[0]?.definition;
return (
<>
<h2>Definition of {name}:</h2>
<p>{def || "Definition not found"}</p>
{children}
</>
);
}
// String with the HTML code
console.log(await Main());Adding Doctype:
Any child with the shape { __html: string } is treated as raw HTML and will
not be escaped. This allows you to insert the <!doctype html> declaration
directly (something not possible in other JSX libraries):
{{ __html: "<!DOCTYPE html>" }}
<html>
...
</html>;