Stream.renderCommentsWidget

(Difference between revisions)
Jump to: navigation, search
(Example)
(Parameters)
Line 17: Line 17:
 
| width="200px" | optional
 
| width="200px" | optional
 
| object containing additional parameters.
 
| object containing additional parameters.
 +
|+
 +
! align="left" width="200px" style="padding-left: 20px" | loginProviders
 +
| width="200px" | optional
 +
| array of providers to use for login. Default: [].
 
|+
 
|+
 
! align="left" width="200px" style="padding-left: 20px" | loadCss
 
! align="left" width="200px" style="padding-left: 20px" | loadCss
Line 33: Line 37:
 
| width="200px" | optional
 
| width="200px" | optional
 
| boolean indicating if the widget should not render post list UI. Default: false.
 
| boolean indicating if the widget should not render post list UI. Default: false.
|+
 
! align="left" width="200px" style="padding-left: 20px" | loginProviders
 
| width="200px" | optional
 
| array of providers to use for login. Default: ["facebook", "gplus", "twitter", "linkedin"].
 
 
|+
 
|+
 
! align="left" width="200px" style="padding-left: 20px" | shareProviders
 
! align="left" width="200px" style="padding-left: 20px" | shareProviders

Revision as of 13:36, 9 June 2016

Contents

Description

Renders the Comments Widget within a DOM element.

Usage

 stream.renderCommentsWidget(containerId, options)

Parameters

containerId required Id of the DOM element where the widget will be inserted.
options optional object containing additional parameters.
loginProviders optional array of providers to use for login. Default: [].
loadCss optional boolean indicating if the widget should load a CSS file. Default: true.
cssUrl optional URL of an alternative CSS file to be loaded. Default: default theme CSS file.
readOnly optional boolean indicating if the widget should not render post creation UI. Default: false.
createOnly optional boolean indicating if the widget should not render post list UI. Default: false.
shareProviders optional array of providers to use for share. Default: use login providers.
showTitle optional boolean indicating if a title should be shown above the widget. Default: true.
required optional array of required post creation fields. Default: requires at least one of the fields to not be empty.

Example

It renders the Comments Widget within the "comments-container" with Facebook, Twitter, LinkedIn and Google+ available to login:

 socialid.login.init(134, {loginType: "event"});
 var stream = socialid.comments.getStream(2, "streamIdentifier");
 stream.renderCommentsWidget("comments-container", {
   loginProviders: ["facebook", "gplus", "twitter", "linkedin"]
 });
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox