mirror of
https://github.com/zhigang1992/react-navigation.git
synced 2026-04-30 13:22:13 +08:00
fix: format comments in types
This commit is contained in:
@@ -83,6 +83,7 @@ export type TabBarVisibilityAnimationConfig =
|
|||||||
export type NativeScreenTraitsProps = {
|
export type NativeScreenTraitsProps = {
|
||||||
/**
|
/**
|
||||||
* In which orientation should the screen appear. It requires having `react-native-screens` enabled.
|
* 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:
|
* 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.
|
* - "default" - resolves to "all" without "portrait_down" on iOS. On Android, this lets the system decide the best orientation.
|
||||||
* - "all" – all orientations are permitted
|
* - "all" – all orientations are permitted
|
||||||
@@ -103,21 +104,28 @@ export type NativeScreenTraitsProps = {
|
|||||||
| 'landscape_left'
|
| 'landscape_left'
|
||||||
| 'landscape_right';
|
| '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';
|
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
|
* @platform android
|
||||||
*/
|
*/
|
||||||
statusBarColor?: string;
|
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;
|
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';
|
statusBarStyle?: 'inverted' | 'auto' | 'light' | 'dark';
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -52,6 +52,7 @@ export type DrawerNavigationConfig = {
|
|||||||
export type NativeScreenTraitsProps = {
|
export type NativeScreenTraitsProps = {
|
||||||
/**
|
/**
|
||||||
* In which orientation should the screen appear. It requires having `react-native-screens` enabled.
|
* 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:
|
* 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.
|
* - "default" - resolves to "all" without "portrait_down" on iOS. On Android, this lets the system decide the best orientation.
|
||||||
* - "all" – all orientations are permitted
|
* - "all" – all orientations are permitted
|
||||||
@@ -72,21 +73,28 @@ export type NativeScreenTraitsProps = {
|
|||||||
| 'landscape_left'
|
| 'landscape_left'
|
||||||
| 'landscape_right';
|
| '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';
|
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
|
* @platform android
|
||||||
*/
|
*/
|
||||||
statusBarColor?: string;
|
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;
|
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';
|
statusBarStyle?: 'inverted' | 'auto' | 'light' | 'dark';
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -202,6 +202,7 @@ export type StackDescriptorMap = Record<string, StackDescriptor>;
|
|||||||
export type NativeScreenTraitsProps = {
|
export type NativeScreenTraitsProps = {
|
||||||
/**
|
/**
|
||||||
* In which orientation should the screen appear. It requires having `react-native-screens` enabled.
|
* 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:
|
* 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.
|
* - "default" - resolves to "all" without "portrait_down" on iOS. On Android, this lets the system decide the best orientation.
|
||||||
* - "all" – all orientations are permitted
|
* - "all" – all orientations are permitted
|
||||||
@@ -222,21 +223,28 @@ export type NativeScreenTraitsProps = {
|
|||||||
| 'landscape_left'
|
| 'landscape_left'
|
||||||
| 'landscape_right';
|
| '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';
|
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
|
* @platform android
|
||||||
*/
|
*/
|
||||||
statusBarColor?: string;
|
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;
|
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';
|
statusBarStyle?: 'inverted' | 'auto' | 'light' | 'dark';
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user