Template helper for generating a geometric SVG pattern for CSS backgrounds using btmills/geopattern
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
test
.editorconfig
.eslintrc.json
.gitattributes
.gitignore
.travis.yml
.verb.md
LICENSE
README.md
index.js
package.json

README.md

helper-geopattern NPM version NPM monthly downloads NPM total downloads Linux Build Status

Template helper for generating a geometric SVG pattern for CSS backgrounds using btmills/geopattern

Install

Install with npm:

$ npm install --save helper-geopattern

Usage

Example for handlebars, but this should work for any template engine that takes helpers or filters.

var geopattern = require('helper-geopattern');
var handlebars = require('handlebars');

// the helper is a function that must be called when registered,
// allowing you to pass in default options to use
handlebars.registerHelper('geopattern', geopattern([options]));

Examples

Generate the geopattern based on page title (which would need to exist on the context):

<style>
  .page-header { 
    background-image: {{geopattern title}};
  }
</style>

generator

Optionally specify the "generator" to use, which is the geometric shape. See Jason Long's geo_pattern library for examples of all available generators.

<div style="background-image: {{geopattern title generator="octogons"}}"></div>

color

Optionally specify the "color" to use

<div style="background-image: {{geopattern title color="#900"}}"></div>

About

Related projects

Contributing

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

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT license.


This file was generated by verb-generate-readme, v0.3.0, on January 06, 2017.