Skip to content

Latest commit

 

History

History
112 lines (74 loc) · 3.82 KB

README.md

File metadata and controls

112 lines (74 loc) · 3.82 KB
Raw

Rx2Animations

Download API

RxAnimations is a library with the main goal to make android animations more solid and cohesive.

Download

  compile 'oxim.digital:rx2anim:0.9.1'
    
  compile 'io.reactivex.rxjava2:rxandroid:2.0.1'
  compile 'io.reactivex.rxjava2:rxjava:2.0.6'

RxJava version compatibility:

This Rx2Animations library is only compatible with rxJava 2.

If you are searching for the one compatible with rxJava 1, take a look over here.

Usage

A sample project which provides code examples that demonstrate uses of the classes in this project is available in the sample-app/ folder.

True power of this library is the ability to use animations as an observable asynchronous action.
That enables us to apply regular rxJava APIs on the animations.

It provides a couple of classes such as RxValueAnimator, RxValueObservable and RxAnimationBuilder.
Moreover, it also provides many regulary used animation methods (static import) such as fadeIn(), fadeOut(), slideIn(), leave() etc.

Examples:

  • Animating multiple views together
        animateTogether(fadeIn(firstView),
                        fadeIn(secondView));
  • Chaining multiple animations seamlessly
        fadeIn(firstView)
            .concatWith(fadeIn(secondView));
  • Simple ValueAnimator usage with RxValueAnimator
        final ValueAnimator opacityAnimator = ValueAnimator.ofFloat(0.f, 1.f);
        RxValueAnimator.from(opacityAnimator, animator -> view.setAlpha((float)animator.getAnimatedValue()))
  • Animating multiple values together with RxValueObservable
        xObservableAnimator = RxValueObservable.from(xAnimator);
        yObservableAnimator = RxValueObservable.from(yAnimator);
        
        Observable.combineLatest(xObservableAnimator.subscribe(),
                                 yObservableAnimator.subscribe(),
                                 (first, second) -> new Pair(first, second))
                  .subscribe(this::updateView);
  • Defining custom animations with RxAnimationBuilder
        RxAnimationBuilder.animate(view, DURATION)
                          .interpolator(INTERPOLATOR)
                          .fadeIn()
                          .rotate(DEGREES)
                          .translateBy(X, Y)
                          ...
                          .schedule([ | false]);

Animation created with RxAnimationBuilder automatically pretransforms the view, if not set otherwise.
I.e. if fadeIn() is called, views opacity will be set to 0.f before animation starts.

Managing animations

Starting animation - Every animation chain is started when we subscribe to it.
Ending animation - Animations can be easily stopped by unsubscribing animation subscription.

LICENSE

Copyright 2016 Mihael Franceković

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.