goodtables-ui

UI for goodtables as an framework-agnostic browser components (DEMO).

Features

• render - framework-agnostic component render
• Report - goodtables report component
• Form - goodtables validation form component

Getting Started

You could use this components in plain JavaScript code or mixing with any modern framework (with native support for React). To render report you have use goodtablesUI.render(goodtablesUI.Report, props, element) function.

First add bootstrap and component styles:

  <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
  <link rel="stylesheet" href="//unpkg.com/goodtables-ui/dist/goodtables-ui.min.css">

Installation

NPM

Install the package in your terminal $ npm install --save goodtables-ui

The package could be used as goodtables-ui package from NPM:

import goodtablesUI from 'goodtables-ui'

const report = '<YOUR-REPORT>'
const element = document.getElementById('report')
goodtablesUI.render(goodtablesUI.Report, {report}, element)

CDN

The distribution is 60kb minified (20kb gzipped) with no dependencies.

The package could be used as pluggable script from CDN:

<div id="report"></div>
<script src="//unpkg.com/goodtables-ui/dist/goodtables-ui.min.js"></script>
<script>
  var report = '<YOUR-REPORT>'
  var element = document.getElementById('report')
  goodtablesUI.render(goodtablesUI.Report, {report}, element)
</script>

Examples

React

In this case your application should provide react and react-dom.

You could use presented components as native React component (import from goodtables-ui/lib to get native React support):

import React from 'react'
import ReactDOM from 'react-dom'
import goodtablesUI from 'goodtables-ui/lib'

const report = '<YOUR-REPORT>'
const element = document.getElementById('report')
ReactDOM.render(<goodtablesUI.Report report={report} />, element)

Angular

This example is for Angular2+. Use similliar approach for Angular1.

The package's components could be used as angular component:

import {Component, Input} from '@angular/core';
import goodtablesUI from 'goodtablesUI'

@Component({
  selector: 'report',
  template: '<div id="report"></div>'
})
class Report {
  @Input() report: any;
  ngAfterViewInit() {
    const element = document.getElementById('report')
    goodtablesUI.render(goodtablesUI.Report, {report: this.report}, element)
  }
}

Vue

This example is for Vue2+. Use similar approach for Vue1.

The package's components could be used as vue component:

import goodtablesUI from 'goodtablesUI'

const Report = {
  props: ['report'],
  template: '<div id="report"></div>',
  mounted() {
    const element = document.getElementById('report')
    goodtablesUI.render(goodtablesUI.Report, {report: this.report}, element)
  },
}

Documentation

The whole public API of this package is described here and follows semantic versioning rules. Everything outside of this readme are private API and could be changed without any notification on any new version.

Render

To render one of the provided component render function should be used.

render(component, props, element)

• component (Component) - it could be one of provided by the library component e.g. Report
• props (Object) - object containing props
• element (Element) - DOM element to render into

Report

This component represents a goodtables report object.

<Report report/>

• report (Object) - goodtables report

Form

This component represents a validation form.

<Form source options validate reportPromise/>

• source (String) - see goodtables-js documentation
• options (Object) - see goodtables-js documentation
• validate (async func) - an async function which gets source and options and resolves to goodtables report
• reportPromise (Promise) - a promise to be resolved as a goodtables report

Contributing

The project follows the Open Knowledge International coding standards. There are common commands to work with the project:

$ npm run dev
$ npm run build
$ npm run test

Changelog

Here described only breaking and the most important changes. The full changelog and documentation for all released versions could be found in nicely formatted commit history.

v1.1

Improved behaviour:

• updated to Data Quality Spec v1
• added support for custom checks

v1.0

First stable realese.

v0.3

New functionality added:

• Form component now supports source/schema uploading

v0.2

New API added:

• published Form component

v0.1

New API added:

• published Report component
• published render function