README

Social Profile Links for Laravel

This Laravel package provides easy-to-use functionalities to generate social media profile URLs and render social icon links directly in your Laravel applications.

Installation

You can install the package via composer:

composer require daikazu/social-links

Optionally, you can publish the views using

php artisan vendor:publish --tag="social-links-views"

Usage

Generating Social Profile URLs

You can generate a URL for a social media profile using the social_url helper function. Here's how you can use it:

Using Strings (Legacy Approach)

$url = social_url('facebook', 'username');

Replace 'facebook' with the desired platform and 'username' with the user's social media profile username.

Using Enums (Recommended)

You can also use the SocialNetwork enum for better type safety and IDE autocompletion:

use Daikazu\SocialLinks\Enums\SocialNetwork;

$url = social_url(SocialNetwork::FACEBOOK, 'username');

// Or directly from the enum
$url = SocialNetwork::FACEBOOK->getUrl('username');

Displaying Social Icons

To display a social icon link, use the Blade component included in the package. Here's an example:

Using Strings (Legacy Approach)

<x-social-links::social-link platform="facebook" name="username" icon-styles="size-12 hover:text-red-500 fill-current"/>

Using Enums (Recommended)

use Daikazu\SocialLinks\Enums\SocialNetwork;

// In your controller or view composer
$platform = SocialNetwork::FACEBOOK;

// In your Blade view
<x-social-links::social-link :platform="$platform" name="username" icon-styles="size-12 hover:text-red-500 fill-current"/>

Adjust the platform, name, and icon-styles attributes as necessary to fit your needs.

Supported Social Platforms

The package currently supports URL generation and icon link rendering for the following social media platforms:

• Address
• Apple Music
• Bandcamp
• Booking
• Buy Merch
• Contact Form
• Discord
• Donate
• Email
• Facebook
• Github
• Google Play
• Instagram
• LinkedIn
• Other
• Patreon
• Phone
• Pinterest
• Reddit
• Snapchat
• Soundcloud
• Spotify
• Stream
• Telegram
• Tiktok
• Twitch
• Twitter
• Website
• Whatsapp
• X (formerly Twitter)
• Yelp
• Youtube

Check back for updates or contribute to extend support for other platforms.

Here is some example code for displaying all supported social icons:

@php
use Daikazu\SocialLinks\Enums\SocialNetwork;
$socialNetworks = SocialNetwork::cases();
@endphp

<div class="social-links-container grid grid-cols-2 gap-4 md:grid-cols-3 lg:grid-cols-4">
    @foreach ($socialNetworks as $network)
    <div class="social-link-item flex items-center rounded-lg border p-4">
        <x-social-links::social-link
            :platform="$network"
            name="username"
            icon-styles="size-6 mr-3 fill-current"
            class="flex items-center transition-colors hover:text-blue-500"
        />
        <span>{{ ucfirst($network->value) }}</span>
    </div>
    @endforeach
</div>

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Mike Wall
• All Contributors

License

The MIT License (MIT). Please see License File for more information.