Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timomeh/ejs-helper
Template helper functions for ejs view engine
https://github.com/timomeh/ejs-helper
Last synced: 3 months ago
JSON representation
Template helper functions for ejs view engine
- Host: GitHub
- URL: https://github.com/timomeh/ejs-helper
- Owner: timomeh
- Archived: true
- Created: 2015-05-01T22:28:08.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2018-12-16T21:53:18.000Z (about 6 years ago)
- Last Synced: 2024-09-20T08:32:46.718Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 12.7 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# EJS Helper
> **Hey, developer! This project is *unmaintained*. Since I'm not using EJS in any project anymore, I have no interest in maintaining it. Feel free to open a [Pull Request](https://github.com/timomeh/ejs-helper/pulls), if you'll want to fix something or add a fancy feature. kthxbye**
>
> Also a big thanks to [Andreas Galazis](https://github.com/agalazis) for adding new features from time to time.
EJS Helper is a collection of functions to have a better template including experience in [Express](https://github.com/strongloop/express).
Works with Express `4.x` and EJS `2.x`.
## Installation
```bash
npm install ejs-helper --save
```
## Usage
### Express integration
```js
var ejsHelper = require('ejs-helper');
app.use(ejsHelper({
cssPath: '/static/css/',
jsPath: '/static/js/',
urlArgs: 'v='+requie("package.json").version+'&awesomeness=true'
}));
```
### Template integration
Most of the times you will have something like a `header.ejs` and `footer.ejs` which will be included in a `somePage.ejs` as a re-usable template. But sometimes you want to insert CSS- or JavaScript-Files into your header and/or footer from your `somePage`. Sending locals along `res.render()` is not the best solution.
This will be implemented like this:
**header.ejs**
```html
<%= title() %>
<%- head(); -%>
<%- scripts('header'); %>
<%- styles(); -%>
```
**footer.ejs**
```html
<%- scripts('footer'); %>
```
**somePage.ejs**
```html
<%
setTitle('Some Page');
addHead('');
addHead('');
addStyle('style.css');
addStyle('print.css', { media: 'print' });
addScript('header', 'script1.js', { async: 'async' });
addScript('footer', 'script2.js');
%>
<% include header %>
Lorem ipsum
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
<% include footer %>
```
The rendered HTML will look like this:
```html
Some Page
Lorem ipsum
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
```
## Options
* `cssPath` will be prepended to the filename of the CSS href
* `jsPath` will be prepended to the filename of the script src
* `urlArgs` are extra query string arguments appended to relative path URLs
The above configuration is ignored if absolute url is provided. eg:
```js
addScript('footer', 'https://cdnjs.cloudflare.com/ajax/libs/require.min.js')
```
OR
```js
addScript('footer', '//cdnjs.cloudflare.com/ajax/libs/require.min.js')
```
OR
```js
addScript('footer', 'http//cdnjs.cloudflare.com/ajax/libs/equire.min.js')
```
Then the original url is used and for example in the second case when `scripts('footer')`
is called, no matter what configuration is used, it will result to:
```html
```
## Methods
You can use these methods in your template.
**setTitle()**
Sets the title of the page
**addHead(htmlString)**
Adds a String of HTML.
* *htmlString* *(required)* is a line of text/html.
**addStyle(file, attributes)**
Adds a Stylesheet ``.
* *file* *(required)* is the filename of the CSS file.
* *attributes* *(optional)* is a key-value object of HTML Attributes.
**addScript(place, file, attributes)**
Adds a JavaScript ``.
* *place* *(required)* can be `header` or `footer`.
* *file* *(required)* is the filename of the JavaScript file.
* *attributes* *(optional)* is a key-value object of HTML Attributes.
**title()**
Returns the specified title.
**head()**
Returns the specified HTML.
**styles()**
Returns the specified Style Sources.
**scripts(place)**
Returns the specified Script Sources.
* *place* *(required)* can be `header` or `footer`.
## License
The MIT License (MIT)
Copyright (c) 2015 Timo Mämecke
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.