contwidgetor-ui

Widget for contwidgetor

Usage no npm install needed!

<script type="module">
  import contwidgetorUi from 'https://cdn.skypack.dev/contwidgetor-ui';
</script>

README

contwidgetor-ui

screen shot 2015-11-29 at 10 56 38 am

Still in development

What is it?

A simple React component to display a grid showing your open-source contributions a la github

API

Calling require('contwidgetor-ui'); makes two components available.

<NoContributionsGrid /> does not take any props and will just render a simple text. <ContributionsGrid contributions={...}/> where contributions is a JSON object.

The JSON object has items of this form:"2015-11-28": 4. The key is a date and the value being the number of contributions for this date.

Example

There is a working example in the Example folder. To run it:

cd Example
npm install
webpack
open index.html