Overview

The Github components lets users view various aspects of github information.

Available components

The Stoked UI Github package exposes four components:

• GithubCalendar
• GithubEvents
• GithubCommit
• GithubBranch

Github Calendar

import { GithubCalendar } from '@stoked-ui/github/GithubCalendar';

The Github Calendar component is built on top of the react-github-calendar component.

Github Events

import { GithubEvents } from '@stoked-ui/github/GithubEvents';

The Github Events component displays and provides access to a given user's recent github events:

Github Commit

import { GithubCommit } from '@stoked-ui/github/GithubCommit';

The Github Commit component renders a single commit view with the contributor, commit message, changed files, and a minimal diff:

Simple static example:

Github Branch

import { GithubBranch } from '@stoked-ui/github/GithubBranch';

The Github Branch component compares a branch to its base branch and highlights contributors, commits, changed files, and a minimal diff:

Simple static example: