gsap/types/draw-svg-plugin.d.ts

GSAP is a JavaScript library for building high-performance animations that work in **every** major browser. Animate CSS, SVG, canvas, React, Vue, WebGL, colors, strings, motion paths, generic objects...anything JavaScript can touch! The ScrollTrigger plug

declare namespace gsap {

  type DrawSVGTarget = string | SVGPrimitive | SVGPathElement;

  interface TweenVars {
    drawSVG?: BooleanValue | DrawSVGTarget;
  }
}

declare namespace gsap.plugins {

  interface DrawSVGPlugin extends Plugin {

    /**
     * Get the length of an SVG element's stroke.
     *
     * ```js
     * DrawSVGPlugin.getLength(element);
     * ```
     *
     * @param {DrawSVGTarget} element
     * @returns {number} The stroke length
     * @memberof DrawSVGPlugin
     */
    getLength(element: DrawSVGTarget): number;

    /**
     * Get the current position of the DrawSVG in array form.
     *
     * ```js
     * DrawSVGPlugin.getPosition(element);
     * ```
     *
     * @param {DrawSVGTarget} element
     * @returns {number[]} The position array
     * @memberof DrawSVGPlugin
     */
    getPosition(element: DrawSVGTarget): number[];
  }

  interface DrawSVGPluginClass extends DrawSVGPlugin {
    new(): PluginScope & DrawSVGPlugin;
    prototype: PluginScope & DrawSVGPlugin;
  }

  const drawSVG: DrawSVGPluginClass;
}

declare const DrawSVGPlugin: gsap.plugins.DrawSVGPlugin;

declare module "gsap/DrawSVGPlugin" {
  export const DrawSVGPlugin: gsap.plugins.DrawSVGPlugin;
  export { DrawSVGPlugin as default };
}

declare module "gsap/src/DrawSVGPlugin" {
  export * from "gsap/DrawSVGPlugin";
  export { DrawSVGPlugin as default } from "gsap/DrawSVGPlugin";
}

declare module "gsap/dist/DrawSVGPlugin" {
  export * from "gsap/DrawSVGPlugin";
  export { DrawSVGPlugin as default } from "gsap/DrawSVGPlugin";
}

declare module "gsap/all" {
  export * from "gsap/DrawSVGPlugin";
}