https://github.com/LeCoupa/vuesocial
🧞♀️🧞♂️ One easy-to-use button component for Vue.js with 65+ social networks.
https://github.com/LeCoupa/vuesocial
nuxtjs vuejs
Last synced: 7 months ago
JSON representation
🧞♀️🧞♂️ One easy-to-use button component for Vue.js with 65+ social networks.
- Host: GitHub
- URL: https://github.com/LeCoupa/vuesocial
- Owner: LeCoupa
- License: mit
- Created: 2019-11-22T18:35:18.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:31:54.000Z (almost 3 years ago)
- Last Synced: 2024-10-30T06:01:08.334Z (12 months ago)
- Topics: nuxtjs, vuejs
- Language: SCSS
- Homepage: https://www.growthbunker.dev/vuesocial
- Size: 2.54 MB
- Stars: 56
- Watchers: 4
- Forks: 13
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@growthbunker/vuesocial)
[](https://npm-stat.com/charts.html?package=@growthbunker/vuesocial)
[](http://isitmaintained.com/project/growthbunker/vuesocial "Average time to resolve an issue")
[](http://isitmaintained.com/project/growthbunker/vuesocial "Percentage of issues still open")
[](https://github.com/growthbunker/vuesocial/blob/master/LICENSE)
[](https://app.netlify.com/sites/growthbunker/deploys)
## Documentation
You can browse the documentation for Vue Social [on the website](https://www.growthbunker.dev/vuesocial).
## Installation
```
npm install @growthbunker/vuesocial
# Or if you prefer using yarn
yarn add @growthbunker/vuesocial
```
### Vue.js
In your `main.js` file:
```js
import Vue from "vue"
import vuesocial from "@growthbunker/vuesocial"
Vue.use(vuesocial)
```
### Nuxt.js
Create a new plugin in `plugins/vuesocial.js`:
```js
import Vue from "vue"
import vuesocial from "@growthbunker/vuesocial"
Vue.use(vuesocial)
```
Add this new plugin to `nuxt.config.js`.
```js
module.exports = {
// ...
plugins: [{ src: "@/plugins/vuesocial.js" }];
}
```
### CDN
Get the latest version from [jsdelivr](https://www.jsdelivr.com/), and import the JavaScript file in your page.
```html
```
We recommend our users to lock Vue Social's version when using CDN. Requesting the latest version (as opposed to "latest major" or "latest minor") is dangerous because major versions usually come with breaking changes. Only do this if you really know what you are doing. [Please refer to jsdelivr.com](https://www.jsdelivr.com/features) for more information.
## Icons
All the icons are available here in three themes (color, black and white). Copy them somewhere in your somewhere in your "public" / "static" folder. You will also have to set the icon path for the component to be able to find them (see package options and component props).
A huge thank you to Alexis Doreau for designing them.
## Example
Once the plugin is installed, you can use the component like this:
```html
Do something with Facebook
```
## Contributing
You are more than welcome to contribute to Vue Social. Just submit changes via pull request and I will review them before merging.
1. Fork it! 🤙
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am "Add some feature"`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request 👍
The documentation is available in the `docs` folder. The Vue Social components are available in the `lib` folder.
## License
Vue Social is [MIT licensed](LICENSE).