Skip to content

IagoLast/squire-core

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Squire

What is Squire?

Squire is a mini javascript library to generate SVG project badges both in node and browser, see a live demo here.

API

.generateBadgeSVG(opts)

This method generates a SVG badge from the following parameters.

  • borderRadius: = The border radius of the badge, default value is 4.
  • fontSize: The size in px of the text in the badge, default value is 9.
  • height: The heigt in pixels of the badge, default value is 20.
  • subject The text shown in the left part of the badge, default value is ''.
  • subjectColor: The background color of the left part of the badge, default value is .
  • subjectLengt: The lenght in pixels of the left part of the badge.
  • subjectTextColor: The text color of the left part of the badge, defaults to white.
  • value: The text shown in the rectangle shown in the right part of the badge.
  • valueColor: The color of the text shown in the right part of the badge.
  • valueLength: The lenght in pixels of the rectangle shown in the right part of the badge.
  • valueTextColor: The color of the text shown in the right part of the badge, defaults to white.
  • width: Total with of badge. This will be applied to the SVG element.

.generateBadge(subject, value, color)

This method gives an easy way to generate a badge.

  • subject The text shown in the left part of the badge.
  • value: The text shown in the rectangle shown in the right part of the badge.
  • color: The color of the text shown in the right part of the badge.

Creating a server

Use https://webtask.io and paste the code under the server/webtask.js to have your own badge server.

About

javascript library to generate svg badges

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published