https://github.com/insanusmokrassar/navigation

https://github.com/insanusmokrassar/navigation

android kotlin kotlin-android kotlin-js kotlin-jvm kotlin-linux kotlin-mingw kotlin-multiplatform

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/insanusmokrassar/navigation
• Owner: InsanusMokrassar
• License: mit
• Created: 2022-09-12T08:22:18.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-07-16T16:51:27.000Z (5 months ago)
• Last Synced: 2024-07-17T19:40:43.785Z (5 months ago)
• Topics: android, kotlin, kotlin-android, kotlin-js, kotlin-jvm, kotlin-linux, kotlin-mingw, kotlin-multiplatform
• Language: Kotlin
• Homepage: https://docs.inmo.dev/navigation/index.html
• Size: 2.16 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Navigation

Relatively simple tool for navigation in a lot of kotlin platforms:

![JVM](https://img.shields.io/badge/JVM-red?style=for-the-badge&logo=openjdk&logoColor=white)

![Android](https://img.shields.io/badge/Android-green?style=for-the-badge&logo=android&logoColor=white)

![Js](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E)

![ARM x64](https://img.shields.io/badge/ARMx64-0091BD?style=for-the-badge&logo=arm&logoColor=F7DF1E)

![Linux x64](https://img.shields.io/badge/Linuxx64-FCC624?style=for-the-badge&logo=linux&logoColor=F7DF1E)

[![KDocs](https://img.shields.io/badge/KDocs-323330?style=for-the-badge&logo=Kotlin&logoColor=7F52FF)](https://insanusmokrassar.github.io/navigation/)

[![Tutorials](https://img.shields.io/badge/Tutorials-0288D1?style=for-the-badge&logo=mkdocs&logoColor=white)](https://docs.inmo.dev/navigation/index.html)

It is strongly recommended to open tutorial after completing reading of this readme to understand how to use library

## Artifacts

There are several types of artifacts:

* Core - only base functionality: nodes, chains, navigation repositories, etc.

* Compose - Core + `Compose` wrappers for navigation node

* MVVM - Core + MVVM wrappers:

    * [ViewModel](./mvvm/src/commonMain/kotlin/ViewModel.kt)

    * [ComposeView](./mvvm/src/commonMain/kotlin/compose/ComposeView.kt)

    * Platforms-specific realizations of `View`s

## Installation

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/navigation.core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/navigation.core)

### Gradle

```groovy

implementation "dev.inmo:navigation.mvvm:$navigation_version"

```

### Maven

```xml

  dev.inmo

  navigation.mvvm

  ${navigation_version}

```