This package enables the creation of models that can be commented on. For example a photo in an photo album could have comments, but also a post to a users feed could as well. Rather than maintaining a photo comments collection and a post comments collection we can implement CommentableModel on our Post
and Photo
models and then use it's new methods to store and retrieve comments and information about them, linked to these models.
This is a Meteor package with part of it's code published as a companion NPM package made to work with React Native. This allows your Meteor and React Native projects that use this package to share code between them to give you a competitive advantage when bringing your mobile and web application to market.
In the spirit of keeping this and all of the packages in the Socialize set alive, I ask that if you find this package useful, please donate to it's development.
This package relies on the npm package simpl-schema
so you will need to make sure it is installed as well.
$ meteor npm install --save simpl-schema
$ meteor add socialize:commentable
When using this package with React Native, the dependency tree ensures that simpl-schema
is loaded so there's no need to install it as when using within Meteor.
$ npm install --save @socialize/commentable
Note
When using with React Native, you'll need to connect to a server which hosts the server side Meteor code for your app using
Meteor.connect
as per the @socialize/react-native-meteor documentation.
Depending on the environment your code will be running in, you'll need to import the classes from the packages specific to that environment, either Meteor or React Native.
//Meteor Imports
import { Mongo } from 'meteor/mongo';
import { CommentableModel } from 'meteor/socialize-commentable';
import { LinkParent, LinkableModel } from 'meteor/socialize-linkable';
//React Native Imports
import { Mongo } from '@socialize/react-native-meteor';
import { CommentableModel } from '@socialize/commentable';
import { LinkParent, LinkableModel } from '@socialize/linkable';
Once we have the appropriate packages imported, the rest of the code will run in either environment.
//this gets imported the same for either environment
import SimpleSchema from 'simpl-schema';
//define the collection to hold products
const PhotosCollection = new Mongo.Collection("photos");
//define the schema for a product
const PhotosSchema = new SimpleSchema({
"userId":{
type:String,
regEx:SimpleSchema.RegEx.Id,
autoValue:function () {
if(this.isInsert){
return this.userId;
}
},
denyUpdate:true
},
"date":{
type:Date,
autoValue:function() {
if(this.isInsert){
return new Date();
}
},
denyUpdate:true
}
//actual schema truncated for brevity
});
//Create a product class extending LikeableModel and LinkParent
class Photo extends CommentableModel(LinkParent) {
//methods here
}
//Attach the collection to the model so we can use BaseModel's CRUD methods
Photo.attachCollection(PhotosCollection);
Photo.attachSchema(PhotosSchema);
Photo.attachSchema(CommentableModel.CommentableSchema);
//Register the Model as a potential Parent of a LinkableModel
LinkableModel.registerParentModel(Photo);
//Create a new product and save it to the database using BaseModel's save method.
new Photo({caption:"Meteor Camp 2016!", cloudinaryId:"sL0Jbf3gBaoeubs3G822WQqwp"}).save();
//Get an instance of Product using a findOne call.
let foundPhoto = PhotosCollection.findOne();
//subscribe to the comments for this particular photo
Meteor.subscribe('socialize.commmentsFor', foundPhoto._id);
//Post a comment that will be linked to the photo.
foundPhoto.addComment("This was so much fun!");
//Get a cursor of comments for this photo
foundPhoto.comments().forEach((comment) => {
console.log(`${comment.user().username}: ${comment.body}`);
});
For a more in depth explanation of how to use this package see API.md
This package implements cultofcoders:redis-oplog's namespaces to provide reactive scalability as an alternative to Meteor's livedata
. Use of redis-oplog is not required and will not engage until you install the cultofcoders:redis-oplog package and configure it.