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

material-table-builder

v1.0.5

Published

A simple utitlity to collect data for tables and bar charts. This tool was developed specifically for KLL's OLGDS project, where municipality officers wanted a way to simply input data for tables and/or graphs to be displayed on their website.

Downloads

8

Readme

material-table-builder

A simple wizard that allows users to build tables/graphs for use else-where in a material based react project.

Background

The need for a charting component originated when we were working for the Open Local Governance Digital System here at KLL. Users from different municipalities wanted the functionality to input their own data for the profile section of the website.

To learn more about OLGDS you can visit this link.

Demo

A working demo of the module, along with the code can be found in this link.

Usage

The Wizard component is the default export of this module, and will take the following two props:

  • A config object, through which we can pass configurations parameters for the wizard such as dummy data, a title, and a footnotes. The wizard will then look into the data object to create a dummy table which can then be modified.
  • onSubmit() handler can be used to access the final data after submission through the chart builder.
import React, {Component} from 'react';
import Wizard from 'material-table-builder';

const config = {
  title: 'Dummy Title',
  data: [
    {
      sn: '1',
      name: 'John Doe',
      numberOfSocks: 46,
    },
    {
      sn: '2',
      name: 'Jane Doe',
      numberOfSocks: 67,
    },
  ],
  footnote: 'Data collected during the annual John & Jane Sock Fair, 2015.',
};

class App extends Component {
  constructor(props) {
    super(props);
    this.state = {};
  }

  onSubmit(data) {
    console.log(JSON.stringify(data));
  }

  render() {
    return (
      <Wizard config={config} onSubmit={this.onSubmit} />
    );
  }
}

export default App;

Additional helper components

The package also comes with two additional helper components, viz. Chart and Table to render charts and/or tables elsewhere in the site using the configuration object provided by the Wizard component. Shown below are two examples of the same. Please note that since this code example is illustrative purposes I haven't used the chartType prop. To keep things more convenient, you could easily create a higher level component that renders a chart or a table based on the value of this prop.

Chart


	import React, {Component} from 'react';
	import { Chart } from 'material-table-builder';

	const dummyData = {
		chartType: 'chart',
	  title: 'Dummy Title',
	  data: [{
	    sn: '1',
	    name: 'John Doe',
	    numberOfSocks: 46,
	  },
	  {
	    sn: '2',
	    name: 'Jane Doe',
	    numberOfSocks: 67,
	  },
	  ],
	  footnote: 'Data collected during the annual John & Jane Sock Fair, 2015.',
	  params: {
	    categorical: 'name',
	    numeric: 'sn',
	  },
	};

	class App extends Component {
		constructor(props) {
			super(props);
			this.state = {};
		}

		render() {
			return (
				<Chart
					data={dummyData.data}
					title={dummyData.title}
					params={dummyData.params}
					footnote={dummyData.footnote}
				/>
			);
		}
	}

	export default App;

Table

import React, {Component} from 'react';
	import { Table } from 'material-table-builder';

	const dummyData = {
		chartType: 'table',
		title: 'Dummy Title',
		data: [{
			sn: '1',
			name: 'John Doe',
			numberOfSocks: 46,
		},
		{
			sn: '2',
			name: 'Jane Doe',
			numberOfSocks: 67,
		},
		],
		footnote: 'Data collected during the annual John & Jane Sock Fair, 2015.',
		params: {
			categorical: 'name',
			numeric: 'sn',
		},
	};

	class App extends Component {
		constructor(props) {
			super(props);
			this.state = {};
		}

		render() {
			return (
				<Table
					data={dummyData.data}
					title={dummyData.title}
					params={dummyData.params}
					footnote={dummyData.footnote}
				/>
			);
		}
	}

	export default App;