Documentation

Showcase your GitHub profile, organization or repository information.

Install

React Social Github is available as the react-social-github package on npm.

$ npm install react-social-github --save

Usage

import { Github } from 'react-social-github';

Reference

Options

Types

Widget

The tooltip is inserted as a block element. This is the default type and doesn't require any configuration. The option type="widget" can be declared in the component if desired.

Example

<Github user="facebook" repo="react"></Github>

{/* same as */}

<Github user="facebook" repo="react" type="widget"></Github>

Link

The tooltip is anchored in an inline link. The option type="link" must be declared in the component.

Example

<Github user="hackbit" type="link">Hover Here</Github>

<Github user="vandreleal" repo="vandreleal.github.io" type="link">Hover Here</Github>

Options

Button

The tooltip is anchored in a button. The option type="button" must be declared in the component.

Options

Example

<Github user="facebook" type="tooltip" tooltipOnHover={false} fab={true} fabCorner="top-left" iconColor="#3b5998" iconWidth={64} iconHeight={64}></Github>

<Github user="GustavoKatel" type="tooltip" tooltipOnHover={true} fab={true} fabCorner="bottom-left" iconColor="#888" iconWidth={32} iconHeight={32}></Github>

Team

• Vandré Leal Cândido
• Gustavo Sampaio
• Emerson Jair Reis Oliveira da Silva

Open source

React Social Github is available on GitHub for downloading, forking, or contributing.

License

The MIT License (MIT)