react-build-status-badge
v1.1.6
Published
React build status badge component for any CI/CD service. Shows real-time status and supports Markdown for easy setup.
Downloads
133
Maintainers
Readme
Documentation
Read the official documentation.
👁️ Live Demo
Overview
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.
Donate
If this project helped you, please consider buying me a coffee or sponsoring me. Your support is much appreciated!
Table of Contents
- Documentation
- Overview
- Donate
- Table of Contents
- Installation
- Quick Start
- TypeScript
- Icon Attribution
- Contributing
- ⭐ Found It Helpful? Star It!
- License
Installation
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:
<BuildStatusBadge>
[![Deploy
Status](https://github.com/justinmahar/react-build-status-badge/workflows/Deploy/badge.svg)](https://github.com/justinmahar/react-build-status-badge/actions?query=workflow%3ADeploy)
</BuildStatusBadge>
See the BuildStatusBadge docs for additional methods and options.
TypeScript
Type definitions have been included for TypeScript support.
Icon Attribution
Favicon by Twemoji.
Contributing
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: 👉⭐
License
See LICENSE.md.