https://github.com/scriptex/socials
A native web component: links to various social media with SVG icons support
https://github.com/scriptex/socials
social-links svg-icons web-component
Last synced: 9 months ago
JSON representation
A native web component: links to various social media with SVG icons support
- Host: GitHub
- URL: https://github.com/scriptex/socials
- Owner: scriptex
- License: mit
- Created: 2020-07-27T05:28:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T00:56:15.000Z (9 months ago)
- Last Synced: 2025-04-10T04:05:30.112Z (9 months ago)
- Topics: social-links, svg-icons, web-component
- Language: TypeScript
- Homepage: https://socials.atanas.info/
- Size: 664 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/scriptex/socials)
[](https://github.com/scriptex/socials/actions?query=workflow%3ABuild)
[](https://www.codacy.com/gh/scriptex/socials/dashboard?utm_source=github.com&utm_medium=referral&utm_content=scriptex/socials&utm_campaign=Badge_Grade)
[](https://codebeat.co/projects/github-com-scriptex-socials-master)
[](https://www.codefactor.io/repository/github/scriptex/socials)
[](https://deepscan.io/dashboard#view=project&tid=3574&pid=5257&bid=40799)
[](https://github.com/scriptex/socials/)
[](https://www.webcomponents.org/element/scriptex-socials)
# Atanas Atanasov's Socials
> Links to various social media
This is a native web component built with TypeScript, with no dependencies, which lists links to various social medias.
## Install
```sh
npm i scriptex-socials
# or
yarn add scriptex-socials
```
## Usage
In your JavaScript/TypeScript entry point:
```javascript
import 'scriptex-socials';
```
You can also include the web component directly from **unpkg.com**:
```javascript
import('https://unpkg.com/scriptex-socials');
```
or
```html
```
Then add the component in your HTML/JSX markup:
```html
```
## React with TypeScript
If you're using React with TypeScript, you need to extends the JSX `IntrinsicElements` interface so TypeScript knows that the `social-links` element exists.
You can do so in a `custom.d.ts` file in your project's root folder. Don't forget to add that file in your `tsconfig.json`!
```typescript
declare namespace JSX {
interface IntrinsicElements {
'social-links': any;
}
}
```
## Contents
Currently it includes the following:
## LICENSE
MIT
---
Connect with me:
---