react-build-status-badge
1.1.8 • Public • Published React build status badge component for any CI/CD service.
Shows real-time status and supports Markdown for easy setup.
Read theofficial documentation.
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.
- 📜 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.
If this project helped save you time, please consider buying me a coffee, which powers my development (and life). Your support is much appreciated!
- Documentation
- Overview
- Donate
- Table of Contents
- Installation
- Quick Start
- TypeScript
- Icon Attribution
- Contributing
- ⭐ Found It Helpful? Star It!
- License
npm i react-build-status-badge
import{BuildStatusBadge}from"react-build-status-badge";
The easiest way is to simply paste in your badge Markdown image link, like so:
<BuildStatusBadge> [](https://github.com/justinmahar/react-build-status-badge/actions?query=workflow%3ADeploy)</BuildStatusBadge>
See theBuildStatusBadge docs for additional methods and options.
Type definitions have been included forTypeScript support.
Favicon byTwemoji.
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 astar:👉⭐
Want to support the project? Feel free to grab me a coffee, which is my main source of fuel for development:
SeeLICENSE.md.
Package Sidebar
Install
npm i react-build-status-badge
Weekly Downloads
23
Version
1.1.8
License
MIT
Unpacked Size
21.2 kB
Total Files
9