You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/GUIDE_FOR_LIBRARY_AUTHORS.md
+17-5Lines changed: 17 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -523,7 +523,7 @@ Controls the color of the navigation header.
523
523
524
524
### `backTitle` (iOS only)
525
525
526
-
Allows for controlling the string to be rendered next to back button. By default iOS uses the title of the previous screen.
526
+
Allows for controlling the string to be rendered next to back button. For iOS versions prior to 26, the title of the previous screen is used as default.
527
527
528
528
### `backTitleFontFamily` (iOS only)
529
529
@@ -535,6 +535,8 @@ Allows for customizing font size to be used for back button title on iOS.
535
535
536
536
### `backTitleVisible` (iOS only)
537
537
538
+
This prop has been **deprecated**. Setting it has no effect as native code related to this prop has been removed. Kept only for backward compatibility. Will be removed in next major release.
539
+
538
540
Whether the back button title should be visible. Defaults to `true`.
539
541
540
542
When set to `false` it works as a "kill switch": it enforces `backButtonDisplayMode=minimal` and ignores `backButtonDisplayMode`, `backTitleFontSize`, `backTitleFontFamily`, `disableBackButtonMenu`, and `backTitle` works only for back button menu.
@@ -553,18 +555,28 @@ Controls whether the stack should be in `rtl` or `ltr` form.
553
555
554
556
### `disableBackButtonMenu` (iOS only)
555
557
556
-
Boolean indicating whether to show the menu on longPress of iOS >= 14 back button.
558
+
Boolean indicating whether to show the menu on longPress of the back button.
557
559
558
560
### `backButtonDisplayMode` (iOS only)
559
561
560
-
Enum value indicating display mode of back button. It is used only when none of: `backTitleFontFamily`, `backTitleFontSize`, `disableBackButtonMenu` and `backTitleVisible=false` is set. The `backTitleVisible` forces `backButtonDisplayMode: minimal` and omits other values. Read more [#2800](https://github.com/software-mansion/react-native-screens/pull/2800). The other props, under the hood, customize `backButtonItem` which overrides `backButtonDisplayMode`. Read more [#2123](https://github.com/software-mansion/react-native-screens/pull/2123).
562
+
Enum value indicating display mode of back button.
561
563
562
564
Possible options:
563
565
564
-
-`default` – show given back button previous controller title, system generic or just icon based on available space
565
-
-`generic` – show given system generic or just icon based on available space
566
+
-`default` – show given back button previous controller title, system generic or just icon based on available space and OS version
567
+
-`generic` – show given system generic or just icon based on available space and OS version
566
568
-`minimal` – show just an icon
567
569
570
+
Starting from iOS 26:
571
+
- the `title` of the previous screen is not used as back button title,
572
+
-`generic` display mode behaves the same as `minimal`.
573
+
574
+
In order to add text to the back button on iOS 26, use `default` display mode and specify text in `backTitle` property.
575
+
576
+
On iOS versions prior to 26, using `generic` display mode with `backTitleFontFamily`, `backTitleFontSize`
577
+
or `disableBackButtonMenu` property set is not supported due to limitations in the native platform.
578
+
In such cases, display mode will fallback to `default`.
* Boolean indicating whether to show the menu on longPress of iOS >= 14 back button.
642
+
* Boolean indicating whether to show the menu on longPress of the back button.
643
643
* @platform ios
644
644
*/
645
645
disableBackButtonMenu?: boolean;
646
646
/**
647
-
* How the back button behaves. It is used only when none of: `backTitleFontFamily`, `backTitleFontSize`, `disableBackButtonMenu` and `backTitleVisible=false` is set.
647
+
* How the back button behaves.
648
648
* The following values are currently supported (they correspond to [UINavigationItemBackButtonDisplayMode](https://developer.apple.com/documentation/uikit/uinavigationitembackbuttondisplaymode?language=objc)):
649
649
*
650
-
* - `default` – show given back button previous controller title, system generic or just icon based on available space
651
-
* - `generic` – show given system generic or just icon based on available space
650
+
* - `default` – show given back button previous controller title, system generic or just icon based on available space and OS version
651
+
* - `generic` – show given system generic or just icon based on available space and OS version
652
652
* - `minimal` – show just an icon
653
653
*
654
+
* Starting from iOS 26:
655
+
* - the `title` of the previous screen is not used as back button title,
656
+
* - `generic` display mode behaves the same as `minimal`.
657
+
*
658
+
* In order to add text to the back button on iOS 26, use `default` display mode and specify text in `backTitle` property.
659
+
*
660
+
* On iOS versions prior to 26, using `generic` display mode with `backTitleFontFamily`, `backTitleFontSize`
661
+
* or `disableBackButtonMenu` property set is not supported due to limitations in the native platform.
662
+
* In such cases, display mode will fallback to `default`.
0 commit comments