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
88 lines
2.3 KiB
TypeScript
88 lines
2.3 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';
|
|
|
|
export interface RefreshControlPropsIOS extends ViewProps {
|
|
/**
|
|
* The color of the refresh indicator.
|
|
*/
|
|
tintColor?: ColorValue | undefined;
|
|
|
|
/**
|
|
* The title displayed under the refresh indicator.
|
|
*/
|
|
title?: string | undefined;
|
|
|
|
/**
|
|
* Title color.
|
|
*/
|
|
titleColor?: ColorValue | undefined;
|
|
}
|
|
|
|
export interface RefreshControlPropsAndroid extends ViewProps {
|
|
/**
|
|
* The colors (at least one) that will be used to draw the refresh indicator.
|
|
*/
|
|
colors?: ColorValue[] | undefined;
|
|
|
|
/**
|
|
* Whether the pull to refresh functionality is enabled.
|
|
*/
|
|
enabled?: boolean | undefined;
|
|
|
|
/**
|
|
* The background color of the refresh indicator.
|
|
*/
|
|
progressBackgroundColor?: ColorValue | undefined;
|
|
|
|
/**
|
|
* Size of the refresh indicator, see RefreshControl.SIZE.
|
|
*/
|
|
size?: number | undefined;
|
|
}
|
|
|
|
export interface RefreshControlProps
|
|
extends RefreshControlPropsIOS,
|
|
RefreshControlPropsAndroid {
|
|
/**
|
|
* Called when the view starts refreshing.
|
|
*/
|
|
onRefresh?: (() => void) | undefined;
|
|
|
|
/**
|
|
* Whether the view should be indicating an active refresh.
|
|
*/
|
|
refreshing: boolean;
|
|
|
|
/**
|
|
* Progress view top offset
|
|
*/
|
|
progressViewOffset?: number | undefined;
|
|
}
|
|
|
|
/**
|
|
* This component is used inside a ScrollView or ListView to add pull to refresh
|
|
* functionality. When the ScrollView is at `scrollY: 0`, swiping down
|
|
* triggers an `onRefresh` event.
|
|
*
|
|
* __Note:__ `refreshing` is a controlled prop, this is why it needs to be set to true
|
|
* in the `onRefresh` function otherwise the refresh indicator will stop immediately.
|
|
*/
|
|
declare class RefreshControlComponent extends React.Component<RefreshControlProps> {}
|
|
declare const RefreshControlBase: Constructor<NativeMethods> &
|
|
typeof RefreshControlComponent;
|
|
export class RefreshControl extends RefreshControlBase {
|
|
static SIZE: Object; // Undocumented
|
|
}
|