Skip to content

Latest commit

 

History

History
145 lines (101 loc) · 6.35 KB

README.md

File metadata and controls

145 lines (101 loc) · 6.35 KB
Raw

SVGEdit

npm Actions Status Known Vulnerabilities Total Alerts Code Quality: Javascript

SVGEdit is a fast, web-based, JavaScript-driven SVG drawing editor that works in any modern browser. SVGEdit is based on a powerful SVG canvas @svgedit/svgcanvas

screenshot

Contributions

SVGEdit is the most popular open source SVG editor. It was started more than 13 years ago by a fantastic team of developers. Unfortunately, the product was not maintained for a quite long period. We decided to give this tool a new life by refreshing many aspects.

Please let us know with an issue or a discussions if you wish to contribute.

I want to use SVGEdit

Thanks to Netlify, you can access the following builds from your favorite browser:

Try SVGEdit V7 (master branch on github)

Try SVGEdit V7 (latest published version on npm)

Prior V7:

We recommand using the V7 version but for older browsers or some abandoned features, you may need to access to old versions of SVGEdit.

Try SVGEdit 6.1.0 here Try SVGEdit 5.1.0 here

Additional tip: you may try a version released on NPM using unpkg for example with version 3.2.0: https://unpkg.com/[email protected]/editor/svg-editor.html

I want to host SVGEdit in my environment

If you want to host a local version of SVGEdit, please follow these instructions:

  1. Clone or copy the repository contents from github
  2. run npm i to install dependencies
  3. run npm run build --workspace @svgedit/svgcanvasto build the svgcanvas dependency locally
  4. to test, you can run npm run start to start a local server
  5. and access http://localhost:8000/src/editor/index.html with a supported browser
  6. run npm run build to build a bundle that you can serve from your own web server.

I want to contribute to SVGEdit

Thanks!

SVG-Edit is made of two major components:

  1. The "svgcanvas" that takes care of the underlying svg edition. It can be used to build your own editor.
  2. The "editor" that takes care of the editor UI (menus, buttons, etc.)

You should fork SVGEdit in your github environment and install locally SVGEdit as explained above. Before you submit your PR, please make sure you run locally:

  1. npm run lint to check that you follow the standardjs rules (https://standardjs.com/rules) for the linter
  2. npm run test to run a suite of Cypress tests (https://www.cypress.io/).

If you intend to contribute on a regular basis, let us know so we can add you in the maintainer team.

I want to integrate SVGEdit into my own Web application

V7 is changing significantly the way to integrate and customize SVG-Edit. You can have a look to index.html to see how you can insert a div element into your HTML code and inject the editor into the div.

<head>
   <!-- You need to include the CSS for SVGEdit somewhere in your application -->
  <link href="./svgedit.css" rel="stylesheet" media="all"></link>
</head>

<body>
  <!-- svgedit container can be positionned anywhere in the DOM
       but it must have a width and a height -->
  <div id="container" style="width:100%;height:100vh"></div>
</body>
<script type="module">
  /* You need to call the Editor and load it in the <div> */
  import Editor from './Editor.js'
  /* for available options see the file `docs/tutorials/ConfigOptions.md */
  const svgEditor = new Editor(document.getElementById('container'))
  /* initialize the Editor */
  svgEditor.init()
  /* set the configuration */
  svgEditor.setConfig({
          allowInitialUserOverride: true,
          extensions: [],
          noDefaultExtensions: false,
          userExtensions: []
  })
</script>
</html>

I want to build my own svg editor

You can just use the underlying canvas and use it in your application with your favorite framework. See example in the demos folder or the svg-edit-react repository.

To install the canvas:

npm i -s '@svgedit/svgcanvas'

you can then import it in your application:

import svgCanvas from '@svgedit/svgcanvas'

Supported browsers

Developments and Continuous Integration are done with a Chrome environment. Chrome, FireFox and Safari recent versions are supported (in the meaning that we will try to fix bugs for these browsers).

Support for old browsers may require to use an older version of the package. However, please open an issue if you need support for a specific version of your browser so the project team can decide if we should support with the latest version.

Sample extension based on React

A sample React component was used to build a svgedit extension. To activate:

  • "npm run build" from the extension folder "src/editor/react-extensions/react-test" in order to create the bundle for the extension.
  • modify "index.html" to activate the extension as a userExtensions
svgEditor.setConfig({
          allowInitialUserOverride: true,
          extensions: [],
          noDefaultExtensions: false,
          userExtensions: ['./react-extensions/react-test/dist/react-test.js']
        })

Further reading and more information

Hosting

SVGedit versions are deployed to: Deploys by Netlify