Deprecation warning

This page in the documentation is about Appyx 1.x.

Appyx is now in its 2.x iteration.

To access the 2.x-related pages please check the sidebar or go to:

Documentation root

---

Navigation models

Navigation model is a core concept of Appyx.

What's a NavModel?

Navigation models describe navigation itself – by the states and operations they define, any custom navigation mechanism can be implemented.

NavModel capabilities differ across implementations, however, typically:

1. They store information on the states of all children
2. They behave like a state machine
3. They offer some public API to trigger changing the state of children

Some examples of navigation models

You can take a look at some of these examples:

1. Back stack
2. Spotlight
3. Tiles
4. Promoter carousel

When you feel ready, you can try to implement your own NavModel.

What does a NavModel not do?

The NavModel represents only the model, not the looks:

• UI representation depends on your @Composable view hosting the children – See Adding children to the view
• Transition animations (if any) is a separate concern