diff --git a/Libraries/Modal/Modal.js b/Libraries/Modal/Modal.js index 8e3a88665..1124b904a 100644 --- a/Libraries/Modal/Modal.js +++ b/Libraries/Modal/Modal.js @@ -19,6 +19,18 @@ var View = require('View'); var requireNativeComponent = require('requireNativeComponent'); var RCTModalHostView = requireNativeComponent('RCTModalHostView', null); +/** + * A Modal component covers the native view (e.g. UIViewController, Activity) + * that contains the React Native root. + * + * Use Modal in hybrid apps that embed React Native; Modal allows the portion of + * your app written in React Native to present content above the enclosing + * native view hierarchy. + * + * In apps written with React Native from the root view down, you should use + * Navigator instead of Modal. With a top-level Navigator, you have more control + * over how to present the modal scene over the rest of your app. + */ class Modal extends React.Component { render(): ?ReactElement { if (this.props.visible === false) {