shields.io - static badges
Last updated
Last updated
The static badge accepts a single required path parameter which encodes either:
Label, message and color separated by a dash -
. For example:
-
Message and color only, separated by a dash -
. For example:
-
Underscore _
or %20
Space
Double underscore __
Underscore _
Double dash --
Dash -
Hex, rgb, rgba, hsl, hsla and css named colors may be used.
badgeContent
string — REQUIRED
Label, (optional) message, and color. Separated by dashes
Example: build-passing-brightgreen
style
string
Possible values: [flat
, flat-square
, plastic
, for-the-badge
, social
]
If not specified, the default style for this badge is "flat".
Example: flat
logo
string
Icon slug from simple-icons. You can click the icon title on to copy the slug or they can be found in the in the simple-icons repository. .
Example: appveyor
logoColor
string
The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.
Example: violet
logoSize
string
Make icons adaptively resize by setting auto
. Useful for some wider logos like amd
and amg
. Supported for simple-icons logos but not for custom logos.
Example: auto
label
string
Override the default left-hand-side text ( needed for spaces or special characters!)
Example: healthiness
labelColor
string
Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).
Example: abcdef
color
string
Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).
Example: fedcba
cacheSeconds
string
HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).
Example: 3600
link
string[]
Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an <object>
HTML tag, but not an <img>
tag or a markup language.