mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Nick Gerleman
8cdc9e7f04
Summary: React Native's TS definitions are currently mostly stored in one monolithic file. This change splits the definitions up to correspond to the source files they came from, and are placed next to the source files. I think this should help inform, and make it easy to update the TS declarations when touching the Flow file. I noticed as part of the change that the typings have not yet removed many APIs that were removed from RN. This is bad, since it means using the removed/non-functional API doesn't cause typechecker errors. Locating typings next to source should prevent that from being able to happen. The organization here means individual TS declarations can declare what will be in the RN entrypoint, which is a little confusing. Seems like a good potential next refactor, beyond the literal translation I did. Changelog: [General][Changed] - Place TS Declarations Alongside Source Files Reviewed By: lunaleaps, rshest Differential Revision: D39796598 fbshipit-source-id: b36366466fd1976bdd2d4c8f7a4104a33c457a07
46 lines
1.5 KiB
TypeScript
46 lines
1.5 KiB
TypeScript
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
import type * as React from 'react';
|
|
import {Constructor, TimerMixin} from 'Utilities';
|
|
import {StyleProp} from '../../StyleSheet/StyleSheet';
|
|
import {ViewStyle} from '../../StyleSheet/StyleSheetTypes';
|
|
import {ViewProps} from '../View/ViewPropTypes';
|
|
|
|
/**
|
|
* It is a component to solve the common problem of views that need to move out of the way of the virtual keyboard.
|
|
* It can automatically adjust either its position or bottom padding based on the position of the keyboard.
|
|
*/
|
|
declare class KeyboardAvoidingViewComponent extends React.Component<KeyboardAvoidingViewProps> {}
|
|
declare const KeyboardAvoidingViewBase: Constructor<TimerMixin> &
|
|
typeof KeyboardAvoidingViewComponent;
|
|
export class KeyboardAvoidingView extends KeyboardAvoidingViewBase {}
|
|
|
|
export interface KeyboardAvoidingViewProps extends ViewProps {
|
|
behavior?: 'height' | 'position' | 'padding' | undefined;
|
|
|
|
/**
|
|
* The style of the content container(View) when behavior is 'position'.
|
|
*/
|
|
contentContainerStyle?: StyleProp<ViewStyle> | undefined;
|
|
|
|
/**
|
|
* This is the distance between the top of the user screen and the react native view,
|
|
* may be non-zero in some use cases.
|
|
*/
|
|
keyboardVerticalOffset?: number | undefined;
|
|
|
|
/**
|
|
* Enables or disables the KeyboardAvoidingView.
|
|
*
|
|
* Default is true
|
|
*/
|
|
enabled?: boolean | undefined;
|
|
}
|