Handle new backButtonDisplayMode functionality

react-navigation · May 9, 2024 · 6dd3bd0 · 6dd3bd0
1 parent d0abdee
commit 6dd3bd0
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/packages/native-stack/src/types.tsx b/packages/native-stack/src/types.tsx
@@ -342,6 +342,15 @@ export type NativeStackNavigationOptions = {
    * @platform ios
    */
   headerBackButtonMenuEnabled?: boolean;
+  /**
+   * How the back button behaves by default (when not customized). Available on iOS>=14.
+   * The following values are currently supported (they correspond to https://developer.apple.com/documentation/uikit/uinavigationitembackbuttondisplaymode?language=objc):
+   * - "default" – shows given back button title/previous controller title, system default or just icon based on available space
+   * - "generic" – shows given system default or just icon based on available space
+   * - "minimal" – shows just an icon
+   * @platform ios
+   */
+  backButtonDisplayMode?: ScreenStackHeaderConfigProps['backButtonDisplayMode'];
   /**
    * Whether the home indicator should prefer to stay hidden on this screen. Defaults to `false`.
    *

diff --git a/packages/native-stack/src/views/HeaderConfig.tsx b/packages/native-stack/src/views/HeaderConfig.tsx
@@ -51,6 +51,7 @@ export function HeaderConfig({
   route,
   title,
   canGoBack,
+  backButtonDisplayMode,
 }: Props): JSX.Element {
   const { direction } = useLocale();
   const { colors, fonts } = useTheme();
@@ -190,6 +191,7 @@ export function HeaderConfig({
       disableBackButtonMenu={headerBackButtonMenuEnabled === false}
       hidden={headerShown === false}
       hideBackButton={headerBackVisible === false}
+      backButtonDisplayMode={backButtonDisplayMode}
       hideShadow={
         headerShadowVisible === false ||
         headerBackground != null ||