The GithubPlugin widget supports these parameters.

• type: string the Github plugin type to render. These can be one of the following values:

  • GithubPlugin::WATCH: string for embedding the Github watch button.

  • GithubPlugin::STAR: string for embedding the Github star button.

  • GithubPlugin::FORK: string for embedding the Github fork button.

  • GithubPlugin::FOLLOW: string for embedding the Github follow button.

• settings: array the configuration options for each github plugin setup as key value pairs. Refer the Github plugin documentation for details on configuring each plugin.

• options: array the HTML attributes for the main plugin. The data api attributes in this array will be automatically set based on the settings configuration.

• tag: string the tag of the container rendering the plugin. Defaults to div.

• noscript: string/boolean text to be displayed if browser does not support javascript. If set to false will not displayed. Defaults to Please enable JavaScript to view the comments powered by google.

• noscriptOptions: array the HTML attributes for the noscript message container. Defaults to ['class' => 'alert alert-danger']

NOTE You can configure the GithubPlugin settings once at the social module configuration level, for defaulting it across your application, and skip it in your widget calls. For example.

// your module config
'modules' => [
    'social' => [
        // the module class
        'class' => 'kartik\social\Module',

        // the global settings for the github widget
        'github' => [
            'settings' => ['user'=>'GITHUB_USER_ID']
        ],
]

// your call in your view/layout file
echo GithubPlugin::widget(['repo'=>'GITHUB_REPO_ID']); // will use the GitHub settings configured in module

Click one of the Github plugin links below to view details and demo for the plugin

• Watch Button
• Star Button
• Fork Button
• Follow Button

yii2-social is released under the BSD-3-Clause License. See the bundled LICENSE.md for details.