@vaadin-component-factory/vcf-svg

Web component wrapper for SVG.js.

Usage no npm install needed!

<script type="module">
  import vaadinComponentFactoryVcfSvg from 'https://cdn.skypack.dev/@vaadin-component-factory/vcf-svg';
</script>

README

<vcf-svg>

Gitter npm version Published on Vaadin Directory

Web Component for manipulating and animating SVG.

  • Web Component wrapper for the JS library SVG.js.
  • Zoom and pan functionality implemented with d3-zoom.
  • Draggable functionality implemented with plugin svg.draggable.js.

Screenshot 2020-06-11 at 15 34 34

Live demo ↗ | API documentation ↗

Installation

Install vcf-svg:

npm i @vaadin-component-factory/vcf-svg --save

Usage

Once installed, import it in your application:

import '@vaadin-component-factory/vcf-svg';

Add <vcf-svg> element to the page.

<vcf-svg zoomable>
  <svg viewbox="0 0 400 200">
    <rect x="0" y="0" width="100" height="100" draggable="true"></rect>
  </svg>
</vcf-svg>

Running demo

  1. Fork the vcf-svg repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vcf-svg directory, run npm install to install dependencies.

  4. Run npm start to open the demo.

Server-side API

This is the client-side (Polymer 3) web component. If you are looking for this web components server-side (Java) API for the Vaadin Platform, it can be found here: Svg Component

License & Author

This Add-on is distributed under Apache 2.0

Component Factory svg is written by Vaadin Ltd.

Sponsored development

Major pieces of development of this add-on has been sponsored by multiple customers of Vaadin. Read more about Expert on Demand at: Support and Pricing