Skip to content

Latest commit

 

History

History
87 lines (69 loc) · 2.84 KB

README.md

File metadata and controls

87 lines (69 loc) · 2.84 KB

snapsvg-hexagonal

npm Build Status Build status Coverage Status bitHound Overall Score Known Vulnerabilities

Snap.svg plugin for creating hexagonal UI elements.

Installation

npm install snapsvg snapsvg-hexagonal

Usage

AMD (Require.js)

Add to paths attrbute of requirejs config file and require in code

// config.js
requirejs.config({
    paths: {
        snapsvg:   'path/to/node_modules/snapsvg/snapsvg',
        hexagonal: 'path/to/node_modules/snapsvg-hexagonal/dist/snapsvg-hexagonal'
    }
});

// main.js
define(function(require) {
    'use strict';

    const Snap = require('snapsvg');
    const hexagonal = require('hexagonal');
    Snap.plugin(hexagonal);
});

Browser global

<!DOCTYPE html>
<html lang="en">
    <head>...</head>
    <body>
        <script src="path/to/node_modules/snapsvg/snapsvg.js"></script>
        <script src="path/to/node_modules/snapsvg-hexagonal/dist/snapsvg-hexagonal.js"></script>
        <script type="text/javascript">
            Snap.plugin('hexagonal');
            /* code code code */
        </script>
    </body>
</html>

Features

Under construction

Contributing

Please read the contributing guide

Roadmap

Credits

  • Under construction

License

FOSSA Status