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
85 lines
2.5 KiB
TypeScript
85 lines
2.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
|
|
*/
|
|
|
|
export type LayoutAnimationType =
|
|
| 'spring'
|
|
| 'linear'
|
|
| 'easeInEaseOut'
|
|
| 'easeIn'
|
|
| 'easeOut'
|
|
| 'keyboard';
|
|
|
|
export type LayoutAnimationTypes = {
|
|
[type in LayoutAnimationType]: type;
|
|
};
|
|
|
|
export type LayoutAnimationProperty =
|
|
| 'opacity'
|
|
| 'scaleX'
|
|
| 'scaleY'
|
|
| 'scaleXY';
|
|
|
|
export type LayoutAnimationProperties = {
|
|
[prop in LayoutAnimationProperty]: prop;
|
|
};
|
|
|
|
export interface LayoutAnimationAnim {
|
|
duration?: number | undefined;
|
|
delay?: number | undefined;
|
|
springDamping?: number | undefined;
|
|
initialVelocity?: number | undefined;
|
|
type?: LayoutAnimationType | undefined;
|
|
property?: LayoutAnimationProperty | undefined;
|
|
}
|
|
|
|
export interface LayoutAnimationConfig {
|
|
duration: number;
|
|
create?: LayoutAnimationAnim | undefined;
|
|
update?: LayoutAnimationAnim | undefined;
|
|
delete?: LayoutAnimationAnim | undefined;
|
|
}
|
|
|
|
/** Automatically animates views to their new positions when the next layout happens.
|
|
* A common way to use this API is to call LayoutAnimation.configureNext before
|
|
* calling setState. */
|
|
export interface LayoutAnimationStatic {
|
|
/** Schedules an animation to happen on the next layout.
|
|
* @param config Specifies animation properties:
|
|
* `duration` in milliseconds
|
|
* `create`, config for animating in new views (see Anim type)
|
|
* `update`, config for animating views that have been updated (see Anim type)
|
|
* @param onAnimationDidEnd Called when the animation finished. Only supported on iOS.
|
|
*/
|
|
configureNext: (
|
|
config: LayoutAnimationConfig,
|
|
onAnimationDidEnd?: () => void,
|
|
onAnimationDidFail?: () => void,
|
|
) => void;
|
|
/** Helper for creating a config for configureNext. */
|
|
create: (
|
|
duration: number,
|
|
type?: LayoutAnimationType,
|
|
creationProp?: LayoutAnimationProperty,
|
|
) => LayoutAnimationConfig;
|
|
Types: LayoutAnimationTypes;
|
|
Properties: LayoutAnimationProperties;
|
|
configChecker: (shapeTypes: {[key: string]: any}) => any;
|
|
Presets: {
|
|
easeInEaseOut: LayoutAnimationConfig;
|
|
linear: LayoutAnimationConfig;
|
|
spring: LayoutAnimationConfig;
|
|
};
|
|
easeInEaseOut: (onAnimationDidEnd?: () => void) => void;
|
|
linear: (onAnimationDidEnd?: () => void) => void;
|
|
spring: (onAnimationDidEnd?: () => void) => void;
|
|
}
|
|
|
|
export const LayoutAnimation: LayoutAnimationStatic;
|
|
export type LayoutAnimation = LayoutAnimationStatic;
|