@albertzak/react-native-meteor
v1.5.4
Published
Full Meteor Client for React Native
Downloads
16
Maintainers
Readme
@albertzak/react-native-meteor
Forked from @xvonabur
This project was adapted from react-native-meteor by inProgress Team to be more up to date and focused. This documentation has been revised to be more coherent, dependencies have been updated, and the API has been brought more in-line with Meteor.
If you are moving from that package to this one, you may find certain parts are missing that were deemed to be outside the scope of this package (ListViews), were removed/deprecated in meteor core or are outdated methods of connecting Tracker with your componenets (connectMeteor, composeWithTracker and createContainer).
Installation And Setup
$ npm i --save @albertzak/react-native-meteor
Android
Add the following permission to your AndroidManifest.xml file for faster reconnects to the DDP server when your device reconnects to the network.
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
If running an android emulator you have to forward the port of your meteor app.
$ adb reverse tcp:3000 tcp:3000
Example Usage
import React, { Component } from 'react';
import { View, Text } from 'react-native';
import Meteor, { withTracker } from 'react-native-meteor';
import TodosCollection from '../api/todo';
Meteor.connect('ws://192.168.X.X:3000/websocket');//do this only once
class App extends Component {
renderRow(todo) {
return (
<Text>{todo.title}</Text>
);
}
render() {
const { todos, todosReady } = this.props;
return(
<View>
{todosReady ? todos.map(renderRow) : <View>Loading...</View>}
</View>
)
}
}
export default withTracker(params=>{
return {
todosReady: Meteor.subscribe('todos').ready(),
todos: TodosCollection.find({done: false}, { sort: { createdAt: -1 }}),
};
})(App);
Reactive Variables
These variables can be used inside withTracker
. They will be populated into your component if they change.
- Meteor.subscribe()
- Mongo.Collection(collectionName, options)
- Meteor.user()
- Meteor.userId()
- Meteor.loggingIn()
- Meteor.status()
- ReactiveDict()
API
Subscriptions
import Meteor, { Tracker } from '@albertzak/react-native-meteor';
const handle = Meteor.subscribe('albertzak.friends');
Tracker.autorun(() =>{
if(handle.ready()){
console.log('Subscription ready...');
handle.stop();
}
});
Collections
- Mongo.Collection(collectionName, options)
These methods work offline. That means that elements are correctly updated offline, and when you reconnect to ddp, Meteor calls are taken care of.
You need pass the cursoredFind
option when you get your collection if you want to use cursor-like method:
import { Mongo } from '@albertzak/react-native-meteor';
new Mongo.Collection("collectionName", { cursoredFind: true });
Or you can simply use find()
to get an array of documents. The option default to false for backward compatibility. Cursor methods are available to share code more easily between a react-native app and a standard Meteor app.
Meteor.is/Environment/
Keeping in line with Meteor's API, isClient
is provided as well as a isReactNative
, similar to how Meteor provides isCordova
when code is running in a cordova build. isServer
and isCordova
are not provided as they will still be falsey when checking. These properties allow for code reuse across your codebases.
- Meteor.isClient - True
- Meteor.isReactNative - True
DDP connection
Meteor.connect(url, options)
Connect to a DDP server. You only have to do this once in your app.
Arguments
url
string requiredoptions
object Available options are :- autoConnect boolean [true] whether to establish the connection to the server upon instantiation. When false, one can manually establish the connection with the Meteor.ddp.connect method.
- autoReconnect boolean [true] whether to try to reconnect to the server when the socket connection closes, unless the closing was initiated by a call to the disconnect method.
- reconnectInterval number [10000] the interval in ms between reconnection attempts.
Meteor.ddp
Once connected to the ddp server, you can access every method available in ddp.js.
- Meteor.ddp.on('connected')
- Meteor.ddp.on('added')
- Meteor.ddp.on('changed')
Meteor.disconnect()
Disconnect from the DDP server.
Meteor Methods
Additional Packages
ReactiveDict
import { reactivedict } from 'react-native-meteor';
See documentation.
Accounts
import Meteor, { Accounts } from 'react-native-meteor';
- Accounts.createUser
- Accounts.changePassword
- Accounts.forgotPassword
- Accounts.resetPassword
- Accounts.onLogin
- Accounts.onLoginFailure
- Meteor.user()
- Meteor.userId()
- Meteor.loggingIn()
- Meteor.loginWithPassword (Please note that user is auto-resigned in - like in Meteor Web applications - thanks to React Native AsyncStorage.)
- Meteor.logout
- Meteor.logoutOtherClients
React Meteor Data
import { withTracker } from 'react-native-meteor';
See documentation.
Contribution
Pull Requests and issues reported are welcome! :)