Magellan X

A simple, flexible, and practical navigation framework for Android using Jetpack Compose.

Why would I use Magellan?

Simple: Intuitive abstractions and encapsulation make it easy to reason through code.
Flexible: The infinitely-nestable structure allows for many different styles of structuring an app and navigating between pages.
Practical: We pay special attention to simplifying common patterns and removing day-to-day boilerplate.
Testable: Plain objects that are easy to instantiate and control make testing simple.

Download

Add jitpack to your repositories (in your root build.gradle.kts file):

allprojects {
  repositories {
    // ...
    maven("https://jitpack.io")
  }
}

Add to Gradle version catalog

To use in gradle's version catalogs, add the following to your libs.versions.toml:

[versions]
magellanx = "0.5.2"
# ...

[libraries]
magellanx-compose = { module = "com.ryanmoelter.magellanx:magellanx-compose", version.ref = "magellanx" }
magellanx-test = { module = "com.ryanmoelter.magellanx:magellanx-test", version.ref = "magellanx" }

Alternatively, if you only want the core library without the Compose implementation, you can use:

magellanx-core = { module = "com.ryanmoelter.magellanx:magellanx-core", version.ref = "magellanx" }

Note: magellanx-core is included in and exposed by magellanx-compose, and magellan-test only applies to magellanx-compose.

And don't forget to use them in your dependencies block:

dependencies {
  implementation(libs.magellan.compose)
  testImplementation(libs.magellan.test)
  // Alternatively:
  // implementation(libs.magellan.core)

  // ...
}

Add to `dependencies` block

Add to dependencies block instead

If you don't want to use version catalogs, you can add the dependencies you need directly in your dependencies block:

val magellanxVersion = "0.5.2"
implementation("com.ryanmoelter.magellanx:magellanx-compose:${magellanxVersion}")
testImplementation("com.ryanmoelter.magellanx:magellanx-test:${magellanxVersion}")

Alternatively, if you only want the core library without the Compose implementation, you can use:

implementation("com.github.ryanmoelter.magellanx:magellanx-core:0.5.2")

Note: magellanx-core is included in and exposed by magellanx-compose, and magellan-test only applies to magellanx-compose.

Dependency versions

Dependencies' versions for different Magellan X versions

Magellan X uses the following dependencies, and since 0.2.0 is using the compose bill of materials (BOM).

Magellan X version	Kotlin version	Compose compiler version	Compose BOM	Tested compatible compose versions
`0.5.2`	`1.9.23`	`1.5.11`	`2024.03.00`	`1.6.4`
`0.5.1`	`1.9.22`	`1.5.10`	`2024.02.02`	`1.6.3`
`0.5.0`	`1.9.22`	`1.5.10`	`2024.02.01`	`1.6.2`
`0.4.0` - `0.4.1`	`1.9.22`	`1.5.8`	`2024.01.00`	`1.6.0`
`0.3.0` - `0.3.1`	`1.9.21`	`1.5.7`	`2023.10.01`	`1.5.4`
`0.2.0`	`1.7.20`	`1.3.2`	`2022.11.00`	`1.3.*`
`0.1.2`	`1.6.10`	-	-	`1.2.0-alpha05`

Learning

Note: This library is a fork of wealthfront/magellan, and is in the process of getting published. In the meantime, you can refer to the original's wiki pages below.

For an explanation of the core concepts of Magellan, see the source repo's wiki, starting with Thinking in Magellan.

If you're eager to start, check out the source repo's Quickstart wiki page.

License

Copyright 2022 Ryan Moelter

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.

Based on code from wealthfront/magellan licensed by:

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.

ryanmoelter/magellanx