From eae0268278dea3bbffe189e02b2e616c54f995f9 Mon Sep 17 00:00:00 2001 From: Sven Bendel Date: Thu, 18 Apr 2019 12:59:05 +0200 Subject: [PATCH] SFW-331 Update README --- nav/README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/nav/README.md b/nav/README.md index 72def34..4b118fe 100644 --- a/nav/README.md +++ b/nav/README.md @@ -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. \ No newline at end of file +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. +