nbluis / github-ribbon-element

Web component wrapper for github ribbons using polymer.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

<github-ribbon>

Web Component wrapper for Github Ribbons using Polymer.

Demo

Check it live.

Usage

  1. Import Web Components' polyfill:

    <script src="//unpkg.com/@webcomponents/webcomponentsjs@2.0.0/webcomponents-bundle.js"></script>
  2. Import Custom Element:

    <link rel="import" href="src/github-ribbon.html">
  3. Start using it!

    <github-ribbon owner="nbluis" repo="github-ribbon-element"></github-ribbon>

Options

Attribute Options Default Description
owner string none Owner of the project (User or Organization)
repo string none The repo name
corner left, right right The corner which ribbon will appears
color green, red, gray, white, darkblue, orange green The ribbon color

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

MIT License

About

Web component wrapper for github ribbons using polymer.


Languages

Language:HTML 100.0%