Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vanillawc/wc-social-link
A vanilla web component for social media links
https://github.com/vanillawc/wc-social-link
link social vanilla web-components
Last synced: 2 months ago
JSON representation
A vanilla web component for social media links
- Host: GitHub
- URL: https://github.com/vanillawc/wc-social-link
- Owner: vanillawc
- License: mit
- Created: 2019-04-13T12:10:53.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2021-11-12T16:38:43.000Z (about 3 years ago)
- Last Synced: 2024-10-24T18:04:21.648Z (3 months ago)
- Topics: link, social, vanilla, web-components
- Language: JavaScript
- Homepage:
- Size: 467 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
<wc-social-link> Icon Links for Social Media
## Installation
*Installation*
```sh
npm i @vanillawc/wc-social-link
```*Import from NPM*
```html```
*Import from CDN*
```html```
## Demo
Try it on [WebComponents.dev](https://webcomponents.dev/edit/urflGeFYnQ2S66ff46yE?sv=1&pm=1)
## Usage
**Attributes**
- network - the network type (ex twitter)
- handle - the user handle/username
- href - the link (optional)
- title - the title/tooltip (optional)
Custom Styles**Custom Styles**
- `--width` - width of the icon (default `32px`)
- `--height` - height of the icon (default `32px`)
- `--color` - the icon color (default `black`)### Basic Usage
Provide the name of the social network and your user handle
```html
```
**Network Types**
- github
- gitlab
- rss
- stackoverflow
- twitch*Note: For Stackoverflow, your `USERID` is your handle*
### Basic Usage w/ Custom Link
Alternatively, instead of providing a handle and relying on the built-in link you can just provide your own.
```html
```
## Contributing
See [CONTRIBUTING.md](https://github.com/vanillawc/vanillawc/blob/main/CONTRIBUTING.md)