kylefang/react-navigation
1
0
Fork 0
mirror of https://github.com/zhigang1992/react-navigation.git synced 2026-01-12 22:51:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix: format comments in types

Browse Source
This commit is contained in:
kacperkapusciak
2021-06-01 08:53:10 +02:00
parent 32cbbef24c
commit 902a68f524
3 changed files with 36 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
packages/bottom-tabs/src/types.tsx
View File

@@ -83,6 +83,7 @@ export type TabBarVisibilityAnimationConfig =
export type NativeScreenTraitsProps = {
/**
* In which orientation should the screen appear. It requires having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
* The following values are currently supported:
* - "default" - resolves to "all" without "portrait_down" on iOS. On Android, this lets the system decide the best orientation.
* - "all" – all orientations are permitted
@@ -103,21 +104,28 @@ export type NativeScreenTraitsProps = {
| 'landscape_left'
| 'landscape_right';
/**
* Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0.
* Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting)
* `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
*/
statusBarAnimation?: 'none' | 'fade' | 'slide';
/**
* Sets the status bar color (similar to the `StatusBar` component). Requires enabled `react-native-screens` version >=3.3.0.
* Sets the status bar color (similar to the `StatusBar` component).
* Requires enabled `react-native-screens` version >=3.3.0.
*
* @platform android
*/
statusBarColor?: string;
/**
* Whether the status bar should be hidden on this screen. Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0.
* Whether the status bar should be hidden on this screen. Requires enabling (or deleting)
* `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
*/
statusBarHidden?: boolean;
/**
* Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0.
* Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting)
* `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
*/
statusBarStyle?: 'inverted' | 'auto' | 'light' | 'dark';
/**

16
packages/drawer/src/types.tsx
View File

@@ -52,6 +52,7 @@ export type DrawerNavigationConfig = {
export type NativeScreenTraitsProps = {
/**
* In which orientation should the screen appear. It requires having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
* The following values are currently supported:
* - "default" - resolves to "all" without "portrait_down" on iOS. On Android, this lets the system decide the best orientation.
* - "all" – all orientations are permitted
@@ -72,21 +73,28 @@ export type NativeScreenTraitsProps = {
| 'landscape_left'
| 'landscape_right';
/**
* Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0.
* Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting)
* `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
*/
statusBarAnimation?: 'none' | 'fade' | 'slide';
/**
* Sets the status bar color (similar to the `StatusBar` component). Requires enabled `react-native-screens` version >=3.3.0.
* Sets the status bar color (similar to the `StatusBar` component).
* Requires enabled `react-native-screens` version >=3.3.0.
*
* @platform android
*/
statusBarColor?: string;
/**
* Whether the status bar should be hidden on this screen. Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0.
* Whether the status bar should be hidden on this screen. Requires enabling (or deleting)
* `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
*/
statusBarHidden?: boolean;
/**
* Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0.
* Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting)
* `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
*/
statusBarStyle?: 'inverted' | 'auto' | 'light' | 'dark';
/**

16
packages/stack/src/types.tsx
View File

@@ -202,6 +202,7 @@ export type StackDescriptorMap = Record<string, StackDescriptor>;
export type NativeScreenTraitsProps = {
/**
* In which orientation should the screen appear. It requires having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
* The following values are currently supported:
* - "default" - resolves to "all" without "portrait_down" on iOS. On Android, this lets the system decide the best orientation.
* - "all" – all orientations are permitted
@@ -222,21 +223,28 @@ export type NativeScreenTraitsProps = {
| 'landscape_left'
| 'landscape_right';
/**
* Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0.
* Sets the status bar animation (similar to the `StatusBar` component). Requires enabling (or deleting)
* `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
*/
statusBarAnimation?: 'none' | 'fade' | 'slide';
/**
* Sets the status bar color (similar to the `StatusBar` component). Requires enabled `react-native-screens` version >=3.3.0.
* Sets the status bar color (similar to the `StatusBar` component).
* Requires enabled `react-native-screens` version >=3.3.0.
*
* @platform android
*/
statusBarColor?: string;
/**
* Whether the status bar should be hidden on this screen. Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0.
* Whether the status bar should be hidden on this screen. Requires enabling (or deleting)
* `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
*/
statusBarHidden?: boolean;
/**
* Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting) `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled. On Android, requires `react-native-screens` version >=3.3.0.
* Sets the status bar color (similar to the `StatusBar` component). Requires enabling (or deleting)
* `View controller-based status bar appearance` in your Info.plist file and having `react-native-screens` enabled.
* On Android, requires `react-native-screens` version >=3.3.0.
*/
statusBarStyle?: 'inverted' | 'auto' | 'light' | 'dark';
/**