Skip to content
forked from cheung31/thread

A JavaScript module to be used in conjunction with Streamhub SDK to display replies of a Content

License

Notifications You must be signed in to change notification settings

Livefyre/thread

 
 

Repository files navigation

thread

Build Status

A module to be used in conjunction with Streamhub SDK to display replies of a Content.

Usage

Construct a ContentThreadView with the root Content item. The content options is required.

var ContentThreadView = require('thread');
var Content = require('streamhub-sdk/content');

// A content with a reply
var myContent = new Content({ body: 'Hello!' });
var reply = new Content({ body: 'Goodbye!' });
myContent.addReply(reply);

var threadView = new ContentThreadView({
  content: myContent
});
threadView.render();

Options

themeClass

Specify a class name that can be used to apply a theme styling (Defaults to 'lf-thread-default').

var ContentThreadView = require('thread');

var threadView = new ContentThreadView({
    content: myContent,
    themeClass: 'dark-theme'
});

maxNestLevel

Specify the number of nested replies the thread view should support (Defaults to 4).

var ContentThreadView = require('thread');

var threadView = new ContentThreadView({
  content: myContent,
  maxNestLevel: 1
});

maxVisibleItems

Specify the number of visible replies before they are hidden behind a "Show more" button (Defaults to 2).

var ContentThreadView = require('thread');

var threadView = new ContentThreadView({
    content: myContent,
    maxVisibleItems: 3
});

order

Specify a sort order of replies (Defaults to descending created_at). ContentThreadView has some pre-defined comparators:

  • ContentThreadView.ORDERS.CREATEDAT_ASCENDING - Ascending created_at
  • ContentThreadView.ORDERS.CREATEDAT_DESCENDING - Descending created_at
var ContentThreadView = require('thread');

var threadView = new ContentThreadView({
  content: myContent,
  order: ContentThreadView.ORDERS.CREATEDAT_ASCENDING
});

contentViewFactory

Specify a content view factory to render the threaded replies in a customized view. (Defaults to the ContentViewFactory provided by Streamhub SDK).

var ContentThreadView = require('thread');
var MyCustomContentViewFactory = require('custom-content-view-factory');

var threadView = new ContentThreadView({
    content: myContent,
    contentViewFactory: new MyCustomContentViewFactory()
});

rootContentView

Specify the ContentView to be used as the root-level content (The root-level content, is passed in as the content option). By default, it will depend on the contentViewFactory to create the root content view.

var ContentThreadView = require('thread');
var LivefyreContentView = require('streamhub-sdk/content/views/livefyre-content-view');

var threadView = new ContentThreadView({
    content: myContent,
    rootContentView: new LivefyreContentView({ content: content })
});

UML Diagram

alt text

About

A JavaScript module to be used in conjunction with Streamhub SDK to display replies of a Content

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 77.2%
  • CSS 14.9%
  • HTML 7.9%