modernize AppContainer and add rootTag in the child context

Summary:
This does 2 things:
- modernize the component to use ES6 + flow
- assign `rootTag` to the child context

Each view in RN has its own `reactTag`. The reactTag for a root view is called `rootTag`. When there are multiple react root views active within the app (e.g. in a hybrid environment), rootTag is the only reliable "label" to differentiate them. This is especially useful when we want to limit an event/activity on a particular root view, instead of affecting all active root views. This allows components to do:

```
class Foo extends React.Component {
  static contextTypes = {
    rootTag: React.PropTypes.number,
  };

  componentDidMount() {
    // Get the root tag of this component, which is static for all components under the same root view
    console.log(this.context.rootTag);
  }
}
```

In a pure JS RN app environment, there will always be exactly 1 root view, so `rootTag` may usually be ignored.

Reviewed By: yungsters

Differential Revision: D4130376

fbshipit-source-id: 559b67615f487bad754b5832ad4a02bcef05be2a
This commit is contained in:
Kevin Gozali 2016-11-06 20:49:10 -08:00 committed by Facebook Github Bot
parent 6c04b3597d
commit fb7fe2d4e8
2 changed files with 72 additions and 40 deletions

View File

@ -7,62 +7,94 @@
* of patent rights can be found in the PATENTS file in the same directory. * of patent rights can be found in the PATENTS file in the same directory.
* *
* @providesModule AppContainer * @providesModule AppContainer
* @noflow * @flow
*/ */
'use strict'; 'use strict';
var RCTDeviceEventEmitter = require('RCTDeviceEventEmitter'); const EmitterSubscription = require('EmitterSubscription');
var React = require('React'); const RCTDeviceEventEmitter = require('RCTDeviceEventEmitter');
var ReactNative = require('ReactNative'); const React = require('React');
var StyleSheet = require('StyleSheet'); const ReactNative = require('ReactNative');
var Subscribable = require('Subscribable'); const StyleSheet = require('StyleSheet');
var View = require('View'); const View = require('View');
var Inspector = __DEV__ ? require('Inspector') : null; // TODO (fkg): make rootTag required
var YellowBox = __DEV__ ? require('YellowBox') : null; type Context = {
rootTag: ?number,
};
type Props = {
children?: React.Children,
rootTag?: number,
};
type State = {
inspector: ?React.Element<*>,
mainKey: number,
};
var AppContainer = React.createClass({ class AppContainer extends React.Component {
mixins: [Subscribable.Mixin], props: Props;
state: State = {
inspector: null,
mainKey: 1,
};
_mainRef: ?React.Element<*>;
_subscription: ?EmitterSubscription = null;
getInitialState: function() { static childContextTypes = {
return { inspector: null, mainKey: 1 }; rootTag: React.PropTypes.number,
}, };
toggleElementInspector: function() { getChildContext(): Context {
var inspector = !__DEV__ || this.state.inspector return {
rootTag: this.props.rootTag,
};
}
componentDidMount(): void {
if (__DEV__) {
this._subscription = RCTDeviceEventEmitter.addListener(
'toggleElementInspector',
() => {
const Inspector = require('Inspector');
const inspector = this.state.inspector
? null ? null
: <Inspector : <Inspector
inspectedViewTag={ReactNative.findNodeHandle(this.refs.main)} inspectedViewTag={ReactNative.findNodeHandle(this._mainRef)}
onRequestRerenderApp={(updateInspectedViewTag) => { onRequestRerenderApp={(updateInspectedViewTag) => {
this.setState( this.setState(
(s) => ({mainKey: s.mainKey + 1}), (s) => ({mainKey: s.mainKey + 1}),
() => updateInspectedViewTag(ReactNative.findNodeHandle(this.refs.main)) () => updateInspectedViewTag(
ReactNative.findNodeHandle(this._mainRef)
)
); );
}} }}
/>; />;
this.setState({inspector}); this.setState({inspector});
}, },
componentDidMount: function() {
this.addListenerOn(
RCTDeviceEventEmitter,
'toggleElementInspector',
this.toggleElementInspector
); );
}, }
}
render: function() { componentWillUnmount(): void {
if (this._subscription) {
this._subscription.remove();
}
}
render(): React.Element<*> {
let yellowBox = null; let yellowBox = null;
if (__DEV__) { if (__DEV__) {
const YellowBox = require('YellowBox');
yellowBox = <YellowBox />; yellowBox = <YellowBox />;
} }
return ( return (
<View style={styles.appContainer}> <View style={styles.appContainer}>
<View <View
collapsable={!this.state.inspector} collapsable={!this.state.inspector}
key={this.state.mainKey} key={this.state.mainKey}
style={styles.appContainer} ref="main"> style={styles.appContainer} ref={(ref) => {this._mainRef = ref;}}>
{this.props.children} {this.props.children}
</View> </View>
{yellowBox} {yellowBox}
@ -70,9 +102,9 @@ var AppContainer = React.createClass({
</View> </View>
); );
} }
}); }
var styles = StyleSheet.create({ const styles = StyleSheet.create({
appContainer: { appContainer: {
flex: 1, flex: 1,
}, },

View File

@ -31,7 +31,7 @@ function renderApplication<Props>(
'Expect to have a valid rootTag, instead got ', rootTag 'Expect to have a valid rootTag, instead got ', rootTag
); );
ReactNative.render( ReactNative.render(
<AppContainer> <AppContainer rootTag={rootTag}>
<RootComponent <RootComponent
{...initialProps} {...initialProps}
rootTag={rootTag} rootTag={rootTag}