Skip to content

Commit ba9fa3c

Browse files
committed
Mention that createXScreen is not a breaking change
1 parent e6d0d68 commit ba9fa3c

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

versioned_docs/version-8.x/upgrading-from-7.x.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ When using the `createXScreen` API, the type of params are automatically inferre
155155

156156
Each navigator exports its own helper function, e.g. `createNativeStackScreen` for Native Stack Navigator, `createBottomTabScreen` for Bottom Tab Navigator, `createDrawerScreen` for Drawer Navigator etc.
157157

158+
Note that this is not a breaking change. It's not required to use this API and your existing code will continue to work as before. You can incrementally adopt this API for new screens to get proper types for `route` object in various callbacks such as `options`, `listeners`, etc.
159+
158160
See [Static configuration docs](static-configuration.md#createxscreen) for more details.
159161

160162
#### Custom navigators now require overloads for types

0 commit comments

Comments
 (0)