@mynameiskazim/storebadge
v1.0.1
Published
App Store, Google Play, and Microsoft Store badges in multiple languages — SVG & PNG assets with a typed JavaScript API
Maintainers
Readme
Storebadge
App Store, Google Play, and Microsoft Store badges in multiple languages — available as raw SVG/PNG files and as an npm package with a fully-typed JavaScript API.
Installation
npm install storebadge
# or
yarn add storebadge
# or
pnpm add storebadgeJavaScript / TypeScript API
Get a badge URL (CDN)
import { appStoreBadgeUrl, googlePlayBadgeUrl, microsoftBadgeUrl } from 'storebadge';
appStoreBadgeUrl('en', 'black');
// → 'https://cdn.jsdelivr.net/gh/mynameiskazim/storebadge/badges/appstore/appstore-black-en.svg'
googlePlayBadgeUrl('tr');
// → 'https://cdn.jsdelivr.net/gh/mynameiskazim/storebadge/badges/googleplay/googleplay-tr.svg'
googlePlayBadgeUrl('tr', 'png');
// → 'https://cdn.jsdelivr.net/gh/mynameiskazim/storebadge/badges/googleplay/googleplay-tr.png'
microsoftBadgeUrl('en-us', 'dark');
// → 'https://cdn.jsdelivr.net/gh/mynameiskazim/storebadge/badges/microsoft/en-us-dark.svg'Get a local file path (relative to package root)
import { appStoreBadgePath, googlePlayBadgePath, microsoftBadgePath } from 'storebadge';
appStoreBadgePath('de', 'white');
// → 'badges/appstore/appstore-white-de.svg'
googlePlayBadgePath('de');
// → 'badges/googleplay/googleplay-de.svg'
microsoftBadgePath('de', 'light');
// → 'badges/microsoft/de-light.svg'Grouped API
import { badges } from 'storebadge';
badges.appStore.url('fr', 'black');
badges.googlePlay.url('fr');
badges.microsoft.url('fr', 'dark');Custom CDN / self-hosted
import { setBaseUrl, appStoreBadgeUrl } from 'storebadge';
setBaseUrl('https://cdn.example.com/storebadge');
appStoreBadgeUrl('en', 'black');
// → 'https://cdn.example.com/storebadge/appstore/appstore-black-en.svg'React example
import { appStoreBadgeUrl, googlePlayBadgeUrl } from 'storebadge';
export function AppBadges({ locale = 'en' }) {
return (
<div style={{ display: 'flex', gap: 12 }}>
<a href="https://apps.apple.com/app/your-app">
<img src={appStoreBadgeUrl(locale, 'black')} alt="Download on the App Store" height={40} />
</a>
<a href="https://play.google.com/store/apps/details?id=com.your.app">
<img src={googlePlayBadgeUrl(locale)} alt="Get it on Google Play" height={40} />
</a>
</div>
);
}Notes
- Sources:
- Google Play: https://play.google.com/intl/en_us/badges/
- Apple App Store: https://developer.apple.com/app-store/marketing/guidelines/
- Microsoft Store: https://docs.microsoft.com/en-us/windows/apps/publish/publish-your-app-in-the-microsoft-store
- App Store: SVG with 2 color variants (black, white)
- Google Play: SVG & PNG formats available
- Microsoft Store: SVG with 2 theme variants (dark, light)
- SVG files are optimized for web use
Download
App Store Badges
SVG only — Available in both black and white variants
| Language | Language Code | Preview (Black) | Preview (White) |
|---|---|---|---|
| Arabic | ar | |
|
| Azerbaijani |
az | |
|
| Bulgarian |
bg | |
|
| Bengali |
bn | |
|
| Czech |
cs | |
|
| Danish |
da | |
|
| German |
de | |
|
| Greek |
el | |
|
| English |
en | |
|
| Spanish |
es | |
|
| Spanish (CA) |
es-ca | |
|
| Spanish (MX) |
es-mx | |
|
| Estonian |
et | |
|
| Finnish |
fi | |
|
| Filipino |
fil | |
|
| French |
fr | |
|
| French (CA) |
fr-ca | |
|
| Gujarati |
gu | |
|
| Hebrew |
he | |
|
| Hindi |
hi | |
|
| Croatian |
hr | |
|
| Hungarian |
hu | |
|
| Indonesian |
id | |
|
| Italian |
it | |
|
| Japanese |
ja | |
|
| Kannada |
kn | |
|
| Korean |
ko | |
|
| Lithuanian |
lt | |
|
| Latvian |
lv | |
|
| Malayalam |
ml | |
|
| Marathi |
mr | |
|
| Malay |
ms | |
|
| Maltese |
mt | |
|
| Norwegian |
nb | |
|
| Dutch |
nl | |
|
| Odia |
or | |
|
| Punjabi |
pa | |
|
| Polish |
pl | |
|
| Portuguese (BR) |
pt-br | |
|
| Portuguese (PT) |
pt-pt | |
|
| Romanian |
ro | |
|
| Russian |
ru | |
|
| Slovak |
sk | |
|
| Slovenian |
sl | |
|
| Swedish |
sv | |
|
| Tamil |
ta | |
|
| Telugu |
te | |
|
| Thai |
th | |
|
| Turkish |
tr | |
|
| Ukrainian |
uk | |
|
| Urdu |
ur | |
|
| Vietnamese |
vi | |
|
| Chinese (CN) |
zh-cn | |
|
| Chinese (TW) |
zh-tw | |
|
Google Play Badges
SVG & PNG available — Use .svg or .png extension
| Language | Language Code | Preview (SVG) |
|---|---|---|
| Afrikaans | af | |
| Arabic |
ar | |
| Azerbaijani |
az | |
| Belarusian |
be | |
| Bulgarian |
bg | |
| Bengali |
bn | |
| Bosnian |
bs | |
| Catalan |
ca | |
| Czech |
cs | |
| Danish |
da | |
| German |
de | |
| Greek |
el | |
| English |
en | |
| Spanish |
es | |
| Spanish (Latin America) |
es-latam | |
| Estonian |
et | |
| Basque |
eu | |
| Persian |
fa | |
| Finnish |
fi | |
| Filipino |
fil | |
| French |
fr | |
| French (Canada) |
fr-ca | |
| Irish |
ga | |
| Galician |
gl | |
| Gujarati |
gu | |
| Hebrew |
he | |
| Hindi |
hi | |
| Croatian |
hr | |
| Hungarian |
hu | |
| Armenian |
hy | |
| Indonesian |
id | |
| Icelandic |
is | |
| Italian |
it | |
| Japanese |
ja | |
| Georgian |
ka | |
| Kazakh |
kk | |
| Khmer |
km | |
| Kannada |
kn | |
| Korean |
ko | |
| Kyrgyz |
ky | |
| Lao |
lo | |
| Lithuanian |
lt | |
| Latvian |
lv | |
| Macedonian |
mk | |
| Malayalam |
ml | |
| Mongolian |
mn | |
| Marathi |
mr | |
| Malay |
ms | |
| Burmese |
my | |
| Norwegian |
nb | |
| Nepali |
ne | |
| Dutch |
nl | |
| Punjabi |
pa | |
| Polish |
pl | |
| Portuguese (Brazil) |
pt-br | |
| Portuguese (Portugal) |
pt-pt | |
| Romanian |
ro | |
| Russian |
ru | |
| Sinhala |
si | |
| Slovak |
sk | |
| Slovenian |
sl | |
| Albanian |
sq | |
| Serbian |
sr | |
| Swedish |
sv | |
| Swahili |
sw | |
| Tamil |
ta | |
| Telugu |
te | |
| Thai |
th | |
| Turkish |
tr | |
| Ukrainian |
uk | |
| Urdu |
ur | |
| Uzbek |
uz | |
| Vietnamese |
vi | |
| Chinese (Simplified) |
zh-cn | |
| Chinese (Traditional) |
zh-tw | |
| Zulu |
zu | |
Microsoft Store Badges
SVG only — Available in both dark and light variants
| Language | Language Code | Preview (Dark) | Preview (Light) |
|---|---|---|---|
| Afrikaans | af | |
|
| Amharic |
am | |
|
| Arabic |
ar | |
|
| Assamese |
as | |
|
| Azerbaijani |
az | |
|
| Bulgarian |
bg | |
|
| Bengali |
bn | |
|
| Bosnian |
bs | |
|
| Catalan |
ca | |
|
| Welsh |
cy | |
|
| Czech |
cs | |
|
| Danish |
da | |
|
| German |
de | |
|
| Greek |
el | |
|
| English (US) |
en-us | |
|
| Spanish |
es | |
|
| Estonian |
et | |
|
| Persian |
fa | |
|
| Finnish |
fi | |
|
| Filipino |
fil | |
|
| French |
fr | |
|
| Irish |
ga | |
|
| Scottish Gaelic |
gd | |
|
| Galician |
gl | |
|
| Gujarati |
gu | |
|
| Hebrew |
he | |
|
| Hindi |
hi | |
|
| Croatian |
hr | |
|
| Hungarian |
hu | |
|
| Armenian |
hy | |
|
| Indonesian |
id | |
|
| Icelandic |
is | |
|
| Italian |
it | |
|
| Japanese |
ja | |
|
| Georgian |
ka | |
|
| Kazakh |
kk | |
|
| Khmer |
km | |
|
| Kannada |
kn | |
|
| Korean |
ko | |
|
| Konkani |
kok | |
|
| Luxembourgish |
lb | |
|
| Lao |
lo | |
|
| Lithuanian |
lt | |
|
| Latvian |
lv | |
|
| Maori |
mi | |
|
| Macedonian |
mk | |
|
| Malayalam |
ml | |
|
| Marathi |
mr | |
|
| Malay |
ms | |
|
| Maltese |
mt | |
|
| Nepali |
ne | |
|
| Dutch |
nl | |
|
| Norwegian Nynorsk |
nn | |
|
| Odia |
or | |
|
| Punjabi |
pa | |
|
| Polish |
pl | |
|
| Portuguese (Brazil) |
pt-br | |
|
| Portuguese (Portugal) |
pt-pt | |
|
| Quechua |
quz | |
|
| Romanian |
ro | |
|
| Russian |
ru | |
|
| Slovak |
sk | |
|
| Slovenian |
sl | |
|
| Albanian |
sq | |
|
| Serbian |
sr | |
|
| Swedish |
sv | |
|
| Tamil |
ta | |
|
| Telugu |
te | |
|
| Thai |
th | |
|
| Turkish |
tr | |
|
| Uyghur |
ug | |
|
| Ukrainian |
uk | |
|
| Urdu |
ur | |
|
| Uzbek |
uz | |
|
| Vietnamese |
vi | |
|
| Chinese (Simplified) |
zh-cn | |
|
| Chinese (Traditional) |
zh-tw | |
|
📝 Complete Example
Embed all three app store badges in your website:
<div style="display: flex; gap: 10px; margin: 20px 0;">
<!-- App Store -->
<a href="https://apps.apple.com/app/your-app">
<img
src=https://github.com/mynameiskazim/storebadge/raw/master/badges/appstore/appstore-black-en.svg"
alt="Download on the App Store"
height="40"
/>
</a>
<!-- Google Play -->
<a href="https://play.google.com/store/apps/details?id=com.your.app">
<img
src="https://github.com/mynameiskazim/storebadge/raw/master/badges/googleplay/googleplay-en.svg"
alt="Get it on Google Play"
height="40"
/>
</a>
<!-- Microsoft Store -->
<a href="https://www.microsoft.com/store/apps/YOUR_APP_ID">
<img
src="https://github.com/mynameiskazim/storebadge/raw/master/badges/microsoft/en-us-dark.svg"
alt="Get from Microsoft Store"
height="40"
/>
</a>
</div>📌 Tips & Best Practices
- Always pin to a version tag (
@v1.0.0) in production for stability - Color variants: Choose
blackfor light backgrounds,whitefor dark backgrounds (App Store) - Theme variants: Choose
darkfor light backgrounds,lightfor dark backgrounds (Microsoft) - Fallback PNG: Google Play badges available in both SVG and PNG formats
- Height: Recommended height is
40pxfor web display - Locale support: Use language codes from the tables above (e.g.,
trfor Turkish,enfor English)
📚 Sources
- Google Play Badges: https://play.google.com/intl/en_us/badges/
- Apple App Store Badges: https://developer.apple.com/app-store/marketing/guidelines/
- Microsoft Store Badges: https://docs.microsoft.com/en-us/windows/apps/publish/publish-your-app-in-the-microsoft-store
📄 License
These badges are provided by their respective companies. Please review their usage guidelines before using them commercially.
