Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chengkangzai/laravel-social-share-links

Last synced: 24 days ago
JSON representation

Host: GitHub
URL: https://github.com/chengkangzai/laravel-social-share-links
Owner: chengkangzai
License: mit
Created: 2023-01-27T16:55:49.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-07-08T09:34:29.000Z (6 months ago)
Last Synced: 2024-11-13T04:49:29.694Z (about 2 months ago)
Language: PHP
Size: 50.8 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # A laravel package that generate social share link, that'ss all it does

[![Latest Version on Packagist](https://img.shields.io/packagist/v/chengkangzai/laravel-social-share-links.svg?style=flat-square)](https://packagist.org/packages/chengkangzai/laravel-social-share-links)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/chengkangzai/laravel-social-share-links/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/chengkangzai/laravel-social-share-links/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/chengkangzai/laravel-social-share-links/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/chengkangzai/laravel-social-share-links/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/chengkangzai/laravel-social-share-links.svg?style=flat-square)](https://packagist.org/packages/chengkangzai/laravel-social-share-links)

## Installation

You can install the package via composer:

```bash

composer require chengkangzai/laravel-social-share-links

```

## Usage

#### Generate social share link for Single Social Media

```php

use Chengkangzai\LaravelSocialShareLinks\Enums\SocialMediaType;

use Chengkangzai\LaravelSocialShareLinks\SocialShareLinksBuilder;

$builder = new SocialShareLinksBuilder();

$link = $builder->url($url) // $url is optional, if not passed, it will use the current url

    ->facebook()

    ->build();

$facebookLink = $link[SocialMediaType::Facebook];

```

#### If you prefer to call it statically 

```php

use Chengkangzai\LaravelSocialShareLinks\Enums\SocialMediaType;

use Chengkangzai\LaravelSocialShareLinks\SocialShareLinksBuilder;

$link = SocialShareLinksBuilder::make($url) // $url is optional, if not passed, it will use the current url

    ->facebook()

    ->build();

$facebookLink = $link[SocialMediaType::Facebook];

```

#### Generate social share links for Multiple Social Media

```php

use Chengkangzai\LaravelSocialShareLinks\Enums\SocialMediaType;

use Chengkangzai\LaravelSocialShareLinks\SocialShareLinksBuilder;

$builder = new SocialShareLinksBuilder();

$link = $builder->url($url)

    ->twitter()

    ->text('Hello World')

    ->hashtags(['laravel', 'social', 'share', 'links'])

    ->via('chengkangzai')

    ->build();

$twitterLink = $link[SocialMediaType::Twitter];

```

#### Generate social share links for multiple social media with `for` method

```php

use Chengkangzai\LaravelSocialShareLinks\Enums\SocialMediaType;

use Chengkangzai\LaravelSocialShareLinks\SocialShareLinksBuilder;

$builder = new SocialShareLinksBuilder();

$links = $builder->url($url)

        ->for([

            SocialMediaType::Facebook,

            SocialMediaType::Twitter,

        ])

        ->build();

$facebookLink = $links[SocialMediaType::Facebook];

$twitterLink = $links[SocialMediaType::Twitter];

```

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Ching Cheng Kang](https://github.com/chengkangzai)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.