swissmanu / mozaik-ext-github

Mozaïk github widgets

Mozaïk github widgets

Github Client Configuration

In order to use the Mozaïk github widgets, you should configure its client. It's not required that you provide a token for authentication, but then you'll only be able to see public repos and the rate limit will apply.

parameters

key	description
token	github authentication token

usage

{
  //…
  api: {
    github: {
        token: 'MY_GITHUB_TOKEN'
    },
  }
}

Github User badge

Show github user badge.

parameters

key	required	description
user	yes	github user identifier

usage

{
  type: 'github.user_badge', user: 'plouc',
  columns: 1, rows: 1, x: 0, y: 0
}

Github Repository Contributors Stats

Show github contributors stats.

parameters

key	required	description
repository	yes	github repository

usage

{
  type: 'github.repository_contributors_stats', repository: 'plouc/mozaik',
  columns: 1, rows: 1, x: 0, y: 0
}

Github Repository Branches

Show github branches with authors.

parameters

key	required	description
repository	yes	github repository
title	no	overrides default title if provided

usage

{
  type: 'github.branches', repository: 'plouc/mozaik',
  columns: 1, rows: 1, x: 0, y: 0
}

Github issue types treemap

Show a treemap of issue types.

parameters

key	required	description
repository	yes	github repository
labels	yes	a list of labels with an associated color

usage

{
    type: 'github.issue_labels_treemap',
    repository: 'plouc/mozaik',
    labels: [
        { color: '#6bc2c8', count: 13, name: 'blocker'     },
        { color: '#5f8cc0', count: 3,  name: 'enhancement' },
        { color: '#525487', count: 7,  name: 'bug'         },
        { color: '#383b72', count: 16, name: 'help-wanted' }
    ],
    columns: 1, rows: 1,
    x: 0, y: 0
}