The most fundamental component for building UI, View is a
container that supports layout with flexbox, style, some touch handling, and
accessibility controls, and is designed to be nested inside other views and
to have 0 to many children of any type. View maps directly to the native
view equivalent on whatever platform React is running on, whether that is a
UIView, <div>, android.view, etc. This example creates a View that
wraps two colored boxes and custom component in a row with padding.
<View style={{flexDirection: 'row', height: 100, padding: 20}}>
<View style={{backgroundColor: 'blue', flex: 0.3}} />
<View style={{backgroundColor: 'red', flex: 0.5}} />
<MyCustomComponent {...customProps} />
</View>
Views are designed to be used with StyleSheets for clarity and
performance, although inline styles are also supported.
accessibilityLabel string #
Overrides the text that's read by the screen reader when the user interacts
with the element. By default, the label is constructed by traversing all the
children and accumulating all the Text nodes separated by space.
accessibilityTraits AccessibilityTraits, [AccessibilityTraits] #
Provides additional traits to screen reader. By default no traits are
provided unless specified otherwise in element
accessible bool #
When true, indicates that the view is an accessibility element. By default,
all the touchable elements are accessible.
onAcccessibilityTap function #
When accessible is true, the system will try to invoke this function
when the user performs accessibility tap gesture.
onLayout function #
Invoked on mount and layout changes with
{nativeEvent: { layout: {x, y, width, height}}}.
onMagicTap function #
When accessible is true, the system will invoke this function when the
user performs the magic tap gesture.
onMoveShouldSetResponder function #
For most touch interactions, you'll simply want to wrap your component in
TouchableHighlight or TouchableOpacity. Check out Touchable.js,
ScrollResponder.js and ResponderEventPlugin.js for more discussion.
onResponderGrant function #
onResponderMove function #
onResponderReject function #
onResponderRelease function #
onResponderTerminate function #
onResponderTerminationRequest function #
onStartShouldSetResponder function #
onStartShouldSetResponderCapture function #
pointerEvents enum('box-none', 'none', 'box-only', 'auto') #
In the absence of auto property, none is much like CSS's none
value. box-none is as if you had applied the CSS class:
.box-none {
pointer-events: none;
}
.box-none * {
pointer-events: all;
}
box-only is the equivalent of
.box-only {
pointer-events: all;
}
.box-only * {
pointer-events: none;
}
But since pointerEvents does not affect layout/appearance, and we are
already deviating from the spec by adding additional modes, we opt to not
include pointerEvents on style. On some platforms, we would need to
implement it as a className anyways. Using style or not is an
implementation detail of the platform.
removeClippedSubviews bool #
This is a special performance property exposed by RCTView and is useful
for scrolling content when there are many subviews, most of which are
offscreen. For this property to be effective, it must be applied to a
view that contains many subviews that extend outside its bound. The
subviews must also have overflow: hidden, as should the containing view
(or one of its superviews).
renderToHardwareTextureAndroid bool #
Whether this view should render itself (and all of its children) into a
single hardware texture on the GPU.
On Android, this is useful for animations and interactions that only
modify opacity, rotation, translation, and/or scale: in those cases, the
view doesn't have to be redrawn and display lists don't need to be
re-executed. The texture can just be re-used and re-composited with
different parameters. The downside is that this can use up limited video
memory, so this prop should be set back to false at the end of the
interaction/animation.
style style #
backgroundColor string
borderBottomColor string
borderBottomLeftRadius number
borderBottomRightRadius number
borderColor string
borderLeftColor string
borderRadius number
borderRightColor string
borderTopColor string
borderTopLeftRadius number
borderTopRightRadius number
opacity number
overflow enum('visible', 'hidden')
shadowColor string
shadowOffset {width: number, height: number}
shadowOpacity number
shadowRadius number
testID string #
Used to locate this view in end-to-end tests.
'use strict';
var React = require('react-native');
var {
StyleSheet,
Text,
View,
} = React;
var styles = StyleSheet.create({
box: {
backgroundColor: '#527FE4',
borderColor: '#000033',
borderWidth: 1,
}
});
exports.title = '<View>';
exports.description = 'Basic building block of all UI.';
exports.displayName = 'ViewExample';
exports.examples = [
{
title: 'Background Color',
render: function() {
return (
<View style={{backgroundColor: '#527FE4', padding: 5}}>
<Text style={{fontSize: 11}}>
Blue background
</Text>
</View>
);
},
}, {
title: 'Border',
render: function() {
return (
<View style={{borderColor: '#527FE4', borderWidth: 5, padding: 10}}>
<Text style={{fontSize: 11}}>5px blue border</Text>
</View>
);
},
}, {
title: 'Padding/Margin',
render: function() {
return (
<View style={{borderColor: '#bb0000', borderWidth: 0.5}}>
<View style={[styles.box, {padding: 5}]}>
<Text style={{fontSize: 11}}>5px padding</Text>
</View>
<View style={[styles.box, {margin: 5}]}>
<Text style={{fontSize: 11}}>5px margin</Text>
</View>
<View style={[styles.box, {margin: 5, padding: 5, alignSelf: 'flex-start'}]}>
<Text style={{fontSize: 11}}>
5px margin and padding,
</Text>
<Text style={{fontSize: 11}}>
widthAutonomous=true
</Text>
</View>
</View>
);
},
}, {
title: 'Border Radius',
render: function() {
return (
<View style={{borderWidth: 0.5, borderRadius: 5, padding: 5}}>
<Text style={{fontSize: 11}}>
Too much use of `borderRadius` (especially large radii) on
anything which is scrolling may result in dropped frames.
Use sparingly.
</Text>
</View>
);
},
}, {
title: 'Circle with Border Radius',
render: function() {
return (
<View style={{borderRadius: 10, borderWidth: 1, width: 20, height: 20}} />
);
},
}, {
title: 'Overflow',
render: function() {
return (
<View style={{flexDirection: 'row'}}>
<View
style={{
width: 95,
height: 10,
marginRight: 10,
marginBottom: 5,
overflow: 'hidden',
borderWidth: 0.5,
}}>
<View style={{width: 200, height: 20}}>
<Text>Overflow hidden</Text>
</View>
</View>
<View style={{width: 95, height: 10, marginBottom: 5, borderWidth: 0.5}}>
<View style={{width: 200, height: 20}}>
<Text>Overflow visible</Text>
</View>
</View>
</View>
);
},
}, {
title: 'Opacity',
render: function() {
return (
<View>
<View style={{opacity: 0}}><Text>Opacity 0</Text></View>
<View style={{opacity: 0.1}}><Text>Opacity 0.1</Text></View>
<View style={{opacity: 0.3}}><Text>Opacity 0.3</Text></View>
<View style={{opacity: 0.5}}><Text>Opacity 0.5</Text></View>
<View style={{opacity: 0.7}}><Text>Opacity 0.7</Text></View>
<View style={{opacity: 0.9}}><Text>Opacity 0.9</Text></View>
<View style={{opacity: 1}}><Text>Opacity 1</Text></View>
</View>
);
},
},
];