@vkontakte/sprites

    1.0.2 • Public • Published

    @vkontakte/sprites

    Module version badge License badge Minimum Node.JS version badge

    Module for generate SVG sprites and PNG fallback that used in m.vk.com

    Requirements

    Inkscape (>= 0.91)

    Node.JS (>= 8)

    Install

    npm install @vkontakte/sprites or yarn add @vkontakte/sprites

    Demo

    See demo/index.js

    Generating

    To generate Sprites you just need to run

    generate(path, output = {}, converter, options)

    • path is place on your filesystem where module loads SVG icons
    • converter see PNG Fallback section

    PNG Fallback

    In this time there is single PNG converter Inkscape, but you can PR your if you need. It is simple, you just need to extend BaseConverter

    To create PNG converter you need to import it

    const InkscapeConverter = require("@vkontakte/sprites/src/convert/InkscapeConverter")

    Then create new instance of Converter

    const converter = new InkscapeConverter([1, 2], pngPath, "/opt/local/bin/inkscape"),

    And use as param for generating sprites

    Keywords

    none

    Install

    npm i @vkontakte/sprites

    DownloadsWeekly Downloads

    3

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    229 kB

    Total Files

    83

    Last publish

    Collaborators

    • k.egor.smirnov
    • nekr
    • fedorov.xyz
    • vkcom-publisher