diff --git a/README.md b/README.md index 849d914..8143497 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ A comprehensive, but not exhaustive, translation of upstream ReactJS 17.x into R ## TL;DR * In a new project, you can consume this library by adding this line to your rotriever.toml - * `React = "github.com/roblox/roact-alignment@17.0.1-rc.19"` + * `React = "github.com/roblox/roact-alignment@17.0.1"` * If you have legacy Roact code, use the roact-compat library instead - * `RoactCompat = "github.com/roblox/roact-alignment@17.0.1-rc.19"` + * `RoactCompat = "github.com/roblox/roact-alignment@17.0.1"` * Make sure you are using the latest [rotriever](https://github.com/Roblox/rotriever/releases) 0.5 (or later) release * you can download the release binary, or add it to your `foreman.toml`: ```rotrieve = { source = "roblox/rotriever", version = "=0.5.6" }``` * For unit testing components and trees of components, you'll want to use the [`act()`](https://github.com/threepointone/react-act-examples/blob/master/sync.md) API exported from the react-roblox package. diff --git a/docs/api-reference/react.md b/docs/api-reference/react.md index d06070e..f3253ba 100644 --- a/docs/api-reference/react.md +++ b/docs/api-reference/react.md @@ -353,7 +353,7 @@ end) React Deviation !!! warning - **While `React.Suspense` is technically implemented, it should be considered unusable as of version `17.0.1-rc.19`.** This is due to a limitation in Luau around recursive `pcall` depth. Future updates to React will unravel the recursive traversal and enable these features. + **While `React.Suspense` is technically implemented, it should be considered unusable as of version `17.0.1`.** This is due to a limitation in Luau around recursive `pcall` depth. Future updates to React will unravel the recursive traversal and enable these features. Future version of React eliminate this recursive structure and should enable full use of `Suspense` and error boundaries. Renders a subtree of children that can yield. If the children suspend while rendering, the `fallback` field provided will be used until the children have resolved their render. diff --git a/docs/migrating-from-1x/upgrading-to-roact-17.md b/docs/migrating-from-1x/upgrading-to-roact-17.md index 93daaae..6a8be62 100644 --- a/docs/migrating-from-1x/upgrading-to-roact-17.md +++ b/docs/migrating-from-1x/upgrading-to-roact-17.md @@ -13,8 +13,8 @@ Roact 17 is available as a collection of packages hosted in the https://github.c 2. Add the following to your `rotriever.toml` manifest file: ```toml [dependencies] - React = "github.com/roblox/roact-alignment@17.0.1-rc.19" - ReactRoblox = "github.com/roblox/roact-alignment@17.0.1-rc.19" + React = "github.com/roblox/roact-alignment@17.0.1" + ReactRoblox = "github.com/roblox/roact-alignment@17.0.1" ``` 3. Run `rotrieve install` to install all dependencies 4. `React.lua` and `ReactRoblox.lua` will be added to the `Packages` folder generated by rotriever in your project. Make sure this folder is included in your project when testing with `roblox-cli` or Roblox Studio. @@ -27,7 +27,7 @@ Make the following changes to your `rotriever.toml` manifest file: ```diff [dependencies] - Roact = "github.com/roblox/roact@1.4" -+ Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1-rc.19", package = "RoactCompat" } ++ Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1", package = "RoactCompat" } ``` This creates a dependency on the `RoactCompat` package, which provides [a compatibility layer](../api-reference/roact-compat.md) for migrating from legacy APIs. @@ -39,9 +39,9 @@ Since it's still named `Roact` in the above snippet, it will be aliased to `Roac However, the `RoactCompat` API only covers enough to provide backwards compatibility. To access new features like hooks or suspense, you will need to add dependencies on `React` and `ReactRoblox` as well: ```toml [dependencies] -Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1-rc.19", package = "RoactCompat" } -React = "github.com/roblox/roact-alignment@17.0.1-rc.19" -ReactRoblox = "github.com/roblox/roact-alignment@17.0.1-rc.19" +Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1", package = "RoactCompat" } +React = "github.com/roblox/roact-alignment@17.0.1" +ReactRoblox = "github.com/roblox/roact-alignment@17.0.1" ``` The `RoactCompat` package **can be safely mixed and matched** with the new `React` and `ReactRoblox` packages; it's nothing more than a thin wrapper around them that aligns with the legacy Roact API and semantics. @@ -64,7 +64,7 @@ You might encounter this if you have existing dependencies on any of the followi To resolve this, you can patch over any dependencies on legacy Roact and align them with your newly-added version. Add this additional section to your `rotriever.toml` manifest file: ```toml [config.patch."github.com/roblox/roact"] -Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1-rc.19", package = "RoactCompat" } +Roact = { target = "github.com/roblox/roact-alignment", version = "17.0.1", package = "RoactCompat" } ``` To learn more about patching dependencies, check out [the Rotriever documentation](https://roblox.github.io/rotriever/guide/specifying-dependencies/#patching-dependencies). @@ -82,7 +82,7 @@ One reasonable way to accomplish this is to depend on _both_ projects, but to co Roact = "github.com/roblox/roact@1.4" [dev_dependencies] -RoactCompat = "github.com/roblox/roact-alignment@17.0.1-rc.19" +RoactCompat = "github.com/roblox/roact-alignment@17.0.1" ``` This declares a dependency on legacy Roact as well as a [dev dependency](https://roblox.github.io/rotriever/guide/specifying-dependencies/#development-dependencies) on Roact 17. diff --git a/rotriever.toml b/rotriever.toml index ed8e5c3..13b9420 100644 --- a/rotriever.toml +++ b/rotriever.toml @@ -1,5 +1,5 @@ [workspace] -version = "17.0.1-rc.19" +version = "17.0.1" members = ["modules/*"] authors = [ "Paul Doyle ", diff --git a/standalone/rotriever.toml b/standalone/rotriever.toml index 10e8504..2efefe4 100644 --- a/standalone/rotriever.toml +++ b/standalone/rotriever.toml @@ -1,10 +1,10 @@ [package] name = "Roact17" -version = "17.0.1-rc.19" +version = "17.0.1" content_root = "src" [dependencies] -RoactCompat = "github.com/roblox/roact-alignment@17.0.1-rc.19" -React = "github.com/roblox/roact-alignment@17.0.1-rc.19" -ReactRoblox = "github.com/roblox/roact-alignment@17.0.1-rc.19" -ReactIs = "github.com/roblox/roact-alignment@17.0.1-rc.19" +RoactCompat = "github.com/roblox/roact-alignment@17.0.1" +React = "github.com/roblox/roact-alignment@17.0.1" +ReactRoblox = "github.com/roblox/roact-alignment@17.0.1" +ReactIs = "github.com/roblox/roact-alignment@17.0.1"