vcf-svg - Vaadin Add-on Directory
Web component for manipulating and animating SVG.# <vcf-svg>
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![npm version](https://badgen.net/npm/v/@vaadin-component-factory/vcf-svg)](https://www.npmjs.com/package/@vaadin-component-factory/vcf-svg)
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadin-component-factoryvcf-svg)
Web Component for manipulating and animating [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG).
- Web Component wrapper for the JS library [SVG.js](https://svgjs.com/docs/3.0).
- Zoom and pan functionality implemented with [d3-zoom](https://github.com/d3/d3-zoom).
- Draggable functionality implemented with plugin [svg.draggable.js](https://github.com/svgdotjs/svg.draggable.js).
[Live demo ↗](https://vcf-svg.netlify.com)
|
[API documentation ↗](https://vcf-svg.netlify.com/api/#/elements/Vaadin.VcfSvg)
## Installation
Install `vcf-svg`:
```sh
npm i @vaadin-component-factory/vcf-svg --save
```
## Usage
Once installed, import it in your application:
```js
import '@vaadin-component-factory/vcf-svg';
```
Add `` element to the page.
```html
```
## Running demo
1. Fork the `vcf-svg` repository and clone it locally.
1. Make sure you have [npm](https://www.npmjs.com/) installed.
1. When in the `vcf-svg` directory, run `npm install` to install dependencies.
1. 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: https://vaadin.com/directory/component/svg-component
## Vaadin Prime
This component is available in the Vaadin Prime subscription. It is still open source, but you need to have a valid CVAL license in order to use it. Read more at: https://vaadin.com/pricing
## License
Commercial Vaadin Add-on License version 3 (CVALv3). For license terms, see LICENSE.
Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see: https://github.com/vaadin/vaadin-usage-statistics