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

@mavenomics/dashboard

v0.1.2

Published

Dashboard, serializers, and related framework runners

Downloads

15

Readme

@mavenomics/dashboard

Dashboard, serializers, and related framework runners.

The Dashboard package provides a top-level Phosphor widget called Dashboard. This can be consumed directly by third-party applications, and is suitable for embedding dashboards in your app.

Creating a Dashboard

To create a dashboard, you will need some meta-information about your app and a PartFactory:

// The BaseUrl should point to a location where Parts can load any dependencies,
// such as additional Javascript files or stylesheets.
const baseUrl = "/";
// The BaseViewUrl is used by the SlickGrid to create a dashboard hover- if your
// app doesn't support loading from URLs, you can just set this to the empty
// string.
const baseViewUrl = "/";

const dashboard = new Dashboard({
    partFactory: new PartFactory(),
    baseUrl,
    baseViewUrl
});

Saving and loading

To load a JSON model into a Dashboard:

await dashboard.loadFromModel(myJsonModel);

To serialize a Dashboard to JSON, use the DashboardSerializer:

DashboardSerializer.toJson(dashboard);

Events

Dashboards emit an OnDirty signal to notify consumers that their model has changed. Subscribe to this signal and call setClean() to acknowledge the change.

Dashboards also have a property called shouldNotifyDirty. This is to distinguish from minor changes that users might make over the course of interacting with a dashboard, that they normally wouldn't care to save (such as updating a global). Use this property for things like "onBeforeUnload" handlers.