Butter collection / Number of stars of a Github repository.

[ This description is mirrored from README.md at github.com/JCrestel/butter-github-star on 2019-05-10 ]

<butter-github-star> Published on webcomponents.org Build Status

This web-component shows the number of stars of a Github repository.

<butter-github-star user="JCrestel" repository="butter-github-star"></butter-github-star>

Installation

Install the component using Bower

$ bower install butter-github-star --save

Usage

  • Import Web Components's polyfill (if needed):
<script src="../webcomponentsjs/webcomponents.min.js"></script>
  • Import the component:
<link rel="import" href="../butter-github-star/butter-github-star.html">
  • Use the component:
<butter-github-star user="JCrestel" repository="butter-github-star"></butter-github-star>

Attributes

Attribute Type Mandatory Description
user String Yes User on Github
repository String Yes Repository of the user

Styling

<butter-github-star> provides the following custom properties for styling:

Custom property Description Default
--butter-icon-color Color of the star --iron-icon-fill-color
--iron-icon-fill-color Color of the star if --butter-icon-color not defined black
--butter-background-color Background color of left part #e6ebf1
--butter-border-color Border color rgba(27,31,35,0.35)
--butter-font-familly Font familly 'Roboto', 'Noto', sans-serif

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

Apache 2.0

Install

Link to this version
ImportedReleased 06 July 2017Apache License 2.0
Framework Support
Polymer 2.0+
Browser Compatibility
Install with
bower install --save JCrestel/butter-github-star"#1.0.3"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 1.0.3

Dependencies

  • iron-icons#PolymerElements/iron-icons#^2.0.1
  • polymer#Polymer/polymer#^2.0.1