Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AlexGladkov/Odyssey
Odyssey it's a declarative multiplatform navigation library for Multiplatform Compose
https://github.com/AlexGladkov/Odyssey
Last synced: 2 days ago
JSON representation
Odyssey it's a declarative multiplatform navigation library for Multiplatform Compose
- Host: GitHub
- URL: https://github.com/AlexGladkov/Odyssey
- Owner: AlexGladkov
- License: mit
- Created: 2021-09-23T17:35:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T13:03:57.000Z (5 months ago)
- Last Synced: 2024-08-02T05:08:16.152Z (3 months ago)
- Language: Kotlin
- Homepage: https://youtube.com/c/MobileDeveloper
- Size: 13.4 MB
- Stars: 257
- Watchers: 8
- Forks: 22
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- mobile-awesome - Odyssey - Odyssey it's a declarative multiplatform navigation library for Multiplatform Compose. (Multiplatform / Multiplatform libraries)
README
[](https://repo.maven.apache.org/maven2/io/github/alexgladkov/)
[](https://github.com/AlexGladkov/Odyssey/tree/main/common/common-compose)
[](https://www.jetbrains.com/ru-ru/lp/compose-mpp/)
**Odyssey**
Odyssey it's a declarative multiplatform navigation library for Multiplatform Compose
### Documentation
- [Getting Started](documentation/GETTING_STARTED.md)
- [Android Setup](documentation/ANDROID.md)
- [Desktop Setup](documentation/DESKTOP.md)
- [iOS Setup](documentation/IOS.md)
- [Hilt Setup](documentation/HILT.md)
### Supported Features
- [Simple navigation](documentation/SINGLE_SCREEN.md)
- [Nested navigation](documentation/FLOW_SCREEN.md)
- [Params support](documentation/PARAMS_SUPPORT.md)
- [Bottom Navigation View](documentation/BOTTOM_NAVIGATION.md)
- [Multiple Modal Sheets](documentation/BOTTOM_SHEET.md)
- [Tab Navigation](documentation/TAB_NAVIGATION.md)
- [Side Drawer](documentation/SIDE_DRAWER.md)
- [State Saving](documentation/STATE_SAVING.md)
- [Beautiful Transition Animations](documentation/ANIMATIONS.md)
- [Back Press Handling](documentation/BACK_PRESS.md)
### Example
Every available feature in this library can be found
in [example](common/common-sample/src/commonMain/kotlin/ru/alexgladkov/common/compose/)
| **Simple Navigation** | **Present Navigation** | **Modal Navigation** |
|---------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| [
](documentation/screenshots/push_animation.gif) | [
](documentation/screenshots/present_animation.gif) | [
](documentation/screenshots/modal_animation.gif) |
| **Alert Dialog** | **Bottom Navigation** | **Top Navigation** |
| [
](documentation/screenshots/alert_dialog.png) | [
](documentation/screenshots/bottom_navigation.png) | [
](documentation/screenshots/view_pager.png) |
| **Drawer Navigation** | | |
| [
](documentation/screenshots/drawer_navigation.png) | | |
### Users
Projects/Companies using this library:
- [Leroy Merlin](https://play.google.com/store/apps/details?id=ru.leroymerlin.employee&hl=ru&gl=US)
- [1Coin](https://github.com/VitalyPeryatin/1Coin)
- Trinity Monsters
If you use Odyssey in your project please contact me with [telegram](https://t.me/neuradev)
### License
```
MIT License
Copyright (c) 2021 Alex
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.
```