Conductor

A small, yet full-featured framework that allows building View-based Android applications. Conductor provides a light-weight wrapper around standard Android Views that does just about everything you'd want:

| | Conductor | |-----------|-------------| :tada: | Easy integration :pointup: | Single Activity apps without using Fragments :recycle: | Simple but powerful lifecycle management :train: | Navigation and backstack handling :twistedrightwardsarrows: | Beautiful transitions between views :floppydisk: | State persistence :phone: | Callbacks for onActivityResult, onRequestPermissionsResult, etc :europeanpostoffice: | MVP / MVVM / MVI / VIPER / MVC ready

Conductor is architecture-agnostic and does not try to force any design decisions on the developer. We here at BlueLine Labs tend to use either MVP or MVVM, but it would work equally well with standard MVC or whatever else you want to throw at it.

Installation

implementation 'com.bluelinelabs:conductor:3.1.1'

// AndroidX Transition change handlers:
implementation 'com.bluelinelabs:conductor-androidx-transition:3.1.1'
// ViewPager PagerAdapter:
implementation 'com.bluelinelabs:conductor-viewpager:3.1.1'
// ViewPager2 Adapter:
implementation 'com.bluelinelabs:conductor-viewpager2:3.1.1'
// RxJava2 Autodispose support:
implementation 'com.bluelinelabs:conductor-autodispose:3.1.1'
// Lifecycle-aware Controllers (architecture components):
implementation 'com.bluelinelabs:conductor-archlifecycle:3.1.1'

SNAPSHOT

Just use

3.1.2-SNAPSHOT

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

Components to Know

| | Conductor Components | ------|------------------------------ Controller | The Controller is the View wrapper that will give you all of your lifecycle management features. Think of it as a lighter-weight and more predictable Fragment alternative with an easier to manage lifecycle. Router | A Router implements navigation and backstack handling for Controllers. Router objects are attached to Activity/containing ViewGroup pairs. Routers do not directly render or push Views to the container ViewGroup, but instead defer this responsibility to the ControllerChangeHandler specified in a given transaction. ControllerChangeHandler | ControllerChangeHandlers are responsible for swapping the View for one Controller to the View of another. They can be useful for performing animations and transitions between Controllers. Several default ControllerChangeHandlers are included. RouterTransaction | Transactions are used to define data about adding Controllers. RouterTransactions are used to push a Controller to a Router with specified ControllerChangeHandlers, while ChildControllerTransactions are used to add child Controllers.

Getting Started

Minimal Activity implementation

public class MainActivity extends Activity {

private Router router;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    setContentView(R.layout.activity_main);

    ViewGroup container = (ViewGroup) findViewById(R.id.controller_container);

    router = Conductor.attachRouter(this, container, savedInstanceState);
    if (!router.hasRootController()) {
        router.setRoot(RouterTransaction.with(new HomeController()));
    }
}

@Override
public void onBackPressed() {
    if (!router.handleBack()) {
        super.onBackPressed();
    }
}
}

Minimal Controller implementation

public class HomeController extends Controller {

@Override
protected View onCreateView(@NonNull LayoutInflater inflater, @NonNull ViewGroup container, @Nullable Bundle savedViewState) {
    View view = inflater.inflate(R.layout.controller_home, container, false);
    ((TextView) view.findViewById(R.id.tv_title)).setText("Hello World");
    return view;
}
}

Sample Project

Demo app - Shows how to use all basic and most advanced functions of Conductor.

Controller Lifecycle

The lifecycle of a Controller is significantly simpler to understand than that of a Fragment. A lifecycle diagram is shown below:

Advanced Topics

Retain View Modes

setRetainViewMode

Controller

RELEASE_DETACH

Controller

RETAIN_DETACH

Controller

Custom Change Handlers

ControllerChangeHandler

Controllers

ControllerChangeHandler

AnimatorChangeHandler

Animator

TransitionChangeHandler

Transition

Child Routers & Controllers

getChildRouter

Controller

Router

Controller

RxJava Lifecycle

If the AutoDispose dependency has been added, there is a

ControllerScopeProvider

Community Projects

The community has provided several helpful modules to make developing apps with Conductor even easier. Here's a collection of helpful libraries:

• ConductorGlide - Adds Glide lifecycle support to Controllers
• ConductorDialog - Adds a helpful DialogController (a Conductor version of DialogFragment)
• Mosby-Conductor - A plugin to integrate Mosby, an MVP/MVI library

License

Copyright 2020 BlueLine Labs, Inc.

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.