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

@undp_sdg_ai_lab/undp-radar

v1.1.1

Published

React UNDP Radar Library to make the usage of the radar simpler and re-usable across projects

Downloads

50

Readme

UNDP Radar Library

Code base seated on repo UNDP Radar.

Made with create-react-library

NPM JavaScript Style Guide

Install

yarn add @undp_sdg_ai_lab/undp-radar
npm install --save @undp_sdg_ai_lab/undp-radar

Usage

import React, { Component } from 'react';

import {
  AddCSV,
  DataProvider,
  RadarDataGenerator,
  RadarProvider,
  SetData,
  Utilities,
  RawBlipType,
  MappingType,
  ColorsParamType,
  OrdersParamType,
  KeysObject
} from '@undp_sdg_ai_lab/undp-radar';
import '@undp_sdg_ai_lab/undp-radar/dist/index.css';

import csvData2 from './assets/some_csv_data_file.csv';

const Example: React.FC = () => {
  const mapping: MappingType<RawBlipType> = (item: { [key: string]: string }) =>
    ({
      Quadrant: item['Quadrant'],
      Title: item['Title'],
      Horizon: item['Horizon'],
      'Use Case': item['Use Case'],
      Technology: Utilities.cleanupStringArray(item.Technology.split(','))
    } as any);

  const keys: KeysObject = {
    techKey: 'Technology',
    titleKey: 'Title',
    horizonKey: 'Horizon',
    quadrantKey: 'Quadrant',
    useCaseKey: 'Use Case'
  };

  const orders: OrdersParamType = {
    quadrants: ['Response', 'Recovery', 'Resilience', 'Preparedness'],
    horizons: ['Production', 'Validation', 'Prototype', 'Idea']
  };

  const colors: ColorsParamType = {
    quadrants: {
      colors: [
        { r: 255, g: 0, b: 0, opacity: 1 },
        { r: 0, g: 255, b: 0, opacity: 1 },
        { r: 0, g: 0, b: 255, opacity: 1 },
        { r: 255, g: 0, b: 255, opacity: 1 }
      ],
      initialOpacity: 0.7, // [OPTIONAL default=0.7] opacity from the inner horizon
      clumpingOpacity: 1.1 // [OPTIONAL default=1.0] compresses the opacity so it becomes much smoother
    }
  };

  return (
    <RadarProvider>
      <DataProvider>
        <SetData keys={keys} orders={orders} colors={colors} />
        <RadarDataGenerator />
        <AddCSV csvFile={csvData2} mapping={mapping} />
        <RadarApp />
        <ToolTip>
          <PopOver />
        </ToolTip>
      </DataProvider>
    </RadarProvider>
  );
};

Don't forget to add csv files module declaration to your react-app-env.d.ts like so:

/// <reference types="react-scripts" />

declare module '*.csv' {
  const value: string;
  export default value;
}

PopOver

Default PopUp (just item title)

<ToolTip />

OR for custom PopUp

<ToolTip>
  <PopOver />
</ToolTip>

You can disable the PopUp by setting SetData prop disablePopup (optional, defaults to false ). Once disablePopup is true , the ToolTip will return null. See ToolTip implementation to figure it out.

Further implementations

For further ideas on how to use this library (it has a lot going on under the hood) please check ./example/ project.

How to run the Example

  1. yarn build on root folder
  2. cd example && yarn install & yarn start

To develop

Open two terminal windows.

  • In one do yarn start (this will watch and recompile the lib on change).
  • In the next one to cd example && yarn install & yarn start

How to publish to NPM

  1. Be sure you are part of the @undp_sdb_ai_lab organisation in npmjs.

  2. Run yarn build and be sure it is successful.

  3. Run yarn publish - differently from npm, yarn will ask for a new version and tag it. Remember to push your git state to remote after.

License

MIT © nmpribeiro