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

@concord-consortium/codap-plugin-api

v0.1.8

Published

An API to ease the development of CODAP plugins

Downloads

186

Readme

CODAP Plugin API

Using as a library

This npm library provides two main files that will aid in interfacing with the CODAP Data Interactives API. codapInterface.ts sets up some basic functions for interfacing with CODAP, while codap-helper.ts contains more specialized functions utilizing the CODAP Data Interactive API for a variety of different purposes. Find the full documentation of the CODAP Data Interactive API here.

Installing and usage

In the directory of your plugin project, run npm install codap-plugin-api.

In myComponent.js:

import codapInterface from "codap-plugin-api";
import codapHelpers from "codap-plugin-api";

const myComponent = () => {
  useEffect(() => {
    const myOptions = {
      pluginName: myPlugin;
      version: 1.0.0;
      dimensions: {
        width: 300,
        height: 400
      };
    codapHelpers.initializePlugin(myOptions);
  }, []);
}

For more examples of how to use the npm package, see the CODAP Plugin Starter Project.

Development

Building

If you want to build a local version run npm build, it will create the files in the dist folder.

Notes

  1. Make sure if you are using Visual Studio Code that you use the workspace version of TypeScript. To ensure that you are open a TypeScript file in VSC and then click on the version number next to TypeScript React in the status bar and select 'Use Workspace Version' in the popup menu.

License

CODAP Plugin API are Copyright 2018 (c) by the Concord Consortium and is distributed under the MIT license.

See license.md for the complete license text.