@codersrank/activity

CodersRank Activity Widget

CodersRank Activity Widget is a web component that allows you easily integrate nice looking activity chart from your CodersRank profile to your personal website:

Install from NPM

The widget script available through NPM:

npm i @codersrank/activity --save

After installation you need to import and register web component:

import CodersRankActivity from '@codersrank/activity';

// register web component as <codersrank-activity> element
window.customElements.define('codersrank-activity', CodersRankActivity);

Install from CDN

Widget can also be downloaded or linked directly from CDN:

<!-- replace x.x.x with actual version -->
<script src="https://unpkg.com/@codersrank/activity@x.x.x/codersrank-activity.min.js"></script>

In this case it is not required to register web component, it is already registered as <codersrank-activity> element.

Usage

As it is a web component the usage is pretty simple, just add widget HTML tag with your CodersRank username

<codersrank-activity username="YOUR_USERNAME"></codersrank-activity>

Widget Attributes

Widget supports following properties as HTML element attributes:

Name	Type	Default	Description
username	string		Your CodersRank username
weeks	number	52	Amount of weeks to be rendered in chart (max 52).
labels	boolean	false	Display chart labels (months and days of the week)
legend	boolean	false	Display legend below the chart
tooltip	boolean	false	Enables tooltip with number of activities per day
step	number	10	Number of activities for division by colors
svg-width	number	800	Render width of chart's SVG element
branding	boolean	true	Displays "Powered by CodersRank" link

For example, to enable labels, legend and tooltip:

<codersrank-activity username="YOUR_USERNAME" labels legend tooltip></codersrank-activity>

Styling

It is possible to customize widget colors with CSS Custom Properties (CSS Variables) by setting them directly on the widget element with style attribute or in CSS.

There are following CSS Custom Properties are available:

Property	Value
--font-family	Open Sans, Helvetica Neue, Helvetica, Arial, sans-serif
--label-font-size	9px
--label-text-color	#999ea4
--legend-font-size	12px
--legend-text-color	#999ea4
--legend-item-width	14px
--legend-item-height	14px
--legend-margin	1em 0 0 0
--bg-color-0	#f6f6f6
--bg-color-1	rgba(80, 176, 186, 0.3)
--bg-color-2	rgba(80, 176, 186, 0.6)
--bg-color-3	rgba(80, 176, 186, 1)
--bg-color-4	#24565a
--border-color-0	transparent
--border-color-1	transparent
--border-color-2	transparent
--border-color-3	transparent
--border-color-4	transparent
--svg-width	100%
--svg-height	auto
--preloader-color	#72a0a8
--tooltip-font-size	14px
--branding-text-color	inherit

For example, to change legend text color to red and font-size to 10px, add this to CSS stylesheet:

codersrank-activity {
  --legend-text-color: red;
  --legend-font-size: 10px;
}

Events

Widget element supports the following events:

Name	Description	Detail
error	Will be fired on data request error	event.detail will contain an error object
data	Will be fired right after data request	event.detail will contain an object with data and total properties. total property contains number of total activities data object contains information about activities by dates

For example:

<codersrank-activity id="activity" ...></codersrank-activity>

function onData(event) {
  const total = event.detail.total;
  console.log(`${total} activities in the last year`);
}
document.querySelector('#activity').addEventListener('data', onData);

Use As Image

It is also possible to insert Activity widget as an image. It is useful in places where you can't integrate web component, or for example on your GitHub profile README.md page.

Image URL is the following:

https://cr-ss-service.azurewebsites.net/api/ScreenShot?widget=activity&username=YOUR_USERNAME

It accepts all widget attributes as query string parameters, plus one extra parameter:

Name	Type	Default	Description
width	number	800	Width of widget element (generated image). Note that generated image has @2x pixel density, so the PNG image will be actually generated in @2x size from the one specified here
style	string		style attribute value (here you can specify all CSS variables)

For example:

<img
  src="https://cr-ss-service.azurewebsites.net/api/ScreenShot?widget=activity&username=YOUR_USERNAME&labels=true"
/>

Note that you need to URL Encode some of the characters, for example # should be %23 and #ff0 color should be specified as %23ff0 in query.

Contribution

Yes please! See the contributing guidelines for details.

Licence

This project is licensed under the terms of the MIT license.