scratchfoundationscratch-svg-renderer
⚠️ NOTICE: Repository Migration to Mono-Repo ⚠️
The Scratch Team has migrated the scratch-svg-renderer module into a new mono-repo,
scratch-editor. This independent scratch-svg-renderer
repository will be archived. Any new issues or pull requests should be opened in the mono-repo.
The new mono-repo version of scratch-svg-renderer is published to the NPM registry as
@scratch/scratch-svg-renderer.
Contributors:
- I would like to thank all past contributors for their work on this repository.
- If you are aware of valuable issues or pull requests, please consider re-opening them in the mono-repo. If you do so, please link the new issue or pull request to the original one in this repository to help others find it and to reduce the chance of duplicate work.
- We apologize for the inconvenience and greatly appreciate your help with this transition!
For more information, see the scratch-editor repository on GitHub.
Overview
A class built for importing SVGs into Scratch. Imports an SVG string to a DOM element or an HTML canvas. Handles some of the quirks with Scratch 2.0 SVGs, which sometimes misreport their width, height and view box.
Installation
This requires you to have Git and Node.js installed.
To install as a dependency for your own application:
npm install scratch-svg-rendererTo set up a development environment to edit scratch-svg-renderer yourself:
git clone https://github.com/scratchfoundation/scratch-svg-renderer.git
cd scratch-svg-renderer
npm installHow to include in a Node.js App
import SvgRenderer from 'scratch-svg-renderer';
const svgRenderer = new SvgRenderer();
const svgData = "<svg>...</svg>";
const scale = 1;
const quirksMode = false; // If true, emulate Scratch 2.0 SVG rendering "quirks"
function doSomethingWith(canvas) {...};
svgRenderer.loadSVG(svgData, quirksMode, () => {
svgRenderer.draw(scale);
doSomethingWith(svgRenderer.canvas);
});How to run locally as part of scratch-gui
To run scratch-svg-renderer locally as part of scratch-gui, for development:
- Set up local repositories (or pull updated code):
- scratch-svg-renderer (this repo)
- scratch-render
- scratch-paint
- scratch-gui
- In each of the local repos above, run
npm install - Run
npm linkin each of these local repos:- scratch-svg-renderer
- scratch-render
- scratch-paint
- Run
npm link scratch-svg-rendererin each of these local repos:- scratch-render
- scratch-paint
- scratch-gui
- In your local scratch-gui repo:
- run
npm link scratch-render - run
npm link scratch-paint
- run
- In scratch-gui, follow its instructions to run it or build its code
Donate
We provide Scratch free of charge, and want to keep it that way! Please consider making a donation to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you!
Committing
This project uses semantic release to ensure version bumps follow semver so that projects depending on it don't break unexpectedly.
In order to automatically determine version updates, semantic release expects commit messages to follow the conventional-changelog specification.
You can use the commitizen CLI to make commits formatted in this way:
npm install -g commitizen@latest cz-conventional-changelog@latestNow you're ready to make commits using git cz.