status-im
/
react-native
mirror of https://github.com/status-im/react-native.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

remove the undocumented @provideModules 

Using relative file path
This commit is contained in:
sunnylqm 2015-12-14 15:10:00 +08:00
parent e919567323
commit a1077ba6e9
1 changed files with 2 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/NativeModulesAndroid.md
View File

@ -125,12 +125,7 @@ mReactInstanceManager = ReactInstanceManager.builder()
To make it simpler to access your new functionality from JavaScript, it is common to wrap the native module in a JavaScript module. This is not necessary but saves the consumers of your library the need to pull it off of `NativeModules` each time. This JavaScript file also becomes a good location for you to add any JavaScript side functionality.
```js
/**
* @providesModule ToastAndroid
*/
'use strict';
/**
* This exposes the native ToastAndroid module as a JS module. This has a function 'show'
* which takes the following parameters:
@ -142,16 +137,12 @@ var { NativeModules } = require('react-native');
module.exports = NativeModules.ToastAndroid;
```
Save the above code into a file named "ToastAndroid.js". Now, from your other JavaScript file you can call the method like this:
Now, from your other JavaScript file you can call the method like this:
```js
// Suppose this js file is under the same directory as ToastAndroid.js.
// Otherwise change the require path.
var ToastAndroid = require('./ToastAndroid');
ToastAndroid.show('Awesome', ToastAndroid.SHORT);
// Note: We require ToastAndroid without any relative filepath because
// of the @providesModule directive. Using @providesModule is optional.
ToastAndroid.show('Awesome', ToastAndroid.SHORT);
```
## Beyond Toasts