https://github.com/cesarvaliente/navigationrail-wm-sample

This is a sample that shows the power of using NavigationRail, BottomNavigation, latest Navigation component and WindowManager altogether, so depending on the device form factor used (single screen or foldable/dual-screen), a specific UI navigation will be shown to the user, taking advantage of the extra-room that these new devices provide.
https://github.com/cesarvaliente/navigationrail-wm-sample

android bottomnavigation dual-screen foldables jetpack-navigation navigationrail surface-duo windowmanager

Last synced: 2 months ago
JSON representation

This is a sample that shows the power of using NavigationRail, BottomNavigation, latest Navigation component and WindowManager altogether, so depending on the device form factor used (single screen or foldable/dual-screen), a specific UI navigation will be shown to the user, taking advantage of the extra-room that these new devices provide.

• Host: GitHub
• URL: https://github.com/cesarvaliente/navigationrail-wm-sample
• Owner: CesarValiente
• License: mit
• Created: 2021-07-08T16:56:59.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-08-18T11:03:32.000Z (almost 4 years ago)
• Last Synced: 2025-01-26T04:11:16.172Z (4 months ago)
• Topics: android, bottomnavigation, dual-screen, foldables, jetpack-navigation, navigationrail, surface-duo, windowmanager
• Language: Kotlin
• Homepage:
• Size: 536 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NavigationRail-WM-Sample

This is a sample app that uses the following components in order to show an adjusted and dynamic UI that fits better with the specific device screen mode or form-factor used:

- [NavigationRail](https://github.com/material-components/material-components-android/blob/master/docs/components/NavigationRail.md)

- [BottomNavigation](https://github.com/material-components/material-components-android/blob/master/docs/components/BottomNavigation.md)

- [Jetpack WindowManager](https://developer.android.com/jetpack/androidx/releases/window)

- [Navigation](https://developer.android.com/jetpack/androidx/releases/navigation) (important, using new stuff coming in 2.4.0-alpha04 version)

## How does it work?

On single screen devices, a BottomNavigation will be shown to the user to navigate through the app,

but when there is a [FoldingFeature](https://developer.android.com/reference/androidx/window/FoldingFeature) separating the content, a NavigationRail will be used instead of the BottomNavigation providing a different and in some scenarios better user experience.

This approach can be easily adapted as well to tablets and big-screens.

### Examples

App running on a dual-screen device:

![Surface Duo showing the app using BottomNavigation on single screen mode](./art/app-single-screen.png)

![Surface Duo showing the app using NavigationRail when is spanned across displays](./art/app-dual-screen.png)

App running on a foldable device:

![Foldable device showing the app using BottomNavigation on multi-window mode](./art/foldable-multi-window.png)

![Foldable device showing the app using NavigationRail when is in full-screen (spanned) mode](./art/foldable-spanned.png)

## Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). 

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)

or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## License

Copyright (c) Microsoft Corporation.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and

associated documentation files (the "Software"), to deal in the Software without restriction,

including without limitation the rights to use, copy, modify, merge, publish, distribute,

sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial

portions of the Software.

THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.