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

subgraph-status

v1.2.3

Published

A UI library to display subgraph statuses

Downloads

70

Readme

Subgraph status banner

A Ui component to display subgraph's status.

Demo 🚀


Getting Started

yarn add subgraph-status

Usage

UI Display

Exports StatusBanner and StatusCard, to display status of multiple subgraphs with a carousel effect.

import {StatusBanner, StatusCard} from "subgraph-status";

function  App()  {
	return (
        <>
	    <StatusBanner subgraphs={[{name: "Subgraph 1" , url : "subgraphUrl"}]}/>
	    <StatusCard subgraphs={[{name: "Subgraph 1" , url : "subgraphUrl"}]}/>
        </>
	);
}

useWatcher hook

Exports a hook that takes in the subgraphs and return the Statuses respectively. Use this if you want to build your own UI around it.

import { useWatcher } from "subgraph-status";

function  App()  {
    const {statuses, isLoadingIds, isLoadingStatus} = useWatcher([{name: "Subgraph 1" , url : "subgraphUrl"}, {name: "Subgraph 2" , url : "subgraphUrl"}]);

	return (
        <>
            // Display statuses.
        </>
	);
}

Subgraph url is the query url that is used to make gql requests.


Customizations

  • watcherOptions :- options to customize threshold and interval for useWatcher hook.

    • threshold : Blocks after which a subgraph will be marked as lagging. Default - 50,000 Blocks
    • interval : Interval to check subgraphs health. Default - 30 sec
  • carouselOptions :- Options to customize carousel

  • autoHide :- Hide banner if all subgraphs are healthy, false by default

  • theme:- optional prop to override the default theme of Banner and Card.

  • textFormatter:- Render custom text for each status slide.