Skip to content

canvg/canvg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

937668e · Apr 22, 2024
Apr 22, 2024
Apr 22, 2024
May 4, 2022
Apr 22, 2024
Apr 22, 2024
Feb 15, 2022
Apr 22, 2024
Feb 16, 2022
Feb 7, 2022
Feb 7, 2022
Feb 7, 2022
May 15, 2020
Feb 18, 2022
Oct 2, 2019
Feb 7, 2022
Jul 19, 2022
Feb 7, 2022
Feb 15, 2022
Apr 22, 2024
Oct 22, 2019
Feb 13, 2023
Feb 8, 2022
Oct 25, 2019
Apr 22, 2024
Apr 22, 2024
Feb 18, 2022
Feb 18, 2022

Repository files navigation

canvg

Logo

NPM version Dependencies status Build status Coverage status

JavaScript SVG parser and renderer on Canvas. It takes the URL to the SVG file or the text of the SVG file, parses it in JavaScript and renders the result on Canvas. It also can be used to rasterize SVG images.

Quickstart   •   Docs   •   Demo


Quickstart

Install this library using your favorite package manager:

pnpm add canvg
# or
yarn add canvg
# or
npm i canvg

Then, just import Canvg and use it:

import { Canvg } from 'canvg';

let v = null;

window.onload = async () => {
  const canvas = document.querySelector('canvas');
  const ctx = canvas.getContext('2d');

  v = await Canvg.from(ctx, './svgs/1.svg');

  // Start SVG rendering with animations and mouse handling.
  v.start();
};

window.onbeforeunload = () => {
  v.stop();
};

Description of all exports you can find in Documentation.


Docs

What's implemented?

The end goal is everything from the SVG spec. The majority of the rendering and animation is working. If you would like to see a feature implemented, don't hesitate to add it to the issues list, or better is to create pull request 😎