Added the currentScreenNavInfo API.

Author: Johann Blake

README.md

@@ -6,11 +6,8 @@ This app demonstrates how to use animated transitions when navigating between sc
 
 I have also written an article on Medium that covers the code in this app in much more detail. It touches on developing with Compose beyond what you read in the official Android docs. You can find the article at:<br>
 
-
 [https://proandroiddev.com/navigation-with-animated-transitions-using-jetpack-compose-daeb00d4fb45](https://proandroiddev.com/navigation-with-animated-transitions-using-jetpack-compose-daeb00d4fb45)
 
-
-
 This app does not use the Compose navigation framework due to its limitation of the data types that you can use when passing data to another screen. These are limited to the same subset you would normally use under the older View system when passing data to activities and fragments, i.e., the types restricted to bundles. Because Compose doesn't use activities or fragmenets (other than the startup activity), I personally never felt there was a need to restrict the app to these data types. You should be able to pass any data type.
 
 Another limitation is that animated transitions are currently not supported when navigating to and from screens, although Google has mentioned in their docs that this feature is in the pipeline.
@@ -89,4 +86,5 @@ The following lists the APIs you can use from the Navigation Manager:
 | observeScreenChange   | ```fun observeScreenChange(callback: (screen: Any) -> Unit)```<br/><br/>Notifies subscribers whenever the Navigation Manager navigates to another screen or navigates back to a previous one. This should only be used by non-UI code to perform any necessary tasks whenever the screen changes.                                                                                                                                                                                                                                                                                                                                 |
 | onScreenChange        | ```onScreenChange: LiveData<Int>```<br/><br/>The Navigation Manager uses this to notify the screen factory composable to update the screens . This is an observable with a value set to a random number between 0 and 1 million. A random number is used in order to force LiveData to update its value and notify the observer (which is the screen factory). The value itself has no meaning.<br/><br/>```NavigationManager.onScreenChange.observeAsState(0).value```                                                                                                                                                           |
 | navStackCount         | ```navStackCount: Int```<br/><br/>The total number of screens on the navigation stack. This includes the hidden placeholder screen that is always placed at the end of the stack. There will always be at least two items on the stack - the first item will be the home screen and the last item will be the placeholder screen.                                                                                                                                                                                                                                                                                                 |
-| totalScreensDisplayed | ```totalScreensDisplayed: Int```<br/><br/>The total number of screens on the navigation stack, minus one. This is essentially the same as navStackCount but doesn't include the placeholder screen. This is just a convenient way of knowing how many visible screens are currently being displayed.                                                                                                                                                                                                                                                                                                                              |
+| totalScreensDisplayed | ```totalScreensDisplayed: Int```<br/><br/>The total number of screens on the navigation stack, minus one. This is essentially the same as navStackCount but doesn't include the placeholder screen. This is just a convenient way of knowing how many visible screens are currently being displayed.                                                                                                                                                                                                                                                                                                                              |
+| currentScreenNavInfo  | ```currentScreenNavInfo: NavigationInfo```<br/>Returns navigation information about the currently displayed screen.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |

navigation/src/main/java/dev/wirespec/navigation/NavigationManager.kt

@@ -99,6 +99,15 @@ class NavigationManager {
          */
         val onScreenChange: LiveData<Int> = _onScreenChange
 
+
+        /**
+         * Returns navigation information about the current screen.
+         */
+        val currentScreenNavInfo: NavigationInfo
+            get() {
+                return navStack[navStack.lastIndex - 1]
+            }
+
         /**
          * An observer that clients can register with to get notified whenever the screen changes.
          * Note: This is intended to be used by parts of an app that do not generate any UI.
@@ -162,7 +171,7 @@ class NavigationManager {
         fun navigateToHomeScreen() {
             if (navStack.size > 2) {
                 navStack = navStack.filterIndexed { index, _ ->
-                     (index == 0) || (index == navStack.lastIndex)
+                    (index == 0) || (index == navStack.lastIndex)
                 }.toMutableList()
             }
 
@@ -201,5 +210,3 @@ class NavigationManager {
         }
     }
 }
-
-