Skip to content

Commit

Permalink
RN: Move { => Deprecated}ImageProp{s => Types} (Android)
Browse files Browse the repository at this point in the history
Summary:
Moves `ImagePropTypes` out of `Image.android.js` in preparation for some cleanup.

Changelog:
[Internal]

Reviewed By: TheSavior

Differential Revision: D29017076

fbshipit-source-id: e7d3d6533f69dc2c54e7c25e215648d7c7ff1840
  • Loading branch information
yungsters authored and facebook-github-bot committed Jun 12, 2021
1 parent 974f0a3 commit efefae9
Show file tree
Hide file tree
Showing 3 changed files with 134 additions and 119 deletions.
131 changes: 131 additions & 0 deletions Libraries/DeprecatedPropTypes/DeprecatedImagePropType.android.js
@@ -0,0 +1,131 @@
/**
* 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.
*
* @flow
* @format
*/

'use strict';

const DeprecatedImageStylePropTypes = require('./DeprecatedImageStylePropTypes');
const DeprecatedStyleSheetPropType = require('./DeprecatedStyleSheetPropType');
const DeprecatedViewPropTypes = require('./DeprecatedViewPropTypes');
const PropTypes = require('prop-types');

const DeprecatedImagePropType = {
...DeprecatedViewPropTypes,
style: (DeprecatedStyleSheetPropType(
DeprecatedImageStylePropTypes,
): ReactPropsCheckType),
/**
* See https://reactnative.dev/docs/image.html#source
*/
source: (PropTypes.oneOfType([
PropTypes.shape({
uri: PropTypes.string,
headers: PropTypes.objectOf(PropTypes.string),
}),
// Opaque type returned by require('./image.jpg')
PropTypes.number,
// Multiple sources
PropTypes.arrayOf(
PropTypes.shape({
uri: PropTypes.string,
width: PropTypes.number,
height: PropTypes.number,
headers: PropTypes.objectOf(PropTypes.string),
}),
),
]): React$PropType$Primitive<
| {
headers?: {[string]: string, ...},
uri?: string,
...
}
| number
| Array<{
headers?: {[string]: string, ...},
height?: number,
uri?: string,
width?: number,
...
}>,
>),
/**
* blurRadius: the blur radius of the blur filter added to the image
*
* See https://reactnative.dev/docs/image.html#blurradius
*/
blurRadius: PropTypes.number,
/**
* See https://reactnative.dev/docs/image.html#defaultsource
*/
defaultSource: PropTypes.number,
/**
* See https://reactnative.dev/docs/image.html#loadingindicatorsource
*/
loadingIndicatorSource: (PropTypes.oneOfType([
PropTypes.shape({
uri: PropTypes.string,
}),
// Opaque type returned by require('./image.jpg')
PropTypes.number,
]): React$PropType$Primitive<{uri?: string, ...} | number>),
progressiveRenderingEnabled: PropTypes.bool,
fadeDuration: PropTypes.number,
/**
* Analytics Tag used by this Image
*/
internal_analyticTag: PropTypes.string,
/**
* Invoked on load start
*/
onLoadStart: PropTypes.func,
/**
* Invoked on load error
*/
onError: PropTypes.func,
/**
* Invoked when load completes successfully
*/
onLoad: PropTypes.func,
/**
* Invoked when load either succeeds or fails
*/
onLoadEnd: PropTypes.func,
/**
* Used to locate this view in end-to-end tests.
*/
testID: PropTypes.string,
/**
* The mechanism that should be used to resize the image when the image's dimensions
* differ from the image view's dimensions. Defaults to `auto`.
*
* See https://reactnative.dev/docs/image.html#resizemethod
*/
resizeMethod: (PropTypes.oneOf([
'auto',
'resize',
'scale',
]): React$PropType$Primitive<'auto' | 'resize' | 'scale'>),
/**
* Determines how to resize the image when the frame doesn't match the raw
* image dimensions.
*
* See https://reactnative.dev/docs/image.html#resizemode
*/
resizeMode: (PropTypes.oneOf([
'cover',
'contain',
'stretch',
'repeat',
'center',
]): React$PropType$Primitive<
'cover' | 'contain' | 'stretch' | 'repeat' | 'center',
>),
};

module.exports = DeprecatedImagePropType;
122 changes: 3 additions & 119 deletions Libraries/Image/Image.android.js
Expand Up @@ -8,11 +8,8 @@
* @format
*/

import DeprecatedImageStylePropTypes from '../DeprecatedPropTypes/DeprecatedImageStylePropTypes';
import DeprecatedStyleSheetPropType from '../DeprecatedPropTypes/DeprecatedStyleSheetPropType';
import DeprecatedViewPropTypes from '../DeprecatedPropTypes/DeprecatedViewPropTypes';
import DeprecatedImagePropType from '../DeprecatedPropTypes/DeprecatedImagePropType';
import ImageViewNativeComponent from './ImageViewNativeComponent';
import PropTypes from 'prop-types';
import * as React from 'react';
import StyleSheet from '../StyleSheet/StyleSheet';
import TextAncestor from '../Text/TextAncestor';
Expand All @@ -33,119 +30,6 @@ function generateRequestId() {
return _requestId++;
}

const ImageProps = {
...DeprecatedViewPropTypes,
style: (DeprecatedStyleSheetPropType(
DeprecatedImageStylePropTypes,
): ReactPropsCheckType),
/**
* See https://reactnative.dev/docs/image.html#source
*/
source: (PropTypes.oneOfType([
PropTypes.shape({
uri: PropTypes.string,
headers: PropTypes.objectOf(PropTypes.string),
}),
// Opaque type returned by require('./image.jpg')
PropTypes.number,
// Multiple sources
PropTypes.arrayOf(
PropTypes.shape({
uri: PropTypes.string,
width: PropTypes.number,
height: PropTypes.number,
headers: PropTypes.objectOf(PropTypes.string),
}),
),
]): React$PropType$Primitive<
| {
headers?: {[string]: string, ...},
uri?: string,
...
}
| number
| Array<{
headers?: {[string]: string, ...},
height?: number,
uri?: string,
width?: number,
...
}>,
>),
/**
* blurRadius: the blur radius of the blur filter added to the image
*
* See https://reactnative.dev/docs/image.html#blurradius
*/
blurRadius: PropTypes.number,
/**
* See https://reactnative.dev/docs/image.html#defaultsource
*/
defaultSource: PropTypes.number,
/**
* See https://reactnative.dev/docs/image.html#loadingindicatorsource
*/
loadingIndicatorSource: (PropTypes.oneOfType([
PropTypes.shape({
uri: PropTypes.string,
}),
// Opaque type returned by require('./image.jpg')
PropTypes.number,
]): React$PropType$Primitive<{uri?: string, ...} | number>),
progressiveRenderingEnabled: PropTypes.bool,
fadeDuration: PropTypes.number,
/**
* Analytics Tag used by this Image
*/
internal_analyticTag: PropTypes.string,
/**
* Invoked on load start
*/
onLoadStart: PropTypes.func,
/**
* Invoked on load error
*/
onError: PropTypes.func,
/**
* Invoked when load completes successfully
*/
onLoad: PropTypes.func,
/**
* Invoked when load either succeeds or fails
*/
onLoadEnd: PropTypes.func,
/**
* Used to locate this view in end-to-end tests.
*/
testID: PropTypes.string,
/**
* The mechanism that should be used to resize the image when the image's dimensions
* differ from the image view's dimensions. Defaults to `auto`.
*
* See https://reactnative.dev/docs/image.html#resizemethod
*/
resizeMethod: (PropTypes.oneOf([
'auto',
'resize',
'scale',
]): React$PropType$Primitive<'auto' | 'resize' | 'scale'>),
/**
* Determines how to resize the image when the frame doesn't match the raw
* image dimensions.
*
* See https://reactnative.dev/docs/image.html#resizemode
*/
resizeMode: (PropTypes.oneOf([
'cover',
'contain',
'stretch',
'repeat',
'center',
]): React$PropType$Primitive<
'cover' | 'contain' | 'stretch' | 'repeat' | 'center',
>),
};

/**
* Retrieve the width and height (in pixels) of an image prior to displaying it
*
Expand Down Expand Up @@ -231,7 +115,7 @@ type ImageComponentStatics = $ReadOnly<{|
abortPrefetch: typeof abortPrefetch,
queryCache: typeof queryCache,
resolveAssetSource: typeof resolveAssetSource,
propTypes: typeof ImageProps,
propTypes: typeof DeprecatedImagePropType,
|}>;

/**
Expand Down Expand Up @@ -411,7 +295,7 @@ Image.resolveAssetSource = resolveAssetSource;
/* $FlowFixMe(>=0.89.0 site=react_native_android_fb) This comment suppresses an
* error found when Flow v0.89 was deployed. To see the error, delete this
* comment and run Flow. */
Image.propTypes = ImageProps;
Image.propTypes = DeprecatedImagePropType;

const styles = StyleSheet.create({
base: {
Expand Down

0 comments on commit efefae9

Please sign in to comment.