img-to-svg

Convert the image pixels in SVG squares.

Usage no npm install needed!

<script type="module">
  import imgToSvg from 'https://cdn.skypack.dev/img-to-svg';
</script>

README

img-to-svg

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

Convert the image pixels in SVG squares.

This parse the image pixels, image-to-ascii is used.

img-to-svg

:cloud: Installation

# Using npm
npm install --save img-to-svg

# Using yarn
yarn add img-to-svg

:clipboard: Example

const imgToSvg = require("img-to-svg");

imgToSvg("https://octodex.github.com/images/jetpacktocat.png", (err, out) => {
    console.log(err || out);
    // <svg width="720" height="720"><rect x="0" y="0" width="10" height="10" fill="rgb(0, 0, 0)"></rect>
    // <rect x="12" y="0" width="10" height="10" fill="rgb(0, 0, 0)"></rect>
    // <rect x="24" y="0" width="10" height="10" fill="rgb(0, 0, 0)"></rect>
    // ...
    // <rect x="696" y="708" width="10" height="10" fill="rgb(0, 0, 0)"></rect>
    // <rect x="708" y="708" width="10" height="10" fill="rgb(0, 0, 0)"></rect></svg>
});

:question: Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. :bug:
  3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

imgToSvg(path, opts, options, cb)

Convert the image pixels in SVG squares.

Params

  • String path: The image path.
  • Object opts: An object containing the following fields:
  • pxSize (Number): The square size.
  • margin (Number): The margin between squares.
  • Object options: The image-to-ascii options.
  • Function cb: The callback function.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like :rocket:

  • Buy me a book—I love books! I will remember you after years if you buy me one. :grin: :book:

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău