Stream.renderCommentsWidget
From Social ID Developers
(Difference between revisions)
Ramon.maciel (Talk | contribs) (→Parameters) |
Ramon.maciel (Talk | contribs) (→Parameters) |
||
Line 25: | Line 25: | ||
| width="200px" | optional | | width="200px" | optional | ||
| array of providers to use for share. Default: use login providers. | | array of providers to use for share. Default: use login providers. | ||
+ | |+ | ||
+ | ! align="left" width="200px" style="padding-left: 20px" | language | ||
+ | | width="200px" | optional | ||
+ | | string identifying which language to use. Options: "en" for English and "pt_br" for Brazilian Portuguese. Default: "en". | ||
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | loadCss | ! align="left" width="200px" style="padding-left: 20px" | loadCss |
Latest revision as of 13:13, 16 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: []. | shareProviders | optional | array of providers to use for share. Default: use login providers. | language | optional | string identifying which language to use. Options: "en" for English and "pt_br" for Brazilian Portuguese. Default: "en". | 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. | 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"] });