Giter Club home page Giter Club logo

pixi-svg-graphics's Introduction

PIXI-SVG-Graphics

This module can draw SVG documents on PIXI.js's Graphics object, making them scaleable and crisp. The code originates from saschagehlich/pixi-svg-graphics but is API wise incompatible and refactored quite a bit.

Usage:

Install the module (yarn install pixi-vector-graphics)

var svg = document.querySelector('svg#MySVGTag')
var SVGGraphics = require('pixi-vector-graphics')
var graphics = new SVGGraphics(svg);

Or include pixi-svg-graphics.min.js in your HTML:

<script src="pixi-svg-graphics.min.js"></script>

The module is then available using window.SVGGraphics

Supported Tags:

  • <svg>
  • <style>
  • <g>
  • <text>
  • <line>
  • <polyline>
  • <circle>
  • <ellipse>
  • <rect> (no rounded corners supported)
  • <polygon>
  • <path> (points that are too close together, like less than 1 pixel until a few pixels, can lead to graphic errors)

Supported Attributes:

  • class
  • style
  • fill
  • stroke
  • stroke-width
  • stroke-dasharray
  • vector-effect
  • transform (only supported for transforming the whole SVG):
    • matrix
    • translate
    • scale
    • rotate
    • not supported: skewX, skewY
  • d (<path> only):
    • M (move to)
    • L (line to)
    • C (curve to)
    • V (vertical line to)
    • H (horizontal line to)
    • S (bezier curve to)
    • Z (close path)

Test:

In order to test the library you need a browserstack account and have inkscape installed. First create a '.browserstack.json' in your home folder. Fill it with your credentials. Then you can run 'run_tests.py'. This will automatically start an nginx server, convert all test images inside 'test/src' to png's using inkscape and will then compare these png's with png's, which are created through browserstack. Afterwards it will run an image comparison tool.

Todos:

  • Add font formating support

pixi-svg-graphics's People

Contributors

bfriedrichs avatar fabianelsmer avatar florianludwig avatar marfri avatar mikebarkmin avatar saschagehlich 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.