Git Product home page Git Product logo

sprites's Introduction

@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.48.5)

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

sprites's People

Watchers

James Cloos avatar Arthur Stolyar avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.