Skip to content

A declarative navigation system for App UI, built on top of Roact. This is a read-only mirror.

License

Notifications You must be signed in to change notification settings

jsdotlua/roact-navigation

This branch is 14 commits ahead of, 1 commit behind Roblox/roact-navigation:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

201f692 · Jan 29, 2025
Nov 23, 2024
Jul 19, 2023
Nov 22, 2024
Apr 20, 2021
Nov 23, 2024
Jan 15, 2025
Nov 22, 2024
Nov 23, 2024
Nov 22, 2024
Nov 22, 2024
Apr 17, 2019
Nov 22, 2024
Apr 17, 2019
Nov 22, 2024
Nov 22, 2024
Nov 22, 2024
Nov 22, 2024
Nov 22, 2024
Jan 15, 2025
Dec 11, 2023
Apr 2, 2024
Oct 31, 2019
Nov 22, 2024
Dec 12, 2023
Nov 22, 2024
Nov 22, 2024
Nov 22, 2024
Nov 22, 2024
Nov 23, 2024
Nov 22, 2024

Repository files navigation

Roact Navigation

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

Install with Rotriever

Adding Roact Navigation to your dependencies

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/[email protected]"
# ... the rest of your dependencies ...

[dev_dependencies]
# ...

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

Get the source

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

rotrieve install

Contributing

Read the contribute guide to get started.

Documentation

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).

Caveats/Concerns

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

License

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

About

A declarative navigation system for App UI, built on top of Roact. This is a read-only mirror.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Lua 99.7%
  • Shell 0.3%