react-adobe-animate

React component that helps embed Adobe Animate's animations into your project.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-adobe-animate
2853.1.0a year ago6 years agoMinified + gzip package size for react-adobe-animate in KB

Readme

Adobe Animate React component

npm npm npm Snyk Vulnerabilities for GitHub Repo semantic-release Commitizen friendly
The component for embedding animations from Adobe Animate.

Table of contents
    <li><a href="#installation">Installation</a></li>
    <li><a href="#examples">Examples</a></li>
    <li><a href="#dependencies">Dependencies</a></li>
    <li><a href="#how-to-use">How to use</a>
    <ul>
      <li><a href="#nextjs">Next.js</a></li>
      <li><a href="#props">Props</a></li>
      <li><a href="#faq">FAQ</a></li>
    </ul>
    </li>
    <li><a href="#-questions">🙋‍♂️ Questions</a></li>
    <li><a href="#-contributing">🤝 Contributing</a></li>
    <li><a href="#show-your-support">Show your support</a></li>
    <li><a href="#-license">📝 License</a></li>

Installation

npm install react-adobe-animate
# or
yarn add react-adobe-animate

Examples

Dependencies

  • React
  • CreateJS – add this to your page <script src="https://code.createjs.com/1.0.0/createjs.min.js"></script>
  • Your animation – add .js file exported from Adobe Animate to page with <script> tag

How to use

index.html

In your index.html file you should import CreateJS and any other animation js file. Note that this should be done before import of your main jsx file to ensure that they are loaded before React script is executed.
<!DOCTYPE html>
<html lang="en">
  <head>
    <title>React Adobe Animate example</title>
  </head>
  <body>
    <div id="root"></div>
    <script src="https://code.createjs.com/1.0.0/createjs.min.js" type="text/javascript"></script>
    <script src="./lishtml5-with-background.js" type="text/javascript"></script>
    <script src="./lishtml5.js" type="text/javascript"></script>
    <script src="/src/your-main-react-file.jsx"></script>
  </body>
</html>

App.tsx

react-adobe-animate exposes a AnimateCC component used to render the animation. For more details on the props passed to the component please see Props.
import { useState } from "react";
import { AnimateCC, GetAnimationObjectParameter } from "react-adobe-animate";

const App = () => {
  const [paused, setPaused] = useState(true);
  const [animationObject, getAnimationObject] = useState<GetAnimationObjectParameter|null>(null);
  const onClick = () => setPaused(!paused);

  console.log(animationObject);

  return (
    <div style={{ width: "400px" }}>
      <AnimateCC
        animationName="lishtml5"
        getAnimationObject={getAnimationObject}
        paused={paused}
      />

      <AnimateCC
        animationName="lishtml5"
        composition="C1475B64B160904BB90B34246A5FF54B"
        paused={paused}
      />

      <button onClick={onClick}>{paused ? "Unpause" : "Pause"}</button><br />
    </div>
  );
};

Next.js

To use the component with Next.js you have to include CreateJS and Animate files (you have to put those into public folder first) with the Script component.
For detailed example see examples/next/pages/index.tsx.

Props

| Prop name | Type | Required | Description | | ------------------ | -------- | -------- | ------------ | | animationName | string | true | Name of animation (exportRoot = new lib.animationName(); in js file. There the name is (lib.animationName = function. Also usually name of published file) | | composition | string | false | If you have two animations with same name you can specify an id of that animation. You can get it from .html file generate by Adobe Animate (var comp=AdobeAn.getComposition("C1475B64B160904BB90B34246A5FF54B");) | | getAnimationObject | function | false | It is fired after component was mounted. It takes 1 argument – animation object that enables you to fire functions created in Adobe Animate | | paused | boolean | false | Whether an animation should be paused | | onError | function | false | Function called whenever an error is thrown inside the component |
All other props will be passed to div surrounding canvas

FAQ

How do I insert animations published from the same file?

Unfortunately it isn't possible to export from Adobe Animate two unique animations. However you can make one! Simply replace all occurrences of composition id inside your .js file of an animation to one created by you. Composition id is this long string in var comp=AdobeAn.getComposition("C1475B64B160904BB90B34246A5FF54B"); found in .html file published by Adobe Animate.

🙋‍♂️ Questions

Should you have any questions on how to use/setup the component feel free to ask you questions on the discussions page.

🤝 Contributing

Contributions, issues and feature requests are welcome!\ Feel free to check issues page.
For development purposes you can use the examples folder. \ You'll find instructions on how to use it in examples/README.md

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019-2022 bibixx .
This project is MIT licensed.