Movatterモバイル変換


[0]ホーム

URL:


react-build-status-badge
TypeScript icon, indicating that this package has built-in type declarations

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.

npm Version View project on GitHub Deploy Status

Buy me a coffee Sponsor

Documentation

Read theofficial 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 save you time, please consider buying me a coffee, which powers my development (and life). Your support is much appreciated!

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

Table of Contents

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 theBuildStatusBadge docs for additional methods and options.

TypeScript

Type definitions have been included forTypeScript support.

Icon Attribution

Favicon byTwemoji.

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 astar:👉⭐

Want to support the project? Feel free to grab me a coffee, which is my main source of fuel for development:

Buy me a coffee Buy me 3 coffees Buy me 5 coffees

License

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

Last publish

Collaborators

  • justinmahar

[8]ページ先頭

©2009-2025 Movatter.jp