@ctrl/ngx-github-buttons
v2.1.1 ngx github buttons star like follow
ngx-github-buttons ![npm](https://img.shields.io/npm/v/@ctrl/ngx-github-buttons.svg)
GitHub buttons without the iframe, for Angular
Demo
https://ngx-github-buttons.vercel.app
Choose from two styles:
- ntkme: https://buttons.github.io/
- mdo: https://ghbtns.com/
Install
npm install @ctrl/ngx-github-buttons
Use
Import the component
import { NtkmeButtonModule } from '@ctrl/ngx-github-buttons';
// or
import { MdoButtonModule } from '@ctrl/ngx-github-buttons';
Use the component
<ntkme-github-button
user="angular"
repo="angular"
>
</ntkme-github-button>
or
<mdo-github-button
user="angular"
repo="angular"
>
</mdo-github-button>
API
Input | Type | default | Description |
---|---|---|---|
user | string | user or org | |
repo | string | repository name | |
type | string | star |
star , follow , watch , fork . ntkme only: issue , download |
count | boolean | false |
show count of stars, issues, followers etc. |
size | string | 'none' |
'large' for a bigger size button |
standardIcon | boolean | false |
ntkme only: use the github logo instead of other icons |
License
This project is MIT licensed, but each set of buttons have their own license.
The mdo buttons are Licensed Apache 2
The ntkme buttons are Licensed BSD 2-clause
npm i @ctrl/[email protected]
Metadata
- MIT
- Whatever
- Scott Cooper
- released 3/9/2019