Miss any of our Open RFC calls?Watch the recordings here! »

electron-meteor

0.3.0 • Public • Published

electron-meteor electron-meteor npm version Dependency Status

Meteor-like methods for React Native.

What is it for ?

The purpose of this library is :

  • to set up and maintain a ddp connection with a ddp server, freeing the developer from having to do it on their own.
  • be fully compatible with react-native and help react-native developers.
  • to match with Meteor documentation used with React.

Install

npm i --save electron-meteor@latest

!! See detailed installation guide

Example usage

 
import { View, Text, Component } from 'react-native';
import Meteor, { createContainer } from 'electron-meteor';
 
Meteor.connect('http://192.168.X.X:3000/websocket');//do this only once
 
class App extends Component {
  renderRow(todo) {
    return (
      <Text>{todo.title}</Text>
    );
  }
  render() {
    const { settings, todosReady } = this.data;
 
    <View>
      <Text>{settings.title}</Text>
        {!todosReady && <Text>Not ready</Text>}
 
        <MeteorListView
          collection="todos"
          selector={{done: true}}
          options={{sort: {createdAt: -1}}}
          renderRow={this.renderRow}
        />
    </View>
 
  }
}
 
export default createContainer(params=>{
  const handle = Meteor.subscribe('todos');
  Meteor.subscribe('settings');
 
  return {
    todosReady: handle.ready(),
    settings: Meteor.collection('settings').findOne()
  };
})

createContainer

Since Meteor 1.3, createContainer is the recommended way to go to populate your React Classes. Very similar to getMeteorData but your separate container components from presentational components.

Example

import Meteor, { createContainer } from 'electron-meteor';
 
 
class Orders extends Component {
  render() {
    const { pendingOrders } = this.props;
 
    //...
    );
  }
}
 
export default createContainer(params=>{
  return {
    pendingOrders: Meteor.collection('orders').find({status: "pending"}),
  };
}, Orders)

connectMeteor && getMeteorData

connectMeteor is a React Mixin which enables getMeteorData (the old way of populating meteor data into your components).

Example

import Meteor, { connectMeteor } from 'electron-meteor';
 
/*
* Uses decorators (see detailed installation to activate it)
* Or use :
 
  class Todos extends Component {
    ...
  }
  connectMeteor(Todos);
  export default Todos;
 
*/
 
@connectMeteor
class Orders extends Component {
  getMeteorData() {
    return {
      pendingOrders: Meteor.collection('orders').find({status: "pending"}),
    };
  }
  render() {
    const { pendingOrders } = this.props;
 
    //...
    );
  }
}

Reactive variables

These variables can be used inside getMeteorData or createContainer. They will be populated into your component if they change.

Additionals collection methods

These methods (except update) work offline. That means that elements are correctly updated offline, and when you reconnect to ddp, Meteor calls are taken care of.

MeteorListView Component

Same as ListView Component but does not need dataSource and accepts three arguments :

  • collection string required
  • selector [string / object]
  • options object
  • listViewRef [string / function] ref to ListView component.

Example usage

<MeteorListView
  collection="todos"
  selector={{done: true}}
  options={{sort: {createdAt: -1}}}
  renderRow={this.renderItem}
  //...other listview props
/>

MeteorComplexListView Component

Same as ListView Component but does not need dataSource and accepts one argument. You may need it if you make complex requests combining multiples collections.

  • elements function required : a reactive function which returns an array of elements.
  • listViewRef [string / function] ref to ListView component.

Example usage

<MeteorComplexListView
  elements={()=>{return Meteor.collection('todos').find()}}
  renderRow={this.renderItem}
  //...other listview props
/>

API

Meteor DDP connection

Meteor.connect(endpoint, options)

Connect to a DDP server. You only have to do this once in your app.

Arguments

  • url string required
  • options 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.disconnect()

Disconnect from the DDP server.

Meteor methods

Meteor.Accounts

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')
  • ...

CollectionFS

  • Meteor.FSCollection(collectionName) : Helper for Meteor-CollectionFS. Full documentation here
  • This plugin also exposes a FSCollectionImagesPreloader component which helps you preload every image you want in CollectionFS (only available on ios)
import { FSCollectionImagesPreloader } from 'electron-meteor';
 
<FSCollectionImagesPreloader
  collection="imagesFiles"
  selector={{metadata.owner: XXX}}
/>

react-native-router-flux

  • Github repository
  • npm i --save electron-meteor-router-flux@latest
  • Custom scene renderer which allows to select tab scene to show depending from app state. It could be useful for authentication, restricted scenes, etc.

Want to help ?

Pull Requests and issues reported are welcome ! :)

Install

npm i electron-meteor

DownloadsWeekly Downloads

4

Version

0.3.0

License

MIT

Last publish

Collaborators

  • avatar