/yii2-social-share

With this extension you can share data from your web pages to any social network!

Primary LanguagePHPBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Stand With Ukraine

Extension for sharing on social networks

Build Status Scrutinizer Code Quality Total Downloads Monthly Downloads Latest Stable Version StandWithUkraine

With this extension you can share data from your web pages to any social network! Features: SEO support, default icons for social networks, easy creation of custom drivers for other social networks and more!

Documentation is at docs/guide/README.md.

Extension supports from the box next social network drivers:

drivers for messengers:

and other drivers:

also you can create your driver, it's very simple!

Installation

The preferred way to install this extension is through composer.

Either run

$ composer require yiimaker/yii2-social-share

or add

"yiimaker/yii2-social-share": "~2.3"

to the require section of your composer.json.

Usage

Configure social networks in config file

    'components' => [
        // ...
        'socialShare' => [
            'class' => \ymaker\social\share\configurators\Configurator::class,
            'socialNetworks' => [
                'facebook' => [
                    'class' => \ymaker\social\share\drivers\Facebook::class,
                ],
            ],
        ],
    ],

and then call widget in view file

<?= \ymaker\social\share\widgets\SocialShare::widget([
    'configurator'  => 'socialShare',
    'url'           => \yii\helpers\Url::to('absolute/route/to/page', true),
    'title'         => 'Title of the page',
    'description'   => 'Description of the page...',
    'imageUrl'      => \yii\helpers\Url::to('absolute/route/to/image.png', true),
]); ?>

Tests

You can run tests with composer command

$ composer tests

or using following command

$ ./vendor/bin/codecept build && ./vendor/bin/codecept run

Contributing

For information about contributing please read CONTRIBUTING.md.

Sponsoring

Buy Me A Coffee

License

License

This project is released under the terms of the BSD-3-Clause license.

Copyright (c) 2017-2021, Volodymyr Kupriienko