load-less-helpers

load-less-helpers

register helper functions that can be used with LESS, the same way that handlebars helpers are used in templates.

Install

Install with npm:

$ npm install --save load-less-helpers

Usage

var less = require('less');
var register = require('load-less-helpers')(less);

Registering helpers

Register a single helper

Example assets helper, that might be used for dynamically calculating the path to a project's assets directory, relative to the css file's destination.

register.helper('assets', function (path) {
  return 'dist/' + path.value + '/assets/css';
});

Register multiple helpers

register.helpers({
  assets: function (path) {
    return 'dist/' + path.value + '/assets/css';
  },
  foo: function () {},
  bar: function () {}
});

Using helpers

Example of how to use the assets helper we just created above:

@theme: "blah";
@assets: assets("@{theme}");

.image {
  background: url("@{assets}/bar.png");
}

Results in:

.image {
  background: url("dist/blah/assets/css/bar.png");
}

Properties

The following properties are exposed on the this object:

• options: Any options passed to render are exposed on this object
• less: the less object

Example

register.helper('assets', function (path) {
  return path.join(path.value, this.options.assets);
});

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. MIT

This file was generated by verb-generate-readme, v0.4.2, on January 29, 2017.