You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

80 lines
4.3 KiB

1 year ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
  1. # Big welcome by the Chartist Guy
  2. [![Join the chat at https://gitter.im/gionkunz/chartist-js](https://badges.gitter.im/gionkunz/chartist-js.svg)](https://gitter.im/gionkunz/chartist-js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
  3. [![npm version](http://img.shields.io/npm/v/chartist.svg)](https://npmjs.org/package/chartist) [![build status](http://img.shields.io/travis/gionkunz/chartist-js.svg)](https://travis-ci.org/gionkunz/chartist-js) [![Inline docs](http://inch-ci.org/github/gionkunz/chartist-js.svg?branch=develop)](http://inch-ci.org/github/gionkunz/chartist-js)
  4. ![The Chartist Guy](https://raw.github.com/gionkunz/chartist-js/develop/site/images/chartist-guy.gif "The Chartist Guy")
  5. *Checkout the documentation site at http://gionkunz.github.io/chartist-js/*
  6. *Checkout this lightning talk that gives you an overview of Chartist in 5 minutes https://www.youtube.com/watch?v=WdYzPhOB_c8*
  7. *Guest talk of the Chartist.js Guy at the Treehouse Show https://www.youtube.com/watch?v=h9oH0iDaZDQ&t=2m40s*
  8. Chartist.js is a simple responsive charting library built with SVG. There are hundreds of nice charting libraries already
  9. out there, but they are either:
  10. * not responsive
  11. * use the wrong technologies for illustration (canvas)
  12. * are not flexible enough while keeping the configuration simple
  13. * are not friendly to your own code
  14. * are not friendly to designers
  15. * have unnecessary dependencies to monolithic libraries
  16. * more annoying things
  17. That's why we started Chartist.js and our goal is to solve all of the above issues.
  18. ## What is it made for?
  19. Chartist's goal is to provide a simple, lightweight and unintrusive library to responsively craft charts on your website.
  20. It's important to understand that one of the main intentions of Chartist.js is to rely on standards rather than providing
  21. it's own solution to a problem which is already solved by those standards. We need to leverage the power of browsers
  22. today and say good bye to the idea of solving all problems ourselves.
  23. Chartist works with inline-SVG and therefore leverages the power of the DOM to provide parts of its functionality. This
  24. also means that Chartist does not provide it's own event handling, labels, behaviors or anything else that can just be
  25. done with plain HTML, JavaScript and CSS. The single and only responsibility of Chartist is to help you drawing "Simple
  26. responsive Charts" using inline-SVG in the DOM, CSS to style and JavaScript to provide an API for configuring your charts.
  27. ## Example site
  28. You can visit this Site http://gionkunz.github.io/chartist-js/ which is in fact a build of the current project.
  29. We are still developing and constantly add features but you can already use Chartist.js in your projects as we have
  30. reached a stable and reliable state already.
  31. ## Version notes
  32. We are currently still heavily developing in order to make Chartist.js better. Your help is needed! Please contribute
  33. to the project if you like the idea and the concept and help us to bring nice looking responsive open-source charts
  34. to the masses.
  35. ### Important missing stuff
  36. 1. Jasmine Tests!
  37. 2. Documentation: JSDoc, Getting started documentation and landing page
  38. 3. Better accessibility using ARIA and other optimizations
  39. 4. Better interfaces to the library (i.e. jQuery with data-* attributes for configuration), Angular.js directive etc.
  40. 5. Richer Sass / CSS framework
  41. 6. Other charts types (spider etc.)
  42. ## Plugins
  43. Some features aren't right for the core product
  44. but there is a great set of plugins available
  45. which add features like:
  46. * [Axis labels](http://gionkunz.github.io/chartist-js/plugins.html#axis-title-plugin)
  47. * [Tooltips at data points](https://gionkunz.github.io/chartist-js/plugins.html#tooltip-plugin)
  48. * [Coloring above/below a threshold](https://gionkunz.github.io/chartist-js/plugins.html#threshold-plugin)
  49. and more.
  50. See all the plugins [here](https://gionkunz.github.io/chartist-js/plugins.html).
  51. ## Contribution
  52. We are looking for people who share the idea of having a simple, flexible charting library that is responsive and uses
  53. modern and future-proof technologies. The goal of this project is to create a responsive charting library where developers
  54. have their joy in using it and designers love it because of the designing flexibility they have.
  55. Contribute if you like the Chartist Guy!