:sunglasses: Screenshots

Light Mode

https://user-images.githubusercontent.com/85727452/235587977-2163b465-cc6f-44fe-a767-dd5029fe2974.mov

Dark Mode

https://user-images.githubusercontent.com/85727452/235587690-25eb7e6c-08dd-4c85-8818-98cb8308046b.mov

:building_construction: Built With

Here is a list of frameworks/libraries used to develop Awesome Social Button

:rocket: Getting Started

Learn what is required before using Awesome Social Button and how to install it quickly. Let's get started!

Prerequisite

This is created base on Vite + Vue3 + TypeScript so you will need to install this lib inside Vue3 project. Vue2 may be supported but it has not been fully tested yet.

Additionally, you will need to install brand icons from the lastest verion of Font Awesome.

1. Go to the Font Awesome download page
2. Select "Free for Web" to download
3. Unzip the downloaded file > Open Webfonts > Select the brand font to install into your Vue3 project

Note: You may use this library with only HTML & CSS. Please visit our demo to implement right away.

Installation

There are a few ways you can install Awesome Social Button, namely npm, yarn and pnpm. If you install via npm, here is a a single cmd to install this libarary

  npm install awesome-social-button

Other options

• yarn

  yarn add awesome-social-button

• pnpm

  pnpm add awesome-social-button

:fire: Usage

VueJS usage example

VueJS without composition API

<template>
  <div id="app">
    <awesome-social-button
        type="facebook"
        :link="{ src: 'https://facebook.com'}"
    />
  </div>
</template>
<script>
import { AwesomeSocialButton } from 'awesome-social-button'

export default {
  components: {
    AwesomeSocialButton,
  },
}
</script>

VueJS with composition API

<script setup>
import { AwesomeSocialButton } from 'awesome-social-button'
</script>
<template>
  <div id="app">
    <AwesomeSocialButton
        type="facebook"
        :link="{ src: 'https://facebook.com'}"
    />
  </div>
</template>

Note: At the moment, the social icons are fixed at 10. For each social icon, there is a default background color which can be changed.

Component attributes

Here is the attributes of this components that you can set

| Prop | Type | Required | Description | | :-------- | :---------------------------------------------------------------------------------------------------------------------------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------- | | type | facebook|twitter|tiktok|instagram|linkedin|youtube|google|pinterest|snapchat|youtube|whatsapp | Yes | 10 Social media icons that can be used. | | link | object | Yes | Show link of a button when it is clicked{ href: string; target?: AnchorHTMLAttributes["target"] } | | shape | circle|square | Optional | Button shape. The defaul value is circle. | | dark | boolean | Optional | Turn on dark mode. The default value is FALSE. | | width | number | Optional | The dimension of a button. The default value is 40. | | color | string | Optional | The background color of a button, and if it's not specified, the button will use the default brand color. | | tooltip | string | Optional | Show or hide a tooltip message |

:books: License

Distributed under the MIT License. See LICENSE for more information.

Free Font Awesome icons are licenses under CC BY 4.0 License while fonts are licensed under SIL OFL 1.1 License. Click here for more information.

:pray: Acknowledgement

• Font Awesome
• Img Shields