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

ihme-ui

v2.0.2

Published

Visualization tools from the Institute for Health Metrics and Evaluation

Downloads

363

Vulnerabilities

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

Links

Git

Maintainers

gmedrashgmedrashaaronkeelaaronkeeljamesvermillionjamesvermilliondavschnedavschnemlafranmlafrankbeamekbeamemfern93mfern93ryshackletonryshackletonevanl5evanl5dartbuwdartbuwbenbenbuhbenbenbenbuhben

Keywords

Readme

Build Status codecov.io

IHME-UI

ihme-ui is a collection of JavaScript utilities and React-based user interface elements and visualization components developed by the Institute of Health Metrics and Evaluation. This collection is used in IHME's visualizations of global health metrics.

Installation

npm install -S ihme-ui

Getting started

In it's most basic form, this library can be included in a <script /> tag and accessed off of window as ihmeUI. If you've installed the library from the npm registry, you can pull the library out of your node_modules folder. If not, grab it off of the unoffical NPM CDN, unpkg.

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>IHME-UI Starter</title>
  <link rel="stylesheet" href="node_modules/ihme-ui/dist/ihme-ui.css"/>
  <!-- OR from unkpk CDN
  <link rel="stylesheet" href="//unpkg.com/ihme-ui/dist/ihme-ui.css">
  -->
</head>
<body>
  <main id="app">...</main>
  <script src="node_modules/ihme-ui/dist/ihme-ui.js"></script>
  <!-- OR from unkpk CDN
  <script src="//unpkg.com/ihme-ui/dist/ihme-ui.js"></script>
  -->
  <script>
    var chart = React.createElement(ihmeUI.AxisChart, {
      domain: ihmeUI.linspace([3, 10], 200),
      ...
    });

    ReactDOM.render(chart, document.getElementById('app'));
  </script>
</body>
</html>

In most cases, however, you'll be importing ihme-ui into your project, and bundling it with a module bundler like Webpack or Rollup. In support of this, ihme-ui exposes both a CommonJS (i.e., var ihmeUI = require('ihme-ui')) and an ES module (i.e., import ihmeUI from 'ihme-ui') target.

// index.js

import { AxisChart, linspace } from 'ihme-ui';
//...

Local development and posting pull requests

  1. In Github, click on the Code dropdown/button to clone the repo. You can use either https or ssh.
  2. Open a terminal, navigate to where you have your repos saved, then clone. git clone theUrlFromGithubgoes.here
  3. Be sure to set up a personal token; you'll need it to push up your working branch to the remote.
  4. Change to the ihme-ui directory and install dependencies.
cd ihme-ui
npm i
  1. Create a new ticket branch and check it out. git checkout -b ticket-branch-name
  2. Make your code changes.
  3. Run the demo for that component (e.g., map demo). You'll need to re-run this script every time you save additional changes to rebuild the demo. npm run demo map
  4. Open a browser window and enter the path to the demo. For example, http://localhost:8888//ihme-ui/src/ui/compositions/map/demo/index.html (Change the port number to whichever port you're using for local development in MAMP.)
  5. You'll need to refresh the browser every time you rebuild the demo.
  6. Stage changes and commit as necessary.
git status // to see changed files`
git add filename.js // or git add . to add all modified files
git commit -m "enter your commit message here" // commit your changes locally
  1. Push up your working branch in order to create a PR. git push -u origin working-branch-name
  2. Go to IHME-UI in Github and click on Compare & Pull Request, then click New Pull Request.
  3. Select your working branch and which branch you're making the request onto (typically main).
  4. Add a description of the changes.
  5. Add other IHME developers as reviewers
  6. Click Create Pull Request.

API Reference