Files
AndroidJetpack/appyx/documentation/index.md
T
coco 723ce1af5c a
2026-07-03 15:12:48 +08:00

77 lines
3.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Appyx
Model-driven navigation for Jetpack Compose
[https://github.com/bumble-tech/appyx](https://github.com/bumble-tech/appyx)
## Navigation for your Compose app on steroids
- **Navigate directly from code** In a type-safe way, without boilerplate
- **Gain control of navigation state** Making your navigation unit-testable
- **Complete control over operations and behaviour** Use and extend the back stack or the view pager from the library, or build your own
- **Your own navigation** With Appyx, you can define your own navigation models
- **Use any animation for transitions** Anything you can represent with Compose `Modifiers`
## Model-driven navigation a different paradigm with superpowers
Using Appyx you gain navigation superpowers in addition to screen-to-screen navigation:
- **Break down screen boundaries** Using `NavModels` you can navigate inside the screen as well as between them
- **Make your navigation composable** Navigate whole scopes of your application
Using a model-driven approach, navigation states are yours to define Appyx makes it happen with any animation you can represent using Compose `Modifiers`. Back stacks, card stacks, view pagers are just the beginning:
<img src="https://i.imgur.com/8gy3Ghb.gif" width="150"> <img src="https://i.imgur.com/Kj0P85H.gif" width="150"> <img src="https://i.imgur.com/N8rEPrJ.gif" width="150"> <img src="https://i.imgur.com/esLXh61.gif" width="150">
You can create custom navigable components in no time:
<img src="https://cdn-images-1.medium.com/max/1600/1*mEg8Ebem3Hd2knQSA0yI1A.gif" width="150">
With Appyx you can break down screen boundaries and transform the screen itself:
<img src="https://i.imgur.com/EKjwaqW.gif" width="150">
See [Model-driven navigation](navigation/model-driven-navigation.md) for more details.
## Launch the demo app
Check out the project and launch the `:app` module for a quick demonstration!
## Download
See the [Downloads page](releases/downloads.md).
## Learning Appyx
Check out the [Quick start guide](how-to-use-appyx/quick-start.md), [Codelabs](how-to-use-appyx/codelabs.md), and [Sample apps](how-to-use-appyx/sample-apps.md)!
## Articles
1. [Appyx is released! (1.0-alpha02)](https://medium.com/bumble-tech/appyx-is-released-1-0-alpha02-41a27ad3b0cd)
2. [Appyx vs Jetpack Compose Navigation](https://medium.com/bumble-tech/appyx-vs-jetpack-compose-navigation-b91bd23369f2)
3. [Modelling dating cards navigation with Appyx](https://medium.com/bumble-tech/modelling-dating-cards-navigation-with-appyx-ab68313d27f6)
## Videos
<img style="vertical-align:middle" src="https://i.imgur.com/NocSZPu.png" width="75" /> [Model-driven navigation with Jetpack Compose](https://www.droidcon.com/2022/09/29/model-driven-navigation-with-jetpack-compose-from-zero-to-hero/)
<img style="vertical-align:middle" src="https://i.imgur.com/bgNLFnD.png" width="75" /> [Model-driven navigation with Appyx](https://www.droidcon.com/2022/11/15/model-driven-navigation-with-appyx-from-zero-to-hero/)
## News & updates
See our [News & updates](news.md) page
You can also follow some of us tweeting about Appyx on these accounts:
- [@ZsoltKocsi](https://twitter.com/ZsoltKocsi)
- [@andreyk_nn](https://twitter.com/andreyk_nn)