HTMLisp is a light extension of HTML meant for templating. In other words, HTMLisp accepts a context, allows binding it, and supports basic features, such as iteration. All the features have been implemented using as HTML attribute extensions meaning HTML-oriented tooling works well with HTMLisp out of the box. HTMLisp is the default option for templating in Gustwind although technically you could bring your own solution.
I've listed the main features below:
eval free - to support execution in environments without support for JavaScript eval the solution does not rely on evalIf you understand how Lisp evaluation works, then you understand how Gustwind templating works. To give a concrete example, consider the component example below:
<div>
<SiteLink
&children="(get props title)"
&href="(urlJoin blog (get props slug))"
/>
</div>
That (get props title) expression should be read as get('props', 'title') call. Note the & before the attribute name as that signifies an expression binding.
The latter binding illustrates how expressions can be nested and (concat blog / (get props slug)) can be read as concat('blog', '/' , get('props', 'slug')).
To allow iteration over data, there is a specific &foreach syntax as shown below:
<ul &foreach="(get context blogPosts)">
<li class="inline">
<SiteLink
&children="(get props title)"
&href="(urlJoin blog (get props slug))"
/>
</li>
</ul>
The idea is that the expression given to &foreach generates an array that is then iterated through. In case the array contains pure values (i.e., strings, numbers etc.), those are exposed through value property that you can access through (get props value) within the &foreach block.
Given there are times when you might want to remove a part of the DOM structure based on an expression, there is &visibleIf helper that works as below:
<body>
<MainNavigation />
<aside
&visibleIf="(get props showToc)"
class="fixed top-16 pl-4 hidden lg:inline"
>
<TableOfContents />
</aside>
<main &children="(get props content)"></main>
<MainFooter />
<Scripts />
</body>
When showToc evaluates as false, aside element is removed completely from the structure.
Given there are times when you might want to perform an operation but not generate markup directly, there's a noop helper. Technically this is comparable to React fragments and it works as below:
Do nothing
<noop />
Iterate without generating a parent element
<noop &foreach="(get context scripts)">
<script &type="(get props type)" &src="(get props src)"></script>
</noop>
Replace type based on a given prop
<noop
&type="(get props type)"
&class="(get props class)"
&children="(processMarkdown (get props children))"
></noop>
There is a commenting syntax that allows documenting and gets removed through processing:
<div __reference="https://gustwind.js.org/">Site creator</div>
Within components, props field is available within the context. On a high level it is comparable to how React and other libraries work so that components can encapsulate specific functionality and may be reused across projects easily.
To make it convenient to construct complex components that accept structures from the consumer, there is support for slots as below:
<BaseLayout>
<slot name="content">Main content goes here</slot>
<slot name="aside"><TableOfContents /></slot>
</BaseLayout>
Internally slots map to props. The main benefit is that they allow expression of complex element structures without having to go through an attribute.
Use the playground below to experiment with the syntax and see how it converts to HTML:
:TemplatingPlayground:
Note that this playground works only on Gustwind website.
MIT.
FAQs
HTML combined with Lisp for fun and profit
The npm package htmlisp receives a total of 4 weekly downloads. As such, htmlisp popularity was classified as not popular.
We found that htmlisp demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.