https://github.com/marketingpipeline/github-buttons-web-component

GitHub Buttons as a web component - show off your stars, followers & more! ⭐
https://github.com/marketingpipeline/github-buttons-web-component

css frontend gh-buttons github github-api github-button github-buttons html javascript stargazers-count web-component web-components webcomponent webcomponents

Last synced: about 1 month ago
JSON representation

GitHub Buttons as a web component - show off your stars, followers & more! ⭐

• Host: GitHub
• URL: https://github.com/marketingpipeline/github-buttons-web-component
• Owner: MarketingPipeline
• License: mit
• Created: 2022-08-25T04:33:10.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-14T08:12:05.000Z (over 3 years ago)
• Last Synced: 2025-06-08T06:40:42.641Z (11 months ago)
• Topics: css, frontend, gh-buttons, github, github-api, github-button, github-buttons, html, javascript, stargazers-count, web-component, web-components, webcomponent, webcomponents
• Language: JavaScript
• Homepage: https://marketingpipeline.github.io/GitHub-Buttons-Web-Component/
• Size: 99.6 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GitHub-Buttons-Web-Component



  



                                                                     


   


    GitHub Buttons as a web component to show off your stars, followers & more!

  

  


   Show your support! 

  


   

    

  

  

    

  

   
  

   

   

> Note: contributor & pull request counts etc are currently not accurate. If you are a JavaScript developer & would like to address a fix for this see the [to-do](.github/TO-DO.md)


## Example and Usage

You can view a demo of the GitHub Buttons web component [here](https://marketingpipeline.github.io/GitHub-Buttons-Web-Component/)

How to use GitHub Buttons:

   include this [script](https://github.com/MarketingPipeline/GitHub-Buttons-Web-Component/blob/main/version/1.0.0/src/github-buttons-wc.js) in your HTML document.

         

        

### How to show Star Button

    

 

 

### How to show Watch Button

 

    

### How to show Fork Button

    

### How to show Followers Button

    

### How to show Sponsor Button

    

### How to show Pull Requests Button

    

### How to show Issues Button

    

        

### How to show Custom Button

    

## Options

Attribute

Meaning

Default

Required

repo

  Your GitHub username + repo or GitHub Profile (Not Required For Custom Button)

Undefined

Yes

type

              The type of button to show 

Star Count

No

icon

The icon to use in the button 

GitHub Icon

No

href

The href / link for the button

Defined by Type

No

new-window

If                    True, button link will open in a new window

False

No

 

text

Text to show (Custom Button's Have No Default Text)

Defined by Type

No

## Contributing ![GitHub](https://img.shields.io/github/contributors/MarketingPipeline/GitHub-Buttons-Web-Component)

Want to improve this? Create a pull request with detailed changes / improvements! If approved you will be added to the list of contributors of this awesome project!

See also the list of

[contributors](https://github.com/MarketingPipeline/GitHub-Buttons-Web-Component/graphs/contributors) who

participate in this project.

## License ![GitHub](https://img.shields.io/github/license/MarketingPipeline/GitHub-Buttons-Web-Component)

This project is licensed under the MIT License - see the

[LICENSE.md](https://github.com/MarketingPipeline/GitHub-Buttons-Web-Component/blob/main/LICENSE) file for

details.