Class yii\authclient\widgets\AuthChoice

AuthChoice prints buttons for authentication via various auth clients.

It opens a popup window for the client authentication process. By default this widget relies on presence of yii\authclient\Collection among application components to get auth clients information.

Example:

<?= yii\authclient\widgets\AuthChoice::widget([
    'baseAuthUrl' => ['site/auth']
]); ?>

You can customize the widget appearance by using begin() and end() syntax along with using method clientLink() or createClientUrl(). For example:

<?php
use yii\authclient\widgets\AuthChoice;
?>
<?php $authAuthChoice = AuthChoice::begin([
    'baseAuthUrl' => ['site/auth']
]); ?>
<ul>
<?php foreach ($authAuthChoice->getClients() as $client): ?>
    <li><?= $authAuthChoice->clientLink($client) ?></li>
<?php endforeach; ?>
</ul>
<?php AuthChoice::end(); ?>

This widget supports following keys for yii\authclient\ClientInterface::getViewOptions() result:

• popupWidth: int, width of the popup window in pixels.
• popupHeight: int, height of the popup window in pixels.
• widget: array, configuration for the widget, which should be used to render a client link; such widget should be a subclass of yii\authclient\widgets\AuthChoiceItem.

See also yii\authclient\AuthAction.