Code Monkey home page Code Monkey logo

compose-navigator's Introduction

Compose Navigator

License

Easier to complete Jetpack Compose navigation

Getting started

In your build.gradle:

dependencies {
    implementation 'com.patchself:compose-navigator:0.1.3'
}

Or if you use gradle.kts, in yourbuild.gradle.kts

dependencies {
    implementation("com.patchself:compose-navigator:0.1.3")
}

Usage

  1. Add config your compose activity
class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        //set open app first page
        navigationController.initController(SplashPage())
        setContent {
            navigationController.viewContent()
        }
    }

    override fun onBackPressed() {
        // navigator go back handler
        if (!navigationController.onBackPressed()){
            super.onBackPressed()
        }
    }
}
  1. Write your custom page
class CustomPage : PageController() {
    override fun getId() = R.id.CustomPage

    /**
     * write page content in this method
     */
    @Composable
    override fun screenContent() {
        Scaffold(topBar = {
            TopAppBar(
                title = { Text(text = "Navigator Sample") },
                navigationIcon = {
                    IconButton(onClick = { navigateBack() }) {
                        Icon(asset = Icons.Filled.ArrowBack)
                    }
                },
                elevation = 4.dp
            )
        }) {
        }
    }
}
  1. In your Custom Page,which extend PageController, you can use navigateTo(PageController) to new page, and navigateBack() go back to last page
  2. You can use resetTo(pageId) back to specify page, and change page args like
    resetTo<HomePage>(R.id.HomePage){
        argsOfHomePage = newValue
    }

preview

compose-navigator's People

Contributors

modificator avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

sldboy

compose-navigator's Issues

slid show same screen bug

hi I found this bug:
I navigated to thirdPage and pressed "reset to secondPage", slid screen to homePage show Second Page. But pressed backButton was correct. Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.