Skip to content

A plugin for Publish that allows you to easily embed social buttons (e.g. Tweet button) in your site.

Notifications You must be signed in to change notification settings

alanpaivaa/SocialButtons

Repository files navigation

SocialButtons

A plugin for Publish that allows you to easily embed social buttons (e.g. Tweet button) in your site.

Installation

Add it as a dependency in Package.swift:

let package = Package(
    ...

    dependencies: [
        .package(url: "https://github.com/alanpaivaa/SocialButtons", from: "0.1.0")
    ],
    targets: [
        .target(
            name: "AmazingBlog",
            dependencies: [
                "SocialButtons"
            ]
        )
    ]
)

Usage

TweetButton

A Tweet button allows users to easily share content from your site.

TweetButton(
    style: .small,                          // Choose small or large size
    text: "Check out my amazing article!",  // Text to be shared on the tweet
    hashTags: ["engineering", "swift"],     // Hash tags to be added on the tweet
    via: "alanpaivaa",                      // Twitter account for attribution
    related: ["other_user"]                 // Twitter accounts related to the shared content
)

To render the default Tweet button widget, it's also necessary to load the Twitter widget script:

HTML(
    .head(
        ...
        .loadTwitterWidgets()
    ),
    ...
)

If you need to customize the button, you can use a regular Link and build the Tweet url with TweetURLGenerator. In that case, it's also needed to set the url parameter pointing to the page to share.

Contribute

This project is in its early development and community is highly encouraged to contribute, either by adding more components, fixing bugs, or improving documentation. Thus, feel free to go ahead and create a Pull Request! 💯

I hope you enjoy it, thank you!

About

A plugin for Publish that allows you to easily embed social buttons (e.g. Tweet button) in your site.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages