5.3 KiB
badgedex
BadgeDex
BadgeDex API – URL Paraméterek
Badge
Az alábbi paraméterekkel szabályozhatod a /badge végpont működését:
| Paraméter | Kötelező | Alapértelmezett érték | Leírás | Példa értékek |
|---|---|---|---|---|
icon |
Igen | simpleicons |
A SimpleIcons ikon neve (kisbetű, kötőjellel). | github, docker, nginx |
label |
Nem | Simple Icons |
A badge-en megjelenő szöveg. | MyApp, Status |
style |
Nem | rect |
A badge stílusa. rect négyzetes, flat lekerekitett sarkok | rect, flat |
bgicon |
Nem | none |
Icon Háttérszín (hex vagy CSS színnév). Alapértelmezetten átlátszó. | #fff, #222, red |
bglabel |
Nem | none |
Label Háttérszín (hex vagy CSS színnév). Alapértelmezetten átlátszó. | #fff, #222, red |
color |
Nem | #000000 |
Szöveg színe (hex vagy CSS színnév). Harmonizál az icon szinével ha nem kérünk külön. | #333, white |
size |
Nem | 24 |
Ikon (és badge) magassága pixelben. | 16, 32, 64 |
labelpos |
Nem | right |
Szöveg pozíciója az ikonhoz képest: right, left, above, below. |
left, above |
fontweight |
Nem | normal |
Szöveg vastagsága (normal, bold, lighter, szám is lehet pl. 600). |
bold, 600 |
Példák
-
Alap badge:
/badge -
React ikon, label, size: 64, font: bold, fehér label szöveg, sárga label háttérszín, piros ikon háttérszín, label jobbra
/badge?icon=react&label=React%20expert%20level&size=64&fontweight=bold&color=white&bgicon=red&bglabel=yellow&labelpos=right -
GitHub ikon, piros label háttér, fehér szöveg:
/badge?icon=github&bglabel=red&color=white -
Szöveg balra, ikon jobbra:
/badge?labelpos=left -
Szöveg az ikon fölött, félkövér betű:
/badge?labelpos=above&fontweight=bold -
Nagyobb ikon és szöveg:
/badge?size=48
Tag
Az alábbi paraméterekkel szabályozhatod a /tag végpont működését:
| Paraméter | Kötelező | Alapértelmezett érték | Leírás | Példa értékek |
|---|---|---|---|---|
tag |
Igen | badgedex |
A tag tartalma(kisbetű, kötőjellel). | github, docker, nginx |
label |
Nem | BadgeDex |
A tag label tartalma. | MyApp, Status |
style |
Nem | rect |
A badge stílusa. rect négyzetes, flat lekerekitett sarkok | rect, flat |
bgtag |
Nem | none |
Icon Háttérszín (hex vagy CSS színnév). Alapértelmezetten átlátszó. | #fff, #222, red |
bglabel |
Nem | none |
Label Háttérszín (hex vagy CSS színnév). Alapértelmezetten átlátszó. | #fff, #222, red |
color |
Nem | #000000 |
Szöveg színe (hex vagy CSS színnév). Harmonizál az icon szinével ha nem kérünk külön. | #333, white |
size |
Nem | 24 |
Ikon (és badge) magassága pixelben. | 16, 32, 64 |
labelpos |
Nem | right |
Szöveg pozíciója az ikonhoz képest: right, left, above, below. |
left, above |
fontweight |
Nem | normal |
Szöveg vastagsága (normal, bold, lighter, szám is lehet pl. 600). |
bold, 600 |
Példák
-
Alap badge:
/badge -
React ikon, label, size: 64, font: bold, fehér label szöveg, sárga label háttérszín, piros ikon háttérszín, label jobbra
/badge?icon=react&label=React%20expert%20level&size=64&fontweight=bold&color=white&bgicon=red&bglabel=yellow&labelpos=right -
GitHub ikon, piros label háttér, fehér szöveg:
/badge?icon=github&bglabel=red&color=white -
Szöveg balra, ikon jobbra:
/badge?labelpos=left -
Szöveg az ikon fölött, félkövér betű:
/badge?labelpos=above&fontweight=bold -
Nagyobb ikon és szöveg:
/badge?size=48
A badge SVG formátumban tér vissza, így közvetlenül beilleszthető HTML-be vagy Markdown