Skip to content

Latest commit

 

History

History
117 lines (96 loc) · 7.52 KB

Readme.md

File metadata and controls

117 lines (96 loc) · 7.52 KB
Raw

Badgeland-web

Usage:

    https://badge.land/badge/{subject}[/{text}][?params]

Path:
    /subject         string
    /text (Optional) string. Text can also be comma separated numbers for sparkline

Query Params:
    color       badge color. Must be a valid css color
    icon        icon can be any "Brand" or "Solid" icons from fontawesome
    icon_color  icon color. Must be a valid css color
    style       [possible values: flat, classic] defaults to classic
    size        [possible values: large, medium, small] defaults to small
Badge with only subject https://badge.land/b/text badge_sub
Default badge https://badge.land/b/subject/text badge_def
Badge with medium size https://badge.land/b/size/medium?size=medium badge_md
Badge with large size https://badge.land/b/size/large?size=large badge_lg
Red badge https://badge.land/b/color/red?color=ff0000 badge_color
Badge with brand icon https://badge.land/b/icon/brand?icon=npm badge_icon1
Badge with solid icon https://badge.land/b/icon/solid?icon=code badge_icon2
Badge with sparkline chart https://badge.land/b/data/1,5,2,4,8,3,7 badge_data
Flat badge https://badge.land/b/style/flat?style=flat badge_flat

Icon cany be any Brand or Solid icons from fontawesome Color can be any 6 or 8 digit hex color, a valid css color name or RGB / RGBA color

URL

Generate live badges from your own endpoint.

  • URL https://badge.land/url

  • Method GET

  • Query Params

param type required Description
source url ✅ Source for the badge
color string Any valid css color. Supports Color name, RGB and hex
icon string Icon can be any "Brand" or "Solid" icons from fontawesome
icon_color string Any valid css color. Supports Color name, RGB and hex
style flat | classic Style of the badge
size large | medium | small Size of the badge

  • Source Param is expected to be as following

    • METHOD GET

    • Response Type application/json

    • Response Body

    {
      text?: string
      subject: string
      style?: "Flat" | "Classic"
      size?: "Large" | "Medium" | "Small"
      color?: string // Can be any valid CSS color
      icon?: string // Icon can be any "Brand" or "Solid" icons from fontawesome
      icon_color?: string // Can be any valid CSS color
      data?: number[]
  }

Query params take presidence if any option is passed in both query param and endpoint.

Runkit example
Text badge https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/allText runkit_allText
Data badge https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/allData runkit_allData
badge with only subject https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/subject runkit_subject
default badge with text https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/withText runkit_withText
Medium size badge https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/mediumSize runkit_mediumSize
Large size badge https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/largeSize runkit_largeSize
Red badge https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/red runkit_red
badge with brand icon https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/iconBrand runkit_iconBrand
badge with solid icon https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/iconSolid runkit_iconSolid
Chart badge https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/data runkit_data
Flat badge https://badge.land/url/?source=https://b5vhr8tsmbj6.runkit.sh/flat runkit_flat