import React, { Fragment } from 'react' import PropTypes from 'prop-types' import StaticBadgeMaker from './static-badge-maker' import DynamicBadgeMaker from './dynamic-badge-maker' import { staticBadgeUrl } from '../lib/badge-url' import { advertisedStyles, logos } from '../../supported-features.json' export default class Usage extends React.PureComponent { static propTypes = { baseUrl: PropTypes.string.isRequired, longCache: PropTypes.bool.isRequired, } renderColorExamples() { const { baseUrl, longCache } = this.props const colors = [ 'brightgreen', 'green', 'yellowgreen', 'yellow', 'orange', 'red', 'lightgrey', 'blue', 'ff69b4', ] return (
{colors.map((color, i) => (
{' '}
{}
|
|
{badgeUrl}
|
{baseUrl}
/badge/<SUBJECT>-<STATUS>-<COLOR>.svg
Dashes --
|
→ |
- Dash
|
Underscores __
|
→ |
_ Underscore
|
_ or Space
|
→ |
Space
|
/badge/dynamic/json.svg?url=<URL>&label=<LABEL>&query=<
$.DATA.SUBDATA
>&colorB=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>
/badge/dynamic/xml.svg?url=<URL>&label=<LABEL>&query=<
//data/subdata
>&colorB=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>
/badge/dynamic/yaml.svg?url=<URL>&label=<LABEL>&query=<
$.DATA.SUBDATA
>&colorB=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>
The following styles are available. Flat is the default. Examples are shown with an optional logo:
{this.renderStyleExamples()}Here are a few other parameters you can use: (connecting several with "&" is possible)
?label=healthinesses
|
Override the default left-hand-side text ( URL-Encoding {} needed for spaces or special characters!) |
?logo=appveyor
|
Insert one of the named logos from ( {this.constructor.renderNamedLogos()}) or{' '} simple-icons |
?logo=data:image/png;base64,…
|
Insert custom logo image (≥ 14px high) |
?logoColor=violet
|
Set the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported) |
?logoWidth=40
|
Set the horizontal space to give to the logo |
?link=http://left&link=http://right
|
Specify what clicking on the left/right of a badge should do (esp. for social badge style) |
?colorA=abcdef
|
Set background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported) |
?colorB=fedcba
|
Set background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported) |
?maxAge=3600
|
Set the HTTP cache lifetime in secs (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored) |
We support .svg, .json, .png{' '}
and a few others, but use them responsibly.