oxypogon-renderer v0.1.0

OxypogonRenderer

A simple class that renders an arbitrary react component specified as a class name to a string.

Usage example

const OxypogonRenderer = require('oxypogon-renderer');

const renderer = new OxypogonRenderer({
	basepath: './components' // full path to a folder to which components' names should be resolved to
});

const props = {
	name: 'An example article for OxypogonRenderer readme'
}
let renderedComponent = renderer.render('ArticleTest', props);

console.log(renderedComponent);

The code above along with the ./components/article-test.jsx of the following content:

const React = require('react');

class ArticleTest extends React.Component {
	render() {
		return (
			<article>
				<h1>{this.props.name}</h1>
			</article>
		);
	}
}

module.exports = ArticleTest;

creates this output:

<article><h1>An example article for OxypogonRenderer doc</h1></article>

Subtle details

As you could have noticed, OxypogonRenderer transforms class name ArticleTest into a filename article-test.jsx and resolves it into a full path specified by config.basepath on constructor invocation which is concateneted to a filename itself.

Probably, this transormation is excessive, but as far as I believe it serves a common NodeJS class name to file name convention, it will reside here.

License

ISC License (ISC)

Copyright 2017 Oleg Gromov mail@oleggromov.com

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.