Directory

← Back

github-repository

GitHub Repository Web Component

Author

Contributors

Rating

<github-repository>

Version Status macOS Build Status Linux Build Status Windows Build Status Dependency Status

Install

Polyfill tags if you need them. This will include ShadowDOM and Custom Elements support.

<script src="https://unpkg.com/@webcomponents/webcomponentsjs@latest/bundles/webcomponents-sd-ce.js"></script>

Loading this component. It would be a good idea to use a specific version instead of latest.

<script src="https://unpkg.com/github-repository@latest/dist/github-repository.min.js"></script>

Example

Live demo

Usage

Set the owner-repo attribute to the username/repository of a GitHub repository.

<github-repository owner-repo="angular/angular"></github-repository>

Example

For more advanced usage you can include:

  • <img slot="images" /> to include a preview image
  • A number of <a slot="badges"><img /></a> to include status badges
<github-repository owner-repo="abraham/twitter-status">
  <img slot="images" src="https://raw.githubusercontent.com/abraham/twitter-status/master/images/simple.png" alt="Twitter Status embed preview" />

  <a slot="badges" href="https://npmjs.com/package/twitter-status" target="_blank">
    <img src="https://img.shields.io/npm/v/twitter-status.svg?style=flat&label=version&colorB=4bc524" alt="Version Status" />
  </a>
  <a slot="badges" href="https://circleci.com/gh/abraham/twitter-status" target="_blank">
    <img src="https://img.shields.io/circleci/project/github/abraham/twitter-status.svg?style=flat&label=macos" alt="macOS Build Status" />
  </a>
  <a slot="badges" href="https://travis-ci.org/abraham/twitter-status" target="_blank">
    <img src="https://img.shields.io/travis/abraham/twitter-status.svg?style=flat&label=linux" alt="Linux Build Status" />
  </a>
  <a slot="badges" href="https://ci.appveyor.com/project/abraham/twitter-status" target="_blank">
    <img src="https://img.shields.io/appveyor/ci/abraham/twitter-status.svg?style=flat&label=windows" alt="Windows Build Status" />
  </a>
</github-repository>

Example with image and badges

GitHub API Rate limit

This Web Component makes unauthenticated requests to the GitHub API. Since the GitHub API has a fairly restrictive 60 requests/hour per IP address, API responses are cached in localStorage.

License

GithubRepository is released under an MIT license.

Built, tested, and published with Nutmeg.

Compatibility

(Loading compatibility data...)

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

  • @nutmeg/seed#0.13.0
  • approximate-number#2.0.0
Released
2018-07-24
Maturity
IMPORTED
License
MIT License

Compatibility

Framework
Browser
Browser Independent
Online