README
¶
A Lavish HTML Templating System for Go
For when Plush just isn't nice enough.
Have you ever wished that you could write a monolithic web application in Go, with server-side rendering, but you kinda like JSX for HTML templates?
Finally, the day has come* where this can be a reality!
*if you count alpha-quality software without API stability guarantees
Lavish is built on the incredible foundation laid by esbuild and goja to compile JSX to vanilla Javascript and execute it in a pure Go runtime.
It's faster than you might think - not as fast as Plush, of course, but only a few thousand times slower! Surely those handfuls of milliseconds are worth the more comfortable developer experience.
Rendering Engines
Lavish comes bundled with Preact v10 to turn the JSX into an HTML string.
In theory, any JSX framework which also ships a server-side rendering package could be used instead - although you can't have any client-side state, anyway, so what else could you want? Maybe there's a runtime that's even smaller after tree shaking?
Reminder that Lavish is currently in an alpha state
I got the basic idea working in a few hours late one evening and then spent a Saturday setting up this barely presentable package. Use this package at your own risk.
Documentation
¶
Index ¶
- func CompileJSX(name, jsx string, options api.TransformOptions) (program *goja.Program, err error)
- type Bundle
- func (b Bundle) Render(program *goja.Program, data any) (rendered string, err error)
- func (b *Bundle) RenderJSX(name, jsx string, data any) (rendered string, err error)
- func (b Bundle) WithDataVariable(varName string) Bundle
- func (b Bundle) WithProgramCache(cache ProgramCache) Bundle
- func (b Bundle) WithRenderCache(cache RenderCache) Bundle
- func (b Bundle) WithRenderFunction(funcName string) Bundle
- type Hashable
- type Loader
- type LoaderFunc
- type ProgramCache
- type RenderCache
- type RenderEngine
- type TransformError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CompileJSX ¶
CompileJSX to a goja Program.
Types ¶
type Bundle ¶
type Bundle struct {
// contains filtered or unexported fields
}
func NewBundle ¶
func NewBundle(engine RenderEngine, modules ...Loader) Bundle
func (Bundle) WithDataVariable ¶
func (Bundle) WithProgramCache ¶
func (b Bundle) WithProgramCache(cache ProgramCache) Bundle
func (Bundle) WithRenderCache ¶
func (b Bundle) WithRenderCache(cache RenderCache) Bundle
func (Bundle) WithRenderFunction ¶
type Loader ¶
A Loader loads a module into a runtime environment.
func ComponentJSX ¶
func ComponentJSX(name, source string, options api.TransformOptions) Loader
type LoaderFunc ¶
type ProgramCache ¶
type RenderCache ¶
type RenderEngine ¶
type RenderEngine interface {
Loader
// GetJSXOptions to transpile to vanilla JS.
GetJSXOptions() api.TransformOptions
// GetRenderFunction after it has been loaded into the runtime environment.
// This function should take exactly 1 argument and produce a string.
GetRenderFunction(*goja.Runtime) (goja.Callable, error)
}
Source Files
Directories