Skip to content

Latest commit

 

History

History
108 lines (81 loc) · 2.58 KB

README.md

File metadata and controls

108 lines (81 loc) · 2.58 KB

AnimateFX CI Maven Central javadoc JFXCentral License

AnimateFX

A library of ready-to-use animations for JavaFX

Features:

  • Custom animations
  • Custom interpolators
  • Play/Stop animation
  • Play an animation after another
  • More to come

Installation

Gradle (7.x)

plugins {
    ...
    id 'java-library'
}

dependencies {
    api 'io.github.typhon0:AnimateFX:1.3.0'
}

Maven

<dependency>
  <groupId>io.github.typhon0</groupId>
  <artifactId>AnimateFX</artifactId>
  <version>1.3.0</version>
  <type>pom</type>
</dependency>

Snapshot

Gradle (7.x)

plugins {
    ...
    id 'java-library'
}

repositories {
	maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
}

dependencies {
    api 'io.github.typhon0:AnimateFX:1.3.0-SNAPSHOT'
}

Maven

 <repositories>
 	<repository>
            <id>snapshots</id>
            <name>libs-snapshot</name>
            <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
        </repository>
    </repositories>

 <dependencies>
        <dependency>
            <groupId>io.github.typhon0</groupId>
            <artifactId>AnimateFX</artifactId>
            <version>1.3.0-SNAPSHOT</version>
        </dependency>
 </dependencies>

Quick start

Basic

Text text = new Text("AnimateFX");
new Bounce(text).play();

Play an animation after another

    Text text = new Text("AnimateFX");
    public void HandleAnimation(ActionEvent actionEvent) {
      new Bounce(text).setPlayOnFinished(new BounceIn(text)).play();
      }

Contributing

Please see CONTRIBUTING.md for more information.

Credits

Animations are inspired from the awesome project Animate.css