yellowtugboat / monte Goto Github PK

Create API documentation

There are a variety of TODOs in the codebase and they generally relate to enhancements and/or refactoring.

Add ARIA support to all charts and extensions.

Learn from existing charts such as AmCharts. Apply lessons from Ally.js, CSS Tricks, US Gov't 508 Compliance guidelines, WebAIM, and others.

Implement unit tests to cover basic chart construction and all support functions.

Blocks moving to a beta release.

Ensure Monte is served by jsdelivr (and evaluate others: cdnjs). Monte is already available through Unpkg, but providing some choice is generally a good idea.

Evaluate and migrate to a more permissive license MIT, Apache, or other.

Create gists of all demos on the main page from the gh-pages branch. Make the gists accessible through bl.ocks.org and another form (jsFiddle, plunkr, etc...)

Create a base theme that serves as a common base for other themes using SCSS.

The base should ensure:

• that items that should not have fills (i.e. .monte-ext-polar-grid-arc) are transparent;
• classes such as .no-domain and .no-ticks have transparent strokes;
• label placement classes have the correct text-anchor rules;
• pointer events are disabled for non directly interactive components (i.e. crosshairs, labels, etc...);
• and other similar needs.

A new Monte organization has been formed on GitHub and this repository should be migrated. For clarity of users this should be done as part of preparing a beta release.

The majority of input data is in the form of an array, but there are cases (such as Gauges) where the input is an object. Using objects has the advantage of allowing metadata and additional configuration information. This allows for greater flexibility in the future without having to rework the scheme.

In most charts most datums can contain a css field, but that isn't possible for the base data. Other information such as "label", "source", "collection date", etc... could also be useful in the data object.

The data object should be capable of being serialized as a JSON object to avoid having code perform transformations. The only required actions by a user should be using *Prop options to map the fields for chart consumption.

Tasks

• Update all charts to accept an object as the data. For data that is currently an array nest the current data under a consistent (and customizable via a *Prop option) field, for example "items". Note: "values" is the default prop in most cases for objects with nested items (line charts, grouped bar charts, ...) so use of valuesProp would create conflicts and should not be used.
• Add a data accessor to allow deep (i.e. use Lodash's get() like option() uses) so that users can access their own data elements for easy use in lifecycle event callbacks.