AndroidSwipeRefreshLayout (#23039)

Summary:
Changelog:
----------

[iOS] [Changed] - moved RCTRefreshControl from RefreshControl as a separate component, as mentioned in #22990
[Android] [Changed] - moved AndroidSwipeRefreshLayout from RefreshControl as a separate component, as mentioned in #22990
Pull Request resolved: https://github.com/facebook/react-native/pull/23039

Reviewed By: rickhanlonii

Differential Revision: D13710076

Pulled By: cpojer

fbshipit-source-id: 332520b74d6fc73e50dbe511dae22f82015c2d3a
This commit is contained in:
jesse 2019-01-18 02:16:59 -08:00 committed by Facebook Github Bot
parent 707622ac84
commit b864b6cf3e
3 changed files with 154 additions and 19 deletions

View File

@ -0,0 +1,68 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow
*/
'use strict';
const requireNativeComponent = require('requireNativeComponent');
import type {ColorValue} from 'StyleSheetTypes';
import type {ViewProps} from 'ViewPropTypes';
import type {NativeComponent} from 'ReactNative';
const AndroidSwipeRefreshLayout = require('UIManager').getViewManagerConfig(
'AndroidSwipeRefreshLayout',
);
const RefreshLayoutConsts = AndroidSwipeRefreshLayout
? AndroidSwipeRefreshLayout.Constants
: {SIZE: {}};
type NativeProps = $ReadOnly<{|
...ViewProps,
/**
* Whether the pull to refresh functionality is enabled.
*/
enabled?: ?boolean,
/**
* The colors (at least one) that will be used to draw the refresh indicator.
*/
colors?: ?$ReadOnlyArray<ColorValue>,
/**
* The background color of the refresh indicator.
*/
progressBackgroundColor?: ?ColorValue,
/**
* Size of the refresh indicator, see RefreshControl.SIZE.
*/
size?: ?(
| typeof RefreshLayoutConsts.SIZE.DEFAULT
| typeof RefreshLayoutConsts.SIZE.LARGE
),
/**
* Progress view top offset
*/
progressViewOffset?: ?number,
/**
* Called when the view starts refreshing.
*/
onRefresh?: ?() => mixed,
/**
* Whether the view should be indicating an active refresh.
*/
refreshing: boolean,
|}>;
type AndroidSwipeRefreshLayoutNativeType = Class<NativeComponent<NativeProps>>;
module.exports = ((requireNativeComponent(
'AndroidSwipeRefreshLayout',
): any): AndroidSwipeRefreshLayoutNativeType);

View File

@ -0,0 +1,50 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @format
* @flow
*/
'use strict';
const requireNativeComponent = require('requireNativeComponent');
import type {ColorValue} from 'StyleSheetTypes';
import type {ViewProps} from 'ViewPropTypes';
import type {NativeComponent} from 'ReactNative';
export type NativeProps = $ReadOnly<{|
...ViewProps,
/**
* The color of the refresh indicator.
*/
tintColor?: ?ColorValue,
/**
* Title color.
*/
titleColor?: ?ColorValue,
/**
* The title displayed under the refresh indicator.
*/
title?: ?string,
/**
* Called when the view starts refreshing.
*/
onRefresh?: ?() => mixed,
/**
* Whether the view should be indicating an active refresh.
*/
refreshing: boolean,
|}>;
type RCTRefreshControlNativeType = Class<NativeComponent<NativeProps>>;
module.exports = ((requireNativeComponent(
'RCTRefreshControl',
): any): RCTRefreshControlNativeType);

View File

@ -14,7 +14,8 @@ const Platform = require('Platform');
const React = require('React');
const {NativeComponent} = require('ReactNative');
const requireNativeComponent = require('requireNativeComponent');
const AndroidSwipeRefreshLayoutNativeComponent = require('AndroidSwipeRefreshLayoutNativeComponent');
const RCTRefreshControlNativeComponent = require('RCTRefreshControlNativeComponent');
const nullthrows = require('nullthrows');
import type {ColorValue} from 'StyleSheetTypes';
@ -31,12 +32,6 @@ if (Platform.OS === 'android') {
} else {
RefreshLayoutConsts = {SIZE: {}};
}
type NativeRefreshControlType = Class<NativeComponent<RefreshControlProps>>;
const NativeRefreshControl: NativeRefreshControlType =
Platform.OS === 'ios'
? (requireNativeComponent('RCTRefreshControl'): any)
: (requireNativeComponent('AndroidSwipeRefreshLayout'): any);
type IOSProps = $ReadOnly<{|
/**
@ -143,7 +138,7 @@ export type RefreshControlProps = $ReadOnly<{|
class RefreshControl extends React.Component<RefreshControlProps> {
static SIZE = RefreshLayoutConsts.SIZE;
_nativeRef: ?React.ElementRef<NativeRefreshControlType> = null;
_setNativePropsOnRef: ?({refreshing: boolean}) => void;
_lastNativeRefreshing = false;
componentDidMount() {
@ -156,8 +151,11 @@ class RefreshControl extends React.Component<RefreshControlProps> {
// the js value.
if (this.props.refreshing !== prevProps.refreshing) {
this._lastNativeRefreshing = this.props.refreshing;
} else if (this.props.refreshing !== this._lastNativeRefreshing) {
nullthrows(this._nativeRef).setNativeProps({
} else if (
this.props.refreshing !== this._lastNativeRefreshing &&
this._setNativePropsOnRef
) {
this._setNativePropsOnRef({
refreshing: this.props.refreshing,
});
this._lastNativeRefreshing = this.props.refreshing;
@ -165,15 +163,34 @@ class RefreshControl extends React.Component<RefreshControlProps> {
}
render() {
const setRef = ref =>
(this._setNativePropsOnRef = ref ? ref.setNativeProps.bind(ref) : null);
if (Platform.OS === 'ios') {
const {
enabled,
colors,
progressBackgroundColor,
size,
progressViewOffset,
...props
} = this.props;
return (
<NativeRefreshControl
{...this.props}
ref={ref => {
this._nativeRef = ref;
}}
<RCTRefreshControlNativeComponent
{...props}
ref={setRef}
onRefresh={this._onRefresh}
/>
);
} else {
const {tintColor, titleColor, title, ...props} = this.props;
return (
<AndroidSwipeRefreshLayoutNativeComponent
{...props}
ref={setRef}
onRefresh={this._onRefresh}
/>
);
}
}
_onRefresh = () => {