Add comments about nativeOnly props

sahrens · sahrens · commit bb79d034d2d4 · 2015-09-15T10:37:48.000-07:00
diff --git a/docs/NativeComponentsIOS.md b/docs/NativeComponentsIOS.md
@@ -212,6 +212,14 @@ MapView.propTypes = {
 
 Here you can see that the shape of the region is explicit in the JS documentation - ideally we could codegen some of this stuff, but that's not happening yet.
 
+Sometimes you'll have some special properties that you need to expose for the native component, but don't actually want them as part of the API for the associated React component.  For example, `Switch` has a custom `onChange` handler for the raw native event, and exposes an `onValueChange` handler property that is invoked with just the boolean value rather than the raw event.  Since you don't want these native only properties to be part of the API, you don't want to put them in `propTypes`, but if you don't you'll get an error.  The solution is simply to call them out via the `nativeOnly` option, e.g.
+
+```javascript
+var RCTSwitch = requireNativeComponent('RCTSwitch', Switch, {
+  nativeOnly: { onChange: true }
+});
+```
+
 ## Events
 
 So now we have a native map component that we can control easily from JS, but how do we deal with events from the user, like pinch-zooms or panning to change the visible region?  The key is to make the `RCTMapManager` a delegate for all the views it vends, and forward the events to JS via the event dispatcher.  This looks like so (simplified from the full implementation):
