useful-nunjucks-filters

Collection of useful Nunjucks template filters

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
useful-nunjucks-filters
300.1.36 years ago6 years agoMinified + gzip package size for useful-nunjucks-filters in KB

Readme

Useful Nunjucks Filters
A few filters to fill in the gaps between the default Nunjucks filters.

Installing

To install the latest release version:
npm install --save useful-nunjucks-filters

In your application's server.js file simply require useful-nunjucks-filters, passing the Nunjucks environment object.
const express = require('express');
const nunjucks = require('nunjucks');
const app = express();

let environment = nunjucks.configure('views', {
  autoescape: true,
  express: app
});

require('useful-nunjucks-filters')(environment);

Available Filters

currency(input, sign)

{# foo = 102432.56 #}

{{ foo | currency('$') }}

{# => $102,432.56 #}

humanable(input)

{# foo = 'this-is-a-slug'; #}

{{ foo | humanable }}

{# => This is a slug #}

pasttense(input)

{# foo = 'code' #}

{{ foo | past_tense }}

{# => coded #}


{# foo = 'panic' #}

{{ foo | past_tense }}

{# => panicked #}


{# foo = 'laugh' #}

{{ foo | past_tense }}

{# => laughed #}

percent(input, decimals)

{# foo = 0.98645 #}

{{ foo | percent(2) }}

{# => 98.64% #}


{# foo = 0.98645 #}

{{ foo | percent }}

{# => 98% #}

License

Useful Nunjucks Filters is copyright (c) 2016 Bryan Kizer and licensed under the MIT License.
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.