Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scttcper/ngx-github-buttons
GitHub Buttons in Angular
https://github.com/scttcper/ngx-github-buttons
angular github-buttons
Last synced: 2 months ago
JSON representation
GitHub Buttons in Angular
- Host: GitHub
- URL: https://github.com/scttcper/ngx-github-buttons
- Owner: scttcper
- License: other
- Created: 2017-11-06T04:07:31.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-15T01:06:31.000Z (over 1 year ago)
- Last Synced: 2024-10-05T02:34:49.634Z (3 months ago)
- Topics: angular, github-buttons
- Language: TypeScript
- Homepage: https://ngx-github-buttons.vercel.app
- Size: 2.31 MB
- Stars: 11
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ngx-github-buttons [](https://www.npmjs.com/package/@ctrl/ngx-github-buttons)
> 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
```console
npm install @ctrl/ngx-github-buttons
```
### Use
Import the component
```ts
import { NtkmeButtonModule } from '@ctrl/ngx-github-buttons';
// or
import { MdoButtonModule } from '@ctrl/ngx-github-buttons';
```
Use the component
```html
```
or
```html
```
### 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](https://github.com/mdo/github-buttons/blob/master/LICENSE.md)
The ntkme buttons are Licensed [BSD 2-clause](https://github.com/ntkme/github-buttons/blob/master/LICENSE.md)