docs: mark options as platform specific

react-navigation · Oct 8, 2019 · 78481be · 78481be
1 parent b822c11
commit 78481be
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/packages/example/src/Screens/NativeStack.tsx b/packages/example/src/Screens/NativeStack.tsx
@@ -112,6 +112,7 @@ const styles = StyleSheet.create({
   buttons: {
     flexDirection: 'row',
     padding: 8,
+    marginTop: 56,
   },
   button: {
     margin: 8,

diff --git a/packages/native-stack/src/types.tsx b/packages/native-stack/src/types.tsx
@@ -60,6 +60,9 @@ export type NativeStackNavigationOptions = {
   headerTitle?: string | (() => React.ReactNode);
   /**
    * Title to display in the back button.
+   * Only supported on iOS.
+   *
+   * @platform ios
    */
   headerBackTitle?: string;
   /**
@@ -114,13 +117,20 @@ export type NativeStackNavigationOptions = {
    * Style object for header back title. Supported properties:
    * - fontFamily
    * - fontSize
+   *
+   * Only supported on iOS.
+   *
+   * @platform ios
    */
   headerBackTitleStyle?: {
     fontFamily?: string;
     fontSize?: number;
   };
   /**
-   * Whether you can use gestures to dismiss this screen. Defaults to `true` on iOS, `false` on Android.
+   * Whether you can use gestures to dismiss this screen. Defaults to `true`.
+   * Only supported on iOS.
+   *
+   * @platform ios
    */
   gestureEnabled?: boolean;
   /**
@@ -129,6 +139,9 @@ export type NativeStackNavigationOptions = {
   contentStyle?: StyleProp<ViewStyle>;
   /**
    * How should the screen be presented.
+   * Only supported on iOS.
+   *
+   * @platform ios
    */
   presentation?: 'modal' | 'transparentModal' | 'push';
 };