@donkeyclip/motorcortex-svgdraw
v1.2.0
Published
Progressively render any svg path up to any percent of it
Downloads
28
Readme
MotorCortex-svgdraw
Table of Contents
- MotorCortex-svgdraw
- Intro / Features
- Getting Started
- Creating Incidents
- Adding Incidents in your clip
- Contributing
- License
- Sponsored by
Demo
Intro / Features
The library provides the Draw effect which applies progressive rendering of svg paths. Just provide the target percentage (up to which length of the path you want to render) and the Effect will animate the svg path render up that point.
This Plugin exposes just one Incident:
- Draw
Getting Started
Installation
$ npm install --save @donkeyclip/motorcortex-svgdraw
# OR
$ yarn add @donkeyclip/motorcortex-svgdraw
Importing and loading
import { loadPlugin } from "@donkeyclip/motorcortex";
import SVGDDef from "@donkeyclip/motorcortex-svgdraw";
const SVGD = loadPlugin(SVGDDef);
Creating Incidents
Draw
Only svg path elements can be selected by Draw Effect. If you try to select any
element of other type you'll get error.
For each of the selected path
elements the Effect will draw from the current length
percentage of the path to the target, provided by the animated attribute cover
const draw = new SVGD.Draw({
animatedAttrs: {
cover: 1
}
}, {
selector: 'svg path',
duration: 2000
});
The Effect of the example will fully draw all selected paths in 2000 milliseconds.
Adding Incidents in your clip
clipName.addIncident(incidentName,startTime);
Contributing
In general, we follow the "fork-and-pull" Git workflow, so if you want to submit patches and additions you should follow the next steps:
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes