https://github.com/softonic/nunjucks-include-with

Nunjucks extension that allows send data to include template.
https://github.com/softonic/nunjucks-include-with

context extension nunjucks with

Last synced: 3 months ago
JSON representation

Nunjucks extension that allows send data to include template.

• Host: GitHub
• URL: https://github.com/softonic/nunjucks-include-with
• Owner: softonic
• License: other
• Created: 2017-03-14T10:45:33.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-12-10T11:57:25.000Z (about 5 years ago)
• Last Synced: 2024-09-26T20:46:00.799Z (3 months ago)
• Topics: context, extension, nunjucks, with
• Language: JavaScript
• Size: 31.3 KB
• Stars: 13
• Watchers: 9
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nunjucks-include-with

Nunjucks extension that allows send data to include template.

## Installation

```bash

npm install nunjucks-include-with

```

## Usage

```javascript

// 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

1. Fork it: `git clone https://github.com/softonic/nunjucks-include-with.git`

2. Create your feature branch: `git checkout -b feature/my-new-feature`

3. Commit your changes: `git commit -am 'Added some feature'`

4. Check the build: `npm run build`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D