1.0.1 • Published 5 years ago
posthtml-partials v1.0.1
posthtml-partials
A fork of https://github.com/mrmlnc/posthtml-mixins with a few small updates
A PostHTML plugin adds support for partials. partials allow you to create reusable blocks of code.
Install
$ npm i -D posthtml-partials
Usage
const { readFileSync } = require('fs');
const posthtml = require('posthtml');
const partials = require('posthtml-partials');
const html = readFileSync('index.html');
posthtml([ partials() ])
.process(html)
.then((result) => console.log(result.html))
Options
delimiters
- Type:
String[]
- Default:
['{{', '}}']
Array containing beginning and ending delimiters for locals.
For example:
['{', '}']
-{ key }
['${', '}']
-${ key }
['%', '%']
-%key%
['%', '']
-%key
Features
Parameters
We support parameters for partials inside tags and in attributes.
<mixin name="say" class from>
<p class="{{ class }}">Hello from {{ from }}!</p>
</mixin>
<div>
<mixin name="say" class="hello" from="me"></mixin>
</div>
<div>
<p class="hello">Hello from me!</p>
</div>
Default values
We support default values for parameters (order is unimportant).
<mixin name="say" class from="me">
<p class="{{ class }}">Hello from {{ from }}!</p>
</mixin>
<div>
<mixin name="say" class="hello"></mixin>
</div>
<div>
<p class="hello">Hello from me!</p>
</div>
Mixin reloading
We support Mixin reloading when the Mixin may have the same name but a different number of parameters.
<mixin name="say" from>
<p>Hello from {{ from }}!</p>
</mixin>
<mixin name="say">
<p>Hello!</p>
</mixin>
<div>
<mixin name="say"></mixin>
</div>
<div>
<mixin name="say" from="mixin"></mixin>
</div>
<div>
<p>Hello!</p>
</div>
<div>
<p>Hello from mixin!</p>
</div>
Changelog
See the Releases section of our GitHub project for changelogs for each release version.
License
This software is released under the terms of the MIT license.
1.0.1
5 years ago