1.0.5 • Published 6 years ago
nunjucks-include-with v1.0.5
nunjucks-include-with
Nunjucks extension that allows send data to include template.
Installation
npm install nunjucks-include-withUsage
// CommonJS
// const IncludeWithNunjucksExtension = require('nunjucks-include-with');
// ES6
import IncludeWithNunjucksExtension from 'nunjucks-include-with';
import nunjucks from 'nunjucks';
// Registration
const nunjucksEnv = nunjucks.configure('views');
nunjucksEnv.addExtension('includeWith', new IncludeWithNunjucksExtension({
nunjucksEnv
}));
//Template
{% includeWith "../partial.tpl", { name: 'Test' } %}Extension Options
IncludeWithNunjucksExtension({Object})
| Name | Type | Default | Description |
|---|---|---|---|
| nunjucksEnv | Environment | Instance of Nunjucks environment. https://mozilla.github.io/nunjucks/api.html#environment | |
| tagName | String | includeWith | Name for the tag in the template. |
Template Options
{% includeWith {String}, {Object}, {Object} %}
| Name | Type | Default | Description |
|---|---|---|---|
| templatePath | String | Path of the included template. | |
| data | Object | {} | Object with the data for the included template. |
| options | Object | { useContext = true } | Option to include the global context. |
Contribute
- Fork it:
git clone https://github.com/softonic/nunjucks-include-with.git - Create your feature branch:
git checkout -b feature/my-new-feature - Commit your changes:
git commit -am 'Added some feature' - Check the build:
npm run build - Push to the branch:
git push origin my-new-feature - Submit a pull request :D