npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

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

146

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

justinmaharjustinmahar

Keywords

reactbuildstatusbadgecicdcomponentdeploymarkdownrealtimerealtimetimerintervalrefreshrefreshingreloadreloading

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

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.