Skip to content

Commit

Permalink
gh-pages <- 0.4.6 release (#70)
Browse files Browse the repository at this point in the history
* Histogram improvements + tests (#57)

* Add react-docgen to devDependencies

* Histogram improvements - calculate yDomain and based off given data. Include mouse interaction and styling props. Add tests.

* Test horizontal props for BarChart

* Histogram - move binning into render function to handle dynamic data, make value prop a function, improve docs, remove unused code

* rebuild docs

* Integrate prettier & eslint code styles + add linting as part of npm test (#58)

* Add prettier & eslint code style rules

* Include eslint process with npm test

* Clean up and refactor (#59)

* Add prettier & eslint code style rules

* Remove legacy code and evaluate any todos

* Only send valid XYPlot props to children. Resolves #22

* Check against master list of scaleTypes

* Implement invertX and invertY scale

* Alphabetically sort props displayed on docs

* Update documentation for x and y axis labels and titles

* Clean up code and todos

* includeXZero and includeYZero props + test

* feature(yaml): add ci/cd (#60)

* feature(version): version bump (#61)

* feature(version): version bump

* feature(lockfile): add a lockfile

* Clean up multiple warning logs and fix regression on children components not getting their defaultProps (#64)

* Include css in root and add less -> css to build process (#63)

* Include css in root and add to build process

* Update readme directions to run examples

* add AreaBarChart spec (#65)

* Namespace css classes + update class and style props where applicable (#66)

* AreaChartBar namespace

* AreaChart namespace

* AreaHeatMap namespace + accessor class and style funcs

* BarChart update documentation

* ColorHeatmap namespace and update documentation

* FunnelChart namespace and accessors

* Add lineStyle and lineClassName to KDE and remove unused prop in LineChart

* MarketLineChart namespace and class and style accessors

* RangeBarChart namespace

* ScatterPlot namespace

* PieChart documentation and updates

* XYPlot namespace and underlying components

* Add classes to linechart, remove unused styles

* Namespace SankeyDiagram and updates to PieChart

* Update tests

* Update docs

* Add backwards compatibility for markerLineClass

* Update docs

* Use className from props for RangeRect

* Add disableMouseWheelZoom prop to ZoomContainer  (#67)

* Add disable mousewheel prop to reactochart

* Update docs

* 0.4.6 release (#68)
  • Loading branch information
Kris Salvador authored May 21, 2018
1 parent 2885ee3 commit 063a0eb
Show file tree
Hide file tree
Showing 107 changed files with 42,451 additions and 24,597 deletions.
4 changes: 4 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"parser": "babel-eslint",
"extends": ["plugin:prettier/recommended"]
}
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
registry= https://registry.npmjs.org/
18 changes: 18 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
language: node_js
node_js:
- "6"
- "7"
- "8"
- "9"
env:
- CXX=g++-4.8
addons:
apt:
sources:
- ubuntu-toolchain-r-test
packages:
- g++-4.8
before_install:
- npm i -g npm@latest
install:
- npm ci
1 change: 1 addition & 0 deletions .yarnrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"https://registry.npmjs.org/" true
77 changes: 46 additions & 31 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,61 @@
## 0.4.6 (2018-05-21)

* [#63](https://github.com/spotify/reactochart/pull/63) Include css in root
* [#65](https://github.com/spotify/reactochart/pull/65) Test for AreaBarChart
* [#66](https://github.com/spotify/reactochart/pull/66) Namespace CSS
* [#67](https://github.com/spotify/reactochart/pull/67) Add disableMouseWheelZoom to ZoomContainer

## 0.4.5 (2018-04-18)
- [#56](https://github.com/spotify/reactochart/pull/56) Add `react-docgen` to devDependencies.

* [#56](https://github.com/spotify/reactochart/pull/56) Add `react-docgen` to devDependencies.

## 0.4.4 (2018-04-10)
- [#55](https://github.com/spotify/reactochart/pull/55) Add `controlled` prop to `ZoomContainer` so it can be controlled by props instead of internal state.

* [#55](https://github.com/spotify/reactochart/pull/55) Add `controlled` prop to `ZoomContainer` so it can be controlled by props instead of internal state.

## 0.4.3 (2018-03-12)
- [#54](https://github.com/spotify/reactochart/pull/54) Fix for non-string `SankeyDiagram` `nodeLabelText` prop (see 0.4.2 notes) - now rendered as SVG instead of HTML wrapped in `<foreignObject>`

* [#54](https://github.com/spotify/reactochart/pull/54) Fix for non-string `SankeyDiagram` `nodeLabelText` prop (see 0.4.2 notes) - now rendered as SVG instead of HTML wrapped in `<foreignObject>`

## 0.4.2 (2018-02-27)
- Added CHANGELOG file
- [#52](https://github.com/spotify/reactochart/pull/52) New `SankeyDiagram` features
- `marginTop`, `marginBottom`, marginLeft`, `marginRight` props for leaving internal empty space around the diagram
- `nodeLabelText` prop may now be a function which returns an arbitrary HTML component (instead of only a string)
- [#53](https://github.com/spotify/reactochart/pull/53) Documentation typo fixes

* Added CHANGELOG file
* [#52](https://github.com/spotify/reactochart/pull/52) New `SankeyDiagram` features
* `marginTop`, `marginBottom`, marginLeft`,`marginRight` props for leaving internal empty space around the diagram
* `nodeLabelText` prop may now be a function which returns an arbitrary HTML component (instead of only a string)
* [#53](https://github.com/spotify/reactochart/pull/53) Documentation typo fixes

## 0.4.1 (2018-01-26)
- [#49](https://github.com/spotify/reactochart/pull/49) New `SankeyDiagram` prop `shouldClone`, to control whether data should be cloned or mutated in place

* [#49](https://github.com/spotify/reactochart/pull/49) New `SankeyDiagram` prop `shouldClone`, to control whether data should be cloned or mutated in place

## 0.4.0 (2018-01-03)
- [#47](https://github.com/spotify/reactochart/issues/47) API Changes - see ticket for detailed discussion
- `getThing` getter props renamed to just `thing` - now accept either a constant value or accessor function (when possible)
- Deprecated string/number/null shorthand for getter props
- Deprecated combined `thing={{x:..., y:...}}` props in favor of separate `xThing` and `yThing` props
- Deprecated combined `thing={{top:..., bottom:..., left:..., right:...}}` props in favor of separate `thingTop`, `thingBottom`, `thingLeft`, `thingRight` props
- New chart component: `SankeyDiagram`
- Improved documentation and test coverage
- Added markdown support in docs (including for component prop docs)
- Removed compiled library files from repo - build library on `prepublish` instead

* [#47](https://github.com/spotify/reactochart/issues/47) API Changes - see ticket for detailed discussion
* `getThing` getter props renamed to just `thing` - now accept either a constant value or accessor function (when possible)
* Deprecated string/number/null shorthand for getter props
* Deprecated combined `thing={{x:..., y:...}}` props in favor of separate `xThing` and `yThing` props
* Deprecated combined `thing={{top:..., bottom:..., left:..., right:...}}` props in favor of separate `thingTop`, `thingBottom`, `thingLeft`, `thingRight` props
* New chart component: `SankeyDiagram`
* Improved documentation and test coverage
* Added markdown support in docs (including for component prop docs)
* Removed compiled library files from repo - build library on `prepublish` instead

## 0.3.1 (2017-11-15)
- Improved test coverage & docs for `Bar` and `BarChart` components
- Fixed incorrect `react` peerDependency version
- Added missing `sinon` devDependency
- Added `yarn` lock file

* Improved test coverage & docs for `Bar` and `BarChart` components
* Fixed incorrect `react` peerDependency version
* Added missing `sinon` devDependency
* Added `yarn` lock file

## 0.3.0 (2017-08-10)
- New documentation, including tutorials and interactive examples
- New chart components: `ColorHeatmap`, `FunnelChart`
- Unified branches from several contributors (see [#45](https://github.com/spotify/reactochart/pull/45) for details)
- Added `className` and `style` props to `AreaHeatmap`
- Added `style` prop to `LineChart`
- Added `pointStyle` prop to `ScatterPlot`
- Changed `MarkerLineChart` to use `horizontal` prop, rather than `orientation`, for consistency
- Fixed missing import in `Scale`
- Fixed incorrect propTypes in `ScatterPlot` and `YAxis`

* New documentation, including tutorials and interactive examples
* New chart components: `ColorHeatmap`, `FunnelChart`
* Unified branches from several contributors (see [#45](https://github.com/spotify/reactochart/pull/45) for details)
* Added `className` and `style` props to `AreaHeatmap`
* Added `style` prop to `LineChart`
* Added `pointStyle` prop to `ScatterPlot`
* Changed `MarkerLineChart` to use `horizontal` prop, rather than `orientation`, for consistency
* Fixed missing import in `Scale`
* Fixed incorrect propTypes in `ScatterPlot` and `YAxis`
43 changes: 26 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
## WARNING: THIS IS NOT YET PRODUCTION-QUALITY CODE. Docs and Tests are still being written. Use at your own risk. If your project requires composable React charts, we recommend using [Victory](https://github.com/FormidableLabs/victory).

# reactochart

Charting library for React

# API

[comment]: <> (TODO: Update readme to include directions on importing base styles)

### Non-XY charts

* PieChart
* TreeMap

### XYPlot & XY charts

* XYPlot
* BarChart
* RangeBarChart
Expand All @@ -19,40 +24,43 @@ Charting library for React
* AreaHeatmap
* Histogram
* KernelDensityEstimation
* *planned: AreaChart, StackedBarChart, GroupedBarChart*
* _planned: AreaChart, StackedBarChart, GroupedBarChart_

### XY Axis Components

* XAxis, YAxis
* XAxisTitle, YAxisTitle
* XAxisLabels, YAxisLabels
* XTicks, YTicks
* XGrid, YGrid

### XY datum components (used by charts/axes)
* Bar

* Bar
* RangeRect
* XLine, YLine
* *planned: AreaRect?, AreaCircle?*
* _planned: AreaRect?, AreaCircle?_

### Higher-order components

* resolveXYScales

### Utilities

* Data
* Scale
* Axis
* Label
* Margin
* depthEqual


# Examples

If you just want to run the examples locally:

1. Clone this repo and `cd` to the newly-created directory
2. Run `npm serve` in your terminal
3. Go to [http://localhost:8000](http://localhost:8000)
1. Clone this repo and `cd` to the newly-created directory
2. Run `npm run serve` in your terminal (note: if you're running Python in v3 or higher you'll need to run `python -m http.server`)
3. Go to [http://localhost:8000](http://localhost:8000)

# Development

Expand All @@ -61,34 +69,34 @@ If you'd like to contribute to the development this project, first fork & clone
### Global dependencies

* This project uses NPM to manage dependencies and run scripts. Run `npm -v` to check if you already have it installed.
If you don't have it, NPM is packaged with Node.js - download and run the
[install package located on nodejs.org](https://nodejs.org/) to install.
If you don't have it, NPM is packaged with Node.js - download and run the
[install package located on nodejs.org](https://nodejs.org/) to install.
* Babel is used to transpile ES6+ code to ES5 syntax. Install by running `npm install --global babel`
* Webpack is used to bundle the JS & styles for the examples. Install by running `npm install --global webpack`

### Project dependencies

* Run `npm install` in the project root directory. This will install all of the project dependencies into the
`node_modules` directory.
`node_modules` directory.

### Development process

* Run `npm run dev` to run the development server (webpack-dev-server), which will serve a live development version of
the examples at [localhost:9876](http://localhost:9876)
the examples at [localhost:9876](http://localhost:9876)
* Make changes to the library code in the `src` directory, and/or changes to the examples in the `examples/src`
directory.
directory.
* Once you are happy with your changes, run `npm run build` to generate a production build. (This transpiles the ES6
library code, and transpiles + bundles the examples).
library code, and transpiles + bundles the examples).
* `git commit` and `git push` your changes to your forked version of the repo.
* Open a Github pull request if you'd like to get your changes merged into the official repository.

### Notes

* **Do not make any changes in the `lib` or `examples/build` directories**, as these directories are destroyed and
regenerated on each build.
regenerated on each build.
* The development server uses [react-hot-loader](https://github.com/gaearon/react-hot-loader) to automatically
"hot reload" changes to React components, so refreshing your web browser is usually not necessary. However, some
changes will still require a refresh to propagate.
"hot reload" changes to React components, so refreshing your web browser is usually not necessary. However, some
changes will still require a refresh to propagate.

# TO DO:

Expand All @@ -97,8 +105,9 @@ changes will still require a refresh to propagate.
* documentation

## additional chart types

* Range-Value Bar Chart
* Value-Range Bar Chart
* Range-Range Bar Chart
* 2D Histogram (heatmap)
* 2D KDE?
* 2D KDE?
Loading

0 comments on commit 063a0eb

Please sign in to comment.