butter-github-star
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> 
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
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -m 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
License
Links
Compatibility
Was this helpful? Need more help?
Leave a comment or a question below. You can also join
the chat on Discord or
ask questions on StackOverflow.
Version
Dependencies
- iron-icons#PolymerElements/iron-icons#^2.0.1
- polymer#Polymer/polymer#^2.0.1
- Released
- 2017-07-06
- Maturity
- IMPORTED
- License
- Apache License 2.0
Compatibility
- Framework
- Polymer 2.0+
- Browser
- Browser Independent
butter-github-star - Vaadin Add-on Directory
Butter collection / Number of stars of a Github repository.