TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

🚥 React Build Status Badge

React build status badge component for any CI/CD service.
Shows real-time status and supports Markdown for easy setup.

npm Version  View project on GitHub  Deploy Status  Sponsor


Read the official documentation.

👁️ Live Demo


BuildStatusBadge is a React component that allows you to put a real-time build status badge on your site.

The badge automatically updates as the status changes—no clearing the cache or refreshing the page required.

Just paste in your status badge Markdown and you're ready to go. Additional options are available.

Features include:

  • 📜 Supports Markdown links. Just paste and go.
    • Use the Markdown link from your CI/CD service for dead simple setup.
  • 🔄 Automatic reloading for real-time status
    • Badge reloads automatically so the status stays current. No page refresh required.
  • 🐣 New badge every time using cache-busting
    • Uses client-side cache-busting to prevent old, cached build status badges from being shown.


I hope this project makes your life a little easier! If it does and you'd like to show your appreciation, consider supporting the project with a coffee or sponsorship.

Your support helps keep the project going and will earn you some serious virtual high fives. Maybe even a virtual fist bump if you're feeling extra cool.

Sponsor via GitHub Buy me a coffee Buy me 3 coffees Buy me 5 coffees

Table of Contents


npm i react-build-status-badge

Quick Start

import { BuildStatusBadge } from "react-build-status-badge";

The easiest way is to simply paste in your badge Markdown image link, like so:


See the BuildStatusBadge docs for additional methods and options.


Type definitions have been included for TypeScript support.

Icon Attribution

Favicon by Twemoji.


Open source software is awesome and so are you. 😎

Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.

For major changes, open an issue first to discuss what you'd like to change.

Found It Helpful? Star It!

If you found this project helpful, let the community know by giving it a star: 👉



Package Sidebar


npm i react-build-status-badge

Weekly Downloads






Unpacked Size

78.7 kB

Total Files


Last publish


  • justinmahar