Roact Navigation provides a declarative navigation system for App UI, built on top of Roact. Slack channel #roact-navigation.

In your rotriever.toml file from your project, add an entry in the dependencies section:

[package]
name = "roblox/cool-plugin-that-uses-roact-navigation"
version = "0.4.1"
author = "Roblox"
content_root = "src"

[dependencies]
# adding this line will make your project depend on version 0.5.10
RoactNavigation = "Roblox/roact-navigation-internal@0.5.10"
# ... the rest of your dependencies ...

[dev_dependencies]
# ...

To view a list of available version, visit the releases page.

Now that Roact Navigation is added to your rotriever dependencies, simply run the following command to download the package:

rotrieve install

Read the contribute guide to get started.

Since Roact Navigation is based on React Navigation version 4, a lot of the documentation from the original JavaScript package can be used as a reference. There is also a deviation document that highlights the main differences between the Lua version and the JavaScript version

As part of the Lua tech talks, a presentation of Roact Navigation was recorded and available for employees. Visit the Lua tech talk schedule and look for the presentation on April 12th (2021).

• Otter version 9ad129e or later is required to avoid the motor:start() timing bugs.

Roact Navigation mostly kept the same license (MIT) as the original JavaScript version.