0.0.1 • Published 4 years ago
nicole v0.0.1
Nicole
Nicole is a lightweight Typescript library for rendering typesafe TSX templates to a static HTML string.
If you're already using React on your frontend, use Nicole on your Node backend to render HTML for emails and error pages.
Installation
npm install git://github.com/wispira/nicole.gitAdd the following to your tsconfig.json file
{
"compilerOptions": {
"jsx": "react"
}
}Usage
Basic Example
import { React } from 'nicole';
const Component = () => (
<h1>Hello, World!</h1>
);Renders to
<h1>Hello, World!</h1>Advanced Example
import { React } from 'nicole';
interface Props extends React.Props {
title: string;
}
const Layout: React.FC<Props> = (props) => {
return (
<html>
<head>
<title>{props.title}</title>
</head>
<body>
<h1>{props.title}</h1>
{props.children}
</body>
</html>
);
};
// another file
const names = [
'Doug',
'Justine',
'Pat',
];
const Page: React.FC = () => (
<Layout title="Page">
<ul>
{names.map((name) => (
<li>{name}</li>
))}
</ul>
</Layout>
);
const html = Page({});Renders to
<html>
<head>
<title>Page</title>
</head>
<body>
<h1>Page</h1>
<ul>
<li>Doug</li>
<li>Justine</li>
<li>Pat</li>
</ul>
</body>
</html>Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
Nicole is released under the ISC license.
0.0.1
4 years ago