Client-side reusable Charting Library based on D3.js v4 that allows easy and intuitive use of charts and components that can be composed together creating amazing visualizations.
JavaScript CSS HTML Shell
Switch branches/tags
Latest commit 6ea0a80 May 26, 2017 @jenjwong jenjwong committed with Golodhros Calculates percentages in donut-chart (#267)
Thanks a lot!
Permalink
Failed to load latest commit information.
.github Renaming contributing file and adding issues and pr templates Feb 25, 2017
demos Bung87 docs header (#273) May 26, 2017
dist Remove Underscore dependency (#254) May 21, 2017
docs Calculates percentages in donut-chart (#267) May 26, 2017
src Calculates percentages in donut-chart (#267) May 26, 2017
test Calculates percentages in donut-chart (#267) May 26, 2017
.codeclimate.yml Adding Codeclimate configuration May 11, 2017
.editorconfig Using generator info to setup repo. Added dependencies and wired jasm… May 25, 2015
.eslintrc-babel.json Updating linting files Apr 7, 2017
.eslintrc.json Fixing eslint error (#203) May 5, 2017
.gitignore Updating Changelog doc Apr 6, 2017
.nojekyll Testing github pages conf Jan 31, 2017
.npmignore Updating package, npmignore, readme and cleaning old index.html file Feb 10, 2017
.sass-lint.yml Using node based SASS to avoid ruby dependency Sep 15, 2016
.travis.yml configure npm deploys May 3, 2017
CHANGELOG.md Documentation updates (#232) May 16, 2017
CONTRIBUTING.md Renaming contributing file and adding issues and pr templates Feb 25, 2017
GETTINGSTARTED.md Bung87 docs header (#273) May 26, 2017
Gruntfile.js Updating package, npmignore, readme and cleaning old index.html file Feb 10, 2017
LICENSE.md Adding Apache License May 13, 2016
README.md Bung87 docs header (#273) May 26, 2017
bower.json Bumped Project to 1.5.3 May 16, 2017
karma.conf.js Adding travis conf file Mar 18, 2017
package.json Fix docs merged (#253) May 22, 2017
tests_index.js Adding webpack as module bundle/manager for Karma tests Feb 22, 2016
webpack.config.js Bung87 docs header (#273) May 26, 2017

README.md

Britecharts

Britecharts Logo

Britecharts is a client-side reusable Charting Library based on D3.js v4 that allows easy and intuitive use of charts and components that can be composed together creating amazing visualizations.

Build Status npm version Bower version

Britecharts components have been written in ES2015 with a Test Driven methodology so they are fully tested, and we are commited to keeping them that way.

Key Features

The main characteristics of this library are:

  • Reusability
  • Composability
  • Fully tested
  • ES2015 source code (transpiled with Babel)

Usage

The typical use of Britecharts involves creating a chart using its simple API, then rendering it on a container which has previously had data applied to it. The code will look like this:

barChart
    .width(500)
    .height(300);

barContainer.datum(dataset).call(barChart);

API

All the components expose some basic API methods like width, height and margin. Additionally, each chart or component can expose more methods. Those can be found in the documentation of the modules:

Installation

Britecharts components are distributed in UMD modules, each one exposing a D3.js component written with the Reusable API pattern. In order to use any of the Britecharts modules, you will need to require the chart in your JS file using AMD/CommonJS modules or adding a script tag with the src pointing to the file. You would also need to load the D3.js selection library in order to select the chart container.

   npm install britecharts d3-selection

They also provide some minimal CSS styling, that can be loaded independently or as a bundle. Check out our CDN demo page.

Roadmap

This project is in active development, if you are interested on helping you can check the contributing document. Review the issues page for more info on what's coming, to give your feedback, and to vote for your favorite proposals.

See Also

Acknowledgments

Britecharts was inspired by two books, Developing a D3.js Edge and Mastering D3.js. It also leveraged a great number of examples and articles from the D3.js community overall.

License

Copyright 2017 Eventbrite

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Read more in the license document