An library to help android developers working easly with activities and fragments (Kotlin version)

Related tags

App AFM
Overview

AFM

Download Build Status APILicense: MIT Awesome Kotlin Badge

An library to help android developer working easly with activities and fragments (Kotlin)

Motivation

  • Accelerate the process and abstract the logic of opening, adding and replacing fragments in an activity;
  • Reduce the number of activities declared in the project;
  • Get access to Activity::onBackPressed() inside of the fragments.
  • Add animated transitions between fragments in an easy way;
  • Easy way to work with shared elements;
An animated GIF showing navigation flow An animated GIF showing shared elements working An animated GIF showing onbackpressed working

Download

To use the AFM, add the compile dependency with the latest version.

Gradle

Add the AFM to your build.gradle:

dependencies {
    compile 'com.massivedisaster:afm:0.0.1'
}

Maven

In the pom.xml file:

<dependency>
    <groupId>com.massivedisaster</groupId>
    <artifactId>afm</artifactId>
    <version>0.0.1</version>
</dependency>

Usage

1. Create your Activity

Create a new activity and extends the BaseActivity.

class ActivityPrimaryTheme : BaseActivity() {

    // The layout resource you want to find the FrameLayout.
    override fun layoutToInflate(): Int {
        return R.layout.activity_fullscreen
    }

    // The FrameLayout id you want to inject the fragments.
    override fun getContainerViewId(): Int {
        return R.id.frmContainer
    }
}

Create the layout to be used by your AbstractFragmentActivity.

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/frmContainer"
    android:layout_width="match_parent"
    android:layout_height="match_parent"/>

2. Opening, adding or replacing fragments in your AbstractFragmentActivity.

Open a new AbstractFragmentActivity with a fragment.

ActivityCall.init(context, ActivityPrimaryTheme::class, FragmentExample::class)
                .build()

Add a new Fragment in the actual AbstractFragmentActivity.

FragmentCall.init(activity, FragmentExample::class)
                .build()

Replace a new Fragment in the actual AbstractFragmentActivity.

FragmentCall.init(activity as BaseActivity, FragmentExample::class)
                .setTransitionType(FragmentCall.TransitionType.REPLACE)
                .build()

3. Default Fragment

You can set a default fragment in you BaseActivity. An example, if your BaseActivity is started by an external intent you need to define a default fragment.

class ActivityPrimaryTheme : BaseActivity() {
    ...

    override fun getDefaultFragment(): KClass<out Fragment>? {
        return FragmentSplash::class
    }
}

4. Fragment Transaction Animations.

When you add or replace fragments in the old way you can set a custom animations for the transactions. So, you can set custom animation in easly way using this library.

Single Transaction Animation

If you want to add a single animation only for one transaction you can do this:

FragmentCall.init(activity as BaseActivity, FragmentAddReplace::class)
    .setTransitionType(FragmentCall.TransitionType.ADD)
    .setTransactionAnimation(object : TransactionAnimation {
        override val animationEnter: Int
            get() = R.anim.enter_from_right

        override val animationExit: Int
            get() = R.anim.exit_from_left

        override val animationPopEnter: Int
            get() = R.anim.pop_enter

        override val animationPopExit: Int
            get() = R.anim.pop_exit
    }).build()

Attention: This only works in transactions between fragments, i.e. add and replace

Custom animation for all transactions.

If you want to add a custom animation for all transactions inside of a AbstractFragmentActivity you can override the follow methods:

abstract class ActivityPrimaryTheme : BaseActivity() {

    ...

    override val animationEnter: Int
        get() = android.R.anim.fade_in

    override val animationExit: Int
        get() = android.R.anim.fade_out

    override val animationPopEnter: Int
        get() = android.R.anim.fade_in

    override val animationPopExit: Int
        get() = android.R.anim.fade_out

}

5. Shared Elements

If you want to make your app beautiful you need to put some cool animation on it! Shared elements are introduce in API 21 and makes the transactions so great and sweet. So, now it's very easy to share elements between fragments or activities. Let's take a look:

Activity A

...
.addSharedElement(view, "sharedElement")
...
.build()

Activity B

ViewCompat.setTransitionName(view, "sharedElement")

or

<View
  ...
  android:transitionName="sharedElement" />

Attention: Shared elements doesn't work when you use add! Well if you remove the first fragment it's possible, i.e. a replace :)

6. Custom Intents

Sometimes you want to add more information to the Intent or set some flags. You can use the follow method to open a new BaseActivity:

.setFlags(flags)

7. Fragment#OnBackPressed

Allows to have back pressed events in Fragments.

class FragmentOnBackPressed : Fragment(), OnBackPressedListener {

    ...

    @Override
    override fun onBackPressed(): Boolean {
      // Do what you want here! If you return true the activity will not process the OnBackPressed
    }

}

Goodies

  • You can pass a tag to be applied in the Fragment.
  • You can pass REQUEST_CODE to the startActivityForResult.
  • You can addToBackStack.
  • You can pass data between fragments using a Bundle.
  • You can get access to the original FragmentTransaction.
  • You can use DataBinding in your DataBindingBaseActivity, all you need is override initializeDataBinding() and bind the view!

Sample

Sample app can be found in the sample module. Alternatively, you can use dryrun to run the sample.

The Sample app don't require any configuration to interact.

Contributing

CONTRIBUTING

License

MIT LICENSE

You might also like...
Screenshot Kata for Android Developers with Kotlin. The main goal is to practice UI Screenshot Testing.
Screenshot Kata for Android Developers with Kotlin. The main goal is to practice UI Screenshot Testing.

KataScreenshot in Kotlin We are here to practice UI testing using screenshot tests for Android. We are going to use Espresso to interact with the Appl

Super Heroes Kata for Android Developers in Kotlin. The main goal is to practice UI Testing.
Super Heroes Kata for Android Developers in Kotlin. The main goal is to practice UI Testing.

KataSuperHeroes in Kotlin We are here to practice UI Testing. We are going to use Espresso to interact with the Application UI. We are going to use Ko

Maxibon kata for Kotlin Developers. The main goal is to practice property based testing.
Maxibon kata for Kotlin Developers. The main goal is to practice property based testing.

Kata Maxibon for Kotlin. We are here to practice property based testing. We are going to use KotlinTest to write our tests. We are going to practice p

TODO API Client Kata for Kotlin Developers. The main goal is to practice integration testing using MockWebServer
TODO API Client Kata for Kotlin Developers. The main goal is to practice integration testing using MockWebServer

KataTODOApiClient for Kotlin We are here to practice integration testsing using HTTP stubbing. We are going to use MockWebServer to simulate a HTTP se

Do's and Don'ts for Android development, by Futurice developers
Do's and Don'ts for Android development, by Futurice developers

Best practices in Android development Avoid reinventing the wheel by following these guidelines. Lessons learned from Android developers in Futurice.

StaCoAn is a crossplatform tool which aids developers, bugbounty hunters and ethical hackers performing static code analysis on mobile applications.
StaCoAn is a crossplatform tool which aids developers, bugbounty hunters and ethical hackers performing static code analysis on mobile applications.

StaCoAn Not maintained anymore! Will be archived soon. StaCoAn is a crossplatform tool which aids developers, bugbounty hunters and ethical hackers pe

Dev Experience is a set of projects to make life easier for developers, in order to import, configure and use.

Dev Experience The experience that all developer need Dev Experience is a set of projects to make life easier for developers, in order to import, conf

An unofficial version of the Android library for the Muse EEG headset

libmuse NOTE: This is an unofficial version of the Android library for interfacing with the Muse EEG headset. The Muse headset is a research-grade, lo

Forage-project - This is a project given by Google Android Developers team. It's specifically created for data persistance.

Forage - Starter Code Starter code for the fifth independent project for Android Basics in Kotlin. This project pairs with Unit 5 of Android Basics in

Owner
Massive Disaster
Massive Disaster
This application is purpose to help user create todo activities.

To Do This application is purpose to help user create todo activities. Download App Features List Tasks Sort Tasks Add, Update and Delete Task Clean a

Fikky Ardianto 2 Aug 31, 2022
DessertPusher - A dessert app displaying the functionalities of activity lifecycle and fragments

Activity Lifecycle - DessertPusher This is the toy app for lesson 4 of the Andro

Brian Kubai 0 Jan 18, 2022
Help-page-finder - Help page finder for android

help-page-finder This app allows to search for help articles on a website. It is

null 0 Feb 13, 2022
Android Package Inspector - dynamic analysis with api hooks, start unexported activities and more. (Xposed Module)

Inspeckage - Android Package Inspector Inspeckage is a tool developed to offer dynamic analysis of Android applications. By applying hooks to function

acpm 2.5k Jan 8, 2023
App consist of 4 main fragments accessable from bottom navigation

Bug demo Demo App consist of 4 main fragments accessable from bottom navigation, each fragment is a tablayout hosting 2 more child fragment, child fra

Babish 0 Nov 21, 2021
AnyText - An Xposed module trying to hook TextView in any activities

AnyText What's this This application provides features to modify any TextView in

Leonardo 41 Nov 30, 2022
Android app built with MVP architectural approach and uses Marvel Comics API that allows developers everywhere to access information about Marvel's vast library of comics. :zap:

Villains & Heroes Android app built with MVP architectural approach and uses Marvel Comics API that allows developers everywhere to access information

André Mion 53 Jul 13, 2022
Unity-Android-SDK-Plugins - Android SDK/Library/Plugins (aar) for Unity Developers

Unity Android SDK Plugins Unity Android SDK Plugins is an Open Source project th

NNK 1 Aug 14, 2022
Changelog - a android library, it helps developers display the history of changes in their applications

Changelog is a android library, it helps developers display the history of changes in their applications. Supports Locales, Layout direction

Amirhosein Barati 2 Aug 1, 2022