2.0.2 • Published 7 years ago

ng-github-card v2.0.2

Weekly downloads
3
License
MIT
Repository
github
Last release
7 years ago

Angular Github Card

npm version

Angular Github Card is a simple component that showing your github details. It's quite perfect for use with a portfolio website. This project is based on github-widget.

Angular Github Widget Image

Set Up

First, add it to your angular project via npm
npm install -S angular-github-card

Next up, add NgGithubCardModule to the imports of the module you wish to use this in.
Like So

import { NgModule } from '@angular/core';
import {NgGithubCardModule} from 'ng-github-card';

@NgModule({
    imports: [
            /* Other imports*/
            NgGithubCardModule
        ]
})
export class MyModule {
    
}

Usage

Usage is very simple. Simply use drop the component's selector in your template, bind a value to githubUser and it's ready to go.
Like So

<ng-github-card [githubUser]="'someGithubUser'"></ng-github-card>
Configuring the top 3 repositories to show

The widget defaults to sorting your repositories by their start count and picking the top 3 to display. You can alter this behaviour by specifying a repository name for one or more of the inputs listed below.

  • [top1]
  • [top2]
  • [top3]

These two examples highlight this usage.

<div>
    <ng-github-card [githubUser]="'someGithubUser1'" [top1]="'angular-github-widget'"></ng-github-card>
    <ng-github-card [githubUser]="'someGithubUser2'" [top1]="'angular-github-widget'" [top2]="'an-amazing-repo'"></ng-github-card>
</div>

Thank You!

Thank you for checking out this project, I hope it's useful to you! Have a good day!

2.0.2

7 years ago

2.0.1

7 years ago

2.0.0

7 years ago

1.3.9-alpha

7 years ago

1.3.8-alpha

7 years ago

1.3.7-alpha

7 years ago

1.3.6-alpha

7 years ago

1.3.5-alpha

7 years ago

1.3.4-alpha

7 years ago

1.3.3-alpha

7 years ago

1.3.2-alpha

7 years ago

1.3.1-alpha

7 years ago

1.3.0-alpha

7 years ago

1.2.0-alpha

7 years ago

1.1.0-alpha

7 years ago

1.0.1-alpha

7 years ago

1.0.0-alpha

7 years ago