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
84 lines
2.4 KiB
TypeScript
84 lines
2.4 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} from 'Utilities';
|
|
import {NativeMethods} from '../../Renderer/shims/ReactNativeTypes';
|
|
import {ColorValue} from '../../StyleSheet/StyleSheet';
|
|
import {ViewProps} from '../View/ViewPropTypes';
|
|
|
|
/**
|
|
* ProgressBarAndroid has been extracted from react-native core and will be removed in a future release.
|
|
* It can now be installed and imported from `@react-native-community/progress-bar-android` instead of 'react-native'.
|
|
* @see https://github.com/react-native-community/progress-bar-android
|
|
* @deprecated
|
|
*/
|
|
export interface ProgressBarAndroidProps extends ViewProps {
|
|
/**
|
|
* Style of the ProgressBar. One of:
|
|
Horizontal
|
|
Normal (default)
|
|
Small
|
|
Large
|
|
Inverse
|
|
SmallInverse
|
|
LargeInverse
|
|
*/
|
|
styleAttr?:
|
|
| 'Horizontal'
|
|
| 'Normal'
|
|
| 'Small'
|
|
| 'Large'
|
|
| 'Inverse'
|
|
| 'SmallInverse'
|
|
| 'LargeInverse'
|
|
| undefined;
|
|
|
|
/**
|
|
* If the progress bar will show indeterminate progress.
|
|
* Note that this can only be false if styleAttr is Horizontal.
|
|
*/
|
|
indeterminate?: boolean | undefined;
|
|
|
|
/**
|
|
* The progress value (between 0 and 1).
|
|
*/
|
|
progress?: number | undefined;
|
|
|
|
/**
|
|
* Whether to show the ProgressBar (true, the default) or hide it (false).
|
|
*/
|
|
animating?: boolean | undefined;
|
|
|
|
/**
|
|
* Color of the progress bar.
|
|
*/
|
|
color?: ColorValue | undefined;
|
|
|
|
/**
|
|
* Used to locate this view in end-to-end tests.
|
|
*/
|
|
testID?: string | undefined;
|
|
}
|
|
|
|
/**
|
|
* React component that wraps the Android-only `ProgressBar`. This component is used to indicate
|
|
* that the app is loading or there is some activity in the app.
|
|
*/
|
|
declare class ProgressBarAndroidComponent extends React.Component<ProgressBarAndroidProps> {}
|
|
declare const ProgressBarAndroidBase: Constructor<NativeMethods> &
|
|
typeof ProgressBarAndroidComponent;
|
|
/**
|
|
* ProgressBarAndroid has been extracted from react-native core and will be removed in a future release.
|
|
* It can now be installed and imported from `@react-native-community/progress-bar-android` instead of 'react-native'.
|
|
* @see https://github.com/react-native-progress-view/progress-bar-android
|
|
* @deprecated
|
|
*/
|
|
export class ProgressBarAndroid extends ProgressBarAndroidBase {}
|