Socialid.login.renderLoginWidget
(Difference between revisions)
Renato.neves (Talk | contribs) (→Example) |
Renato.neves (Talk | contribs) (→Parameters) |
||
| Line 17: | Line 17: | ||
{| | {| | ||
! align="left" width="200px" | containerId | ! align="left" width="200px" | containerId | ||
| − | | width="200px" | | + | | width="200px" | required |
| Id of the DOM element where the widget will be inserted. | | Id of the DOM element where the widget will be inserted. | ||
|+ | |+ | ||
! align="left" width="200px" | options | ! align="left" width="200px" | options | ||
| − | | width="200px" | | + | | width="200px" | optional |
| A Javascript object containing additional parameters. | | A Javascript object containing additional parameters. | ||
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | theme | ! align="left" width="200px" style="padding-left: 20px" | theme | ||
| − | | width="200px" | | + | | width="200px" | optional |
| Determines which theme will be used to build the widget. It could be "icons", "bricks" ou "labeled_icons". Default: "icons". | | Determines which theme will be used to build the widget. It could be "icons", "bricks" ou "labeled_icons". Default: "icons". | ||
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | providers | ! align="left" width="200px" style="padding-left: 20px" | providers | ||
| − | | width="200px" | | + | | width="200px" | optional |
| Array containing one or more providers enabled to the user log in. The following providers are currently supported: "facebook", "twitter", "linkedin" e "gplus". Default: [] (no providers enabled). | | Array containing one or more providers enabled to the user log in. The following providers are currently supported: "facebook", "twitter", "linkedin" e "gplus". Default: [] (no providers enabled). | ||
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | language | ! align="left" width="200px" style="padding-left: 20px" | language | ||
| − | | width="200px" | | + | | width="200px" | optional |
| Defines which translation will be used in the widgets. It could be "pt_br" (Brazilian Portuguese) ou "en" (English). Default: "en". | | Defines which translation will be used in the widgets. It could be "pt_br" (Brazilian Portuguese) ou "en" (English). Default: "en". | ||
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | showSocialIdLink | ! align="left" width="200px" style="padding-left: 20px" | showSocialIdLink | ||
| − | | width="200px" | | + | | width="200px" | optional |
| Determines if the "Powered by Social-ID NOW" link will be displayed in the widget or not. It could be true or false (boolean). Default: true. | | Determines if the "Powered by Social-ID NOW" link will be displayed in the widget or not. It could be true or false (boolean). Default: true. | ||
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | loadCss | ! align="left" width="200px" style="padding-left: 20px" | loadCss | ||
| − | | width="200px" | | + | | width="200px" | optional |
| Determines if the CSS theme file will be automatically added in the web page as a <link> tag. It could be true or false (boolean). Default: true. | | Determines if the CSS theme file will be automatically added in the web page as a <link> tag. It could be true or false (boolean). Default: true. | ||
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | cssUrl | ! align="left" width="200px" style="padding-left: 20px" | cssUrl | ||
| − | | width="200px" | | + | | width="200px" | optional |
| Determines the CSS theme file url that will be automatically added in the web page as a <link> tag (only if loadCss is true). Default: "https://app.socialidnow.com/assets/api/themes.css". | | Determines the CSS theme file url that will be automatically added in the web page as a <link> tag (only if loadCss is true). Default: "https://app.socialidnow.com/assets/api/themes.css". | ||
|} | |} | ||
Revision as of 17:07, 3 November 2014
Contents |
Description
Renders the Social Login widget within a DOM element.
This widget can trigger the following events:
- socialid.events.onLoginStart
- socialid.events.onLoginSuccess
- socialid.events.onLoginCancel
- socialid.events.onLoginError
Usage
socialid.login.renderLoginWidget(containerId, options)
Parameters
| containerId | required | Id of the DOM element where the widget will be inserted. | options | optional | A Javascript object containing additional parameters. | theme | optional | Determines which theme will be used to build the widget. It could be "icons", "bricks" ou "labeled_icons". Default: "icons". | providers | optional | Array containing one or more providers enabled to the user log in. The following providers are currently supported: "facebook", "twitter", "linkedin" e "gplus". Default: [] (no providers enabled). | language | optional | Defines which translation will be used in the widgets. It could be "pt_br" (Brazilian Portuguese) ou "en" (English). Default: "en". | showSocialIdLink | optional | Determines if the "Powered by Social-ID NOW" link will be displayed in the widget or not. It could be true or false (boolean). Default: true. | loadCss | optional | Determines if the CSS theme file will be automatically added in the web page as a <link> tag. It could be true or false (boolean). Default: true. | cssUrl | optional | Determines the CSS theme file url that will be automatically added in the web page as a <link> tag (only if loadCss is true). Default: "https://app.socialidnow.com/assets/api/themes.css". |
|---|
Example
It renders the Social Login Widget within the "socialid_login_container" DOM element in Brazilian Portuguese ("pt_br"), with Facebook, Twitter, LinkedIn and Google+ available to login:
socialid.login.init(1, {loginType: "event"});
socialid.login.renderLoginWidget("socialid_login_container", {
theme: "bricks",
providers: ["facebook", "gplus", "twitter", "linkedin"],
language: "pt_br",
showSocialIdLink: true,
loadCss: true,
});
You can test this parameters in our playground: https://sid-examples.herokuapp.com/social_logins/playground
