mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Jesse Katsumata
dbd5c3d8e5
Summary: Added FlowType definition for ImageBackground component Props ## Changelog [General] [Changed] - Add ImageBackground component type definition [General] [Fixed] - ImageBackground now respects `imageStyle` width and height Pull Request resolved: https://github.com/facebook/react-native/pull/32099 Test Plan: - [ ] flow check passes - [ ] rn-tester app runs Reviewed By: charlesbdudley Differential Revision: D30597737 Pulled By: yungsters fbshipit-source-id: 9699ee2bb727a1a8f30d6ffe3a2845c8a134e89d
93 lines
2.7 KiB
JavaScript
93 lines
2.7 KiB
JavaScript
/**
|
|
* 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';
|
|
|
|
import Image from './Image';
|
|
import * as React from 'react';
|
|
import StyleSheet from '../StyleSheet/StyleSheet';
|
|
import flattenStyle from '../StyleSheet/flattenStyle';
|
|
import View from '../Components/View/View';
|
|
import type {ImageBackgroundProps} from './ImageProps';
|
|
|
|
/**
|
|
* Very simple drop-in replacement for <Image> which supports nesting views.
|
|
*
|
|
* ```ReactNativeWebPlayer
|
|
* import React, { Component } from 'react';
|
|
* import { AppRegistry, View, ImageBackground, Text } from 'react-native';
|
|
*
|
|
* class DisplayAnImageBackground extends Component {
|
|
* render() {
|
|
* return (
|
|
* <ImageBackground
|
|
* style={{width: 50, height: 50}}
|
|
* source={{uri: 'https://reactnative.dev/img/opengraph.png'}}
|
|
* >
|
|
* <Text>React</Text>
|
|
* </ImageBackground>
|
|
* );
|
|
* }
|
|
* }
|
|
*
|
|
* // App registration and rendering
|
|
* AppRegistry.registerComponent('DisplayAnImageBackground', () => DisplayAnImageBackground);
|
|
* ```
|
|
*/
|
|
class ImageBackground extends React.Component<ImageBackgroundProps> {
|
|
setNativeProps(props: Object) {
|
|
// Work-around flow
|
|
const viewRef = this._viewRef;
|
|
if (viewRef) {
|
|
viewRef.setNativeProps(props);
|
|
}
|
|
}
|
|
|
|
_viewRef: ?React.ElementRef<typeof View> = null;
|
|
|
|
_captureRef = ref => {
|
|
this._viewRef = ref;
|
|
};
|
|
|
|
render(): React.Node {
|
|
const {children, style, imageStyle, imageRef, ...props} = this.props;
|
|
const flattenedStyle = flattenStyle(style);
|
|
return (
|
|
<View
|
|
accessibilityIgnoresInvertColors={true}
|
|
style={style}
|
|
ref={this._captureRef}>
|
|
<Image
|
|
{...props}
|
|
style={[
|
|
StyleSheet.absoluteFill,
|
|
{
|
|
// Temporary Workaround:
|
|
// Current (imperfect yet) implementation of <Image> overwrites width and height styles
|
|
// (which is not quite correct), and these styles conflict with explicitly set styles
|
|
// of <ImageBackground> and with our internal layout model here.
|
|
// So, we have to proxy/reapply these styles explicitly for actual <Image> component.
|
|
// This workaround should be removed after implementing proper support of
|
|
// intrinsic content size of the <Image>.
|
|
width: flattenedStyle?.width,
|
|
height: flattenedStyle?.height,
|
|
},
|
|
imageStyle,
|
|
]}
|
|
ref={imageRef}
|
|
/>
|
|
{children}
|
|
</View>
|
|
);
|
|
}
|
|
}
|
|
|
|
module.exports = ImageBackground;
|