Skip to content
The simplest navigation library for Android.
Branch: master
Clone or download
Latest commit f690979 Apr 30, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
assets
checkstyle
gradle Refactor versions into gradle.properties file Apr 30, 2018
magellan-library
magellan-rx
magellan-rx2 Update rxjava dependencies Apr 30, 2018
magellan-sample-advanced Lint Apr 30, 2018
magellan-sample
magellan-support Lint Apr 30, 2018
.gitignore
.travis.yml Revert "Update travis config" May 1, 2018
CHANGELOG.md
LICENSE.txt Initial import Mar 30, 2017
README.md
RELEASING.md
build.gradle Refactor versions into gradle.properties file Apr 30, 2018
gradle.properties
gradlew
gradlew.bat
settings.gradle Merge branch 'master' into advanced_sample_app Apr 13, 2017

README.md

Build Status Maven Central Javadocs

Magellan

The simplest navigation library for Android.

Main Features

  • Navigation is as simple as calling goTo(screen)
  • You get full control of the backstack
  • Transitions are automaticaly handled for you

Download

Add the dependencies you need in your build.gradle:

Core library

implementation 'com.wealthfront:magellan:1.1.0'

Optional add-ons

def magellanVersion = '1.1.0'
implementation "com.wealthfront:magellan:${magellanVersion}"
implementation "com.wealthfront:magellan-support:${magellanVersion}"
implementation "com.wealthfront:magellan-rx:${magellanVersion}"
implementation "com.wealthfront:magellan-rx2:${magellanVersion}"

Coming soon

Getting started

Single Activity

MainActivity.java:

public class MainActivity extends SingleActivity {

  @Override
  protected Navigator createNavigator() {
    return Navigator.withRoot(new HomeScreen()).build();
  }

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
  }

}

activity_main.xml:

<com.wealthfront.magellan.ScreenContainer
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/magellan_container"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    /> 

Minimal Screen implementation

Screen example HomeScreen.java:

public class HomeScreen extends Screen<HomeView> {
  @Override
  protected HomeView createView(Context context) {
    return new HomeView(context);
  }
}

Associated View HomeView.java:

public class HomeView extends BaseScreenView<HomeScreen> {
  public HomeView(Context context) {
    super(context);
    inflate(context, R.layout.home, this);
  }
}

Samples

Basic sample

basic-sample-gif

Advanced sample using Dependency Injection, Retrofit, and Rx.

advanced-sample-gif

Kotlin sample (courtesey of @jmfayard)

Learn More

For more, see the wiki.

License

Copyright 2017 Wealthfront, 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.
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.