refactor: refactor to TypeScript

Author: Rui Chen

dist/svg-text-animate.es.js

@@ -0,0 +1,3 @@
+import type { AnimationOptions, StrokeOptions } from '../types';
+export declare const DEFAULT_OPTIONS: Required<AnimationOptions>;
+export declare const DEFAULT_STROKE: Required<StrokeOptions>;

dist/svg-text-animate.es.js.map

@@ -0,0 +1,63 @@
+import type { AnimationOptions } from '../types';
+/**
+ * Abstract class for animation creators
+ * @abstract
+ */
+export default abstract class AnimationCreator {
+    protected options: Required<AnimationOptions>;
+    protected svgDom: SVGSVGElement | null;
+    protected paths: NodeListOf<SVGPathElement> | null;
+    /**
+     * Creates an instance of AnimationCreator.
+     * @param options - Animation options
+     */
+    constructor(options?: AnimationOptions);
+    /**
+     * Set the svgDom
+     * @param svgDom - SVG DOM element
+     */
+    setSVGDom(svgDom: SVGSVGElement): void;
+    /**
+     * Set animation options
+     * @param options - Animation options
+     * @returns Current instance
+     */
+    setOptions(options?: AnimationOptions): this;
+    /**
+     * Animate each path
+     */
+    setAllPathsAnimation(): void;
+    /**
+     * Set the path stroke
+     * @param path - SVG path element
+     */
+    setPathStroke(path: SVGPathElement): void;
+    /**
+     * Function to set the SVG animation
+     * Must be implemented in the inheritance class
+     * @abstract
+     */
+    abstract setSVGAnimation(): void;
+    /**
+     * Function to set the path animation
+     * Must be implemented in the inheritance class
+     * @abstract
+     * @param path - SVG path element
+     * @param i - Index of paths
+     */
+    abstract setPathAnimation(path: SVGPathElement, i: number): void;
+    /**
+     * Function to format Options, using default options
+     * Must be implemented in the inheritance class
+     * @abstract
+     * @param options - Options to format
+     * @returns Formatted options
+     */
+    abstract formatOptions(options: AnimationOptions | Required<AnimationOptions>): AnimationOptions | Required<AnimationOptions>;
+    /**
+     * Create animated SVG
+     * @param svgDom - SVG DOM element
+     * @returns Animated svgDom
+     */
+    create(svgDom: SVGSVGElement): SVGSVGElement;
+}

dist/svg-text-animate.es.min.js

@@ -0,0 +1,29 @@
+import AnimationCreator from './AnimationCreator';
+import type { AnimationOptions } from '../types';
+/**
+ * CSS-based animation creator
+ * @extends AnimationCreator
+ */
+export default class CSSCreator extends AnimationCreator {
+    /**
+     * Creates an instance of CSSCreator.
+     * @param options - Animation options
+     */
+    constructor(options?: AnimationOptions);
+    /**
+     * Function to set the SVG animation, using CSS animation
+     */
+    setSVGAnimation(): void;
+    /**
+     * Function to set the path animation, using CSS animation
+     * @param path - SVG path element
+     * @param i - Index of paths
+     */
+    setPathAnimation(path: SVGPathElement, i: number): void;
+    /**
+     * Function to format Options, using default options
+     * @param options - Options of creator
+     * @returns Formatted options
+     */
+    formatOptions(options: AnimationOptions | Required<AnimationOptions>): AnimationOptions | Required<AnimationOptions>;
+}

dist/svg-text-animate.js

@@ -0,0 +1,29 @@
+import AnimationCreator from './AnimationCreator';
+import type { AnimationOptions } from '../types';
+/**
+ * SVG-based animation creator
+ * @extends AnimationCreator
+ */
+export default class SVGCreator extends AnimationCreator {
+    /**
+     * Creates an instance of SVGCreator.
+     * @param options - Animation options
+     */
+    constructor(options?: AnimationOptions);
+    /**
+     * Function to set the SVG animation, using SVG animate elements
+     */
+    setSVGAnimation(): void;
+    /**
+     * Function to set the path animation, using SVG animate elements
+     * @param path - SVG path element
+     * @param i - Index of paths
+     */
+    setPathAnimation(path: SVGPathElement, i: number): void;
+    /**
+     * Function to format Options, using default options
+     * @param options - Options of creator
+     * @returns Formatted options
+     */
+    formatOptions(options: AnimationOptions | Required<AnimationOptions>): AnimationOptions | Required<AnimationOptions>;
+}