@react-navigation/routers

Bug Fixes

• handle merge: true with NAVIGATION_DEPRECATED in TabRouter (e5cf73d) - by @satya164

• feat!: add popTo method for stack and remove going back behaviour of (c9c2163) - by @satya164

• refactor!: drop support for key property in navigate (61c53bb) - by @satya164

Features

• add navigateDeprecated for backward compatibility (8ea6dc7) - by @satya164
• extract drawer to a separate package (58b7cae) - by @satya164

BREAKING CHANGES

• Previously, navigate method navigated back if the screen already exists in the stack. I have seen many people get confused by this behavior. This behavior is also used for sending params to a previous screen in the documentation. However, it's also problematic since it could either push or pop the screens based on the scenario.

This removes the going back behavior from navigate and adds a new method popTo to go back to a specific screen in the stack.

The methods now behave as follows:

• navigate(screenName) will stay on the current screen if the screen is already focused, otherwise push a new screen to the stack.
• popTo(screenName) will go back to the screen if it exists in the stack, otherwise pop the current screen and add this screen to the stack.
• To achieve the previous behavior with navigate, you can use the getId prop in which case it'll go to the screen with the matching ID and push or pop screens accordingly.

• Previously, you could specify a route key to navigate to, e.g. navigation.navigate({ key: 'someuniquekey' }). It's problematic since key is an internal implementation detail and created by the library internally - which makes it weird to use. None of the other actions support such usage either.

In addition, we have already added a better API (getId) which can be used for similar use cases - and gives users full control since they provide the ID and it's not autogenerated by the library.

So this change removes the key option from the navigate action.

6.1.3 (2022-09-16)

Note: Version bump only for package @react-navigation/routers

6.1.2 (2022-08-24)

Note: Version bump only for package @react-navigation/routers

6.1.1 (2022-07-05)

Note: Version bump only for package @react-navigation/routers

Features

• add a navigationKey prop to Screen and Group (b2fa62c)

6.0.2 (2021-10-09)

Bug Fixes

• properly handle history if drawer is open by default (de2d4e4)

6.0.1 (2021-08-03)

Reverts

• Revert "fix: don't merge initial params when merge !== true" (8086772)

Bug Fixes

• don't merge initial params when merge !== true (54b215b)

Note: Version bump only for package @react-navigation/routers

Note: Version bump only for package @react-navigation/routers

Note: Version bump only for package @react-navigation/routers

Note: Version bump only for package @react-navigation/routers

Note: Version bump only for package @react-navigation/routers

Bug Fixes

• default to backBehavior: firstRoute for TabRouter (8bdc6c6)
• don't merge params on navigation (366d018)
• fix getId being called for incorrect routes. closes #9343 (61e653d)
• fix StackRouter incorrectly handling invalid route if key is present (3367ddf)

Code Refactoring

• don't use a boolean for drawer status (cda6397)

Features

• add a new backBehavior: firstRoute for TabRouter (7c1cd26)
• add a way to specify an unique ID for screens (15b8bb3)
• add pressColor and pressOpacity props to drawerItem (#8834) (52dbe4b)
• associate path with the route it opens when deep linking (#9384) (86e64fd), closes #9102

BREAKING CHANGES

• Drawer status is now a union ('open', 'closed') instead of a boolean. This will let us implement more types of status in future.

Following this the following exports have been renamed as well:

• getIsDrawerOpenFromState -> getDrawerStatusFromState
• useIsDrawerOpen -> useDrawerStatus

• Returning to first route after pressing back seems more common in apps. This commit changes the default for tab and drawer navigators to follow this common practice. To preserve previous behavior, you can pass backBehavior=history to tab and drawer navigators.
• Previous versions of React Navigation merged params on navigation which caused confusion. This commit changes params not to be merged.

The old behaviour can still be achieved by passing merge: true explicitly:

CommonActions.navigate({
  name: 'bar',
  params: { fruit: 'orange' },
  merge: true,
})

initialParams specified for the screen are always merged.

5.6.2 (2020-11-09)

Note: Version bump only for package @react-navigation/routers

5.6.1 (2020-11-08)

Note: Version bump only for package @react-navigation/routers

Features

• add a merge option to navigate to control merging params (9beca3a)

5.5.1 (2020-10-28)

Bug Fixes

• improve types for route prop in screenOptions (d26bcc0)

Bug Fixes

• handle pushing a route with duplicate key (091b2a2)

Features

• allow deep linking to reset state (#8973) (7f3b27a), closes #8952
• improve types for navigation state (#8980) (7dc2f58)

5.4.12 (2020-09-22)

Note: Version bump only for package @react-navigation/routers

5.4.11 (2020-08-04)

Note: Version bump only for package @react-navigation/routers

5.4.10 (2020-07-28)

Bug Fixes

• make sure history is correct after rehydration (b70e3fe)
• make sure index is correct when rehydrating state for tabs (#8638) (1aa8219)

5.4.9 (2020-07-10)

Bug Fixes

• mark some types as read-only (7c3a0a0)
• only remove non-existed routes from tab history. closes #8567 (374b081)

5.4.8 (2020-06-24)

Bug Fixes

• more improvements to types (d244488)

5.4.7 (2020-05-23)

Note: Version bump only for package @react-navigation/routers

5.4.6 (2020-05-20)

Note: Version bump only for package @react-navigation/routers

5.4.5 (2020-05-20)

Note: Version bump only for package @react-navigation/routers

5.4.4 (2020-05-08)

Bug Fixes

• fix building typescript definitions. closes #8216 (47a1229)

5.4.3 (2020-05-08)

Note: Version bump only for package @react-navigation/routers

5.4.2 (2020-04-30)

Bug Fixes

• fix backBehavior with initialRoute (#8110) (420f692)

5.4.1 (2020-04-27)

Bug Fixes

• fix behaviour of openByDefault in drawer when focus changes (b172b51)

Features

• add openByDefault option to drawer (36689e2)

Bug Fixes

• separate normal exports and type exports (303f0b7)

Features

• make replace bubble up (ba1f405)

5.2.1 (2020-03-30)

Note: Version bump only for package @react-navigation/routers

Features

• add keys to routes missing keys during reset (813a590)

5.1.1 (2020-03-16)

Bug Fixes

• don't handle action if no routes are present (660cac3)

Bug Fixes

• fix links for documentation (5bb0f40)

Features

• make reset bubble up (09f6808)

5.0.3 (2020-02-26)

Note: Version bump only for package @react-navigation/routers

5.0.2 (2020-02-21)

Bug Fixes

• tweak error message for navigate (c8ea419)

5.0.1 (2020-02-10)

Bug Fixes

• merge initial params on replace (80629bf)

Note: Version bump only for package @react-navigation/routers

Note: Version bump only for package @react-navigation/routers

Note: Version bump only for package @react-navigation/routers

Bug Fixes

• add licenses (0c159db)

Note: Version bump only for package @react-navigation/routers