Skip to content

Commit

Permalink
Merge pull request #25 from stanwood/feature/SFW-331-sync-navigation-…
Browse files Browse the repository at this point in the history 
…graph-with-bottom-bar-2

Feature/sfw 331 README
  • Loading branch information
@ubuntudroid
ubuntudroid authored Apr 18, 2019
2 parents a39571a + 28d7104 commit aa34bff
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion nav/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,13 @@

We handle navigation by means of the [Navigation Architecture Component](https://developer.android.com/topic/libraries/architecture/navigation/).

This library provides helper classes for simplified and more consistent navigation handling. This is mainly used by the IntelliJ plugin.
This library provides helper classes for simplified and more consistent navigation handling. This is mainly used by the IntelliJ plugin.

The central class is `NavigationTarget`. This class encapsulates navigation and can easily be extended for other means than classic Architecture Components supported navigation such as dialogs. A `NavigationTarget` is usally passed via RX from the ViewModel to the Fragment.

In the Fragment you can use `NavigationTarget.navigate()` to execute navigation.

Additionally this library brings some extension functions for BottomNavigationViews, NavigationViews and Toolbars which all help you when implementing navigation.

The plugin supports you in setting all those things up.

0 comments on commit aa34bff

Please sign in to comment.