diff --git a/packages/vx-brush/Readme.md b/packages/vx-brush/Readme.md index 4cfbbee39..3d0247bc1 100644 --- a/packages/vx-brush/Readme.md +++ b/packages/vx-brush/Readme.md @@ -1,5 +1,13 @@ # @vx/brush + + + + +A brush allows you to select a sub-region of your chart or axis. + +## Installation + ``` npm install --save @vx/brush -``` \ No newline at end of file +``` diff --git a/packages/vx-curve/Readme.md b/packages/vx-curve/Readme.md index 497361c25..7b4a21a96 100644 --- a/packages/vx-curve/Readme.md +++ b/packages/vx-curve/Readme.md @@ -1,26 +1,25 @@ # @vx/curve + + + + +## Installation + ``` npm install --save @vx/curve ``` ## Overview -A curve is a function that can be passed into other vx objects, mainly a LinePath to change the way the line is structured. - -For example, checkout the difference between a `Curve.natural`: - -![natural curve](https://raw.githubusercontent.com/d3/d3-shape/master/img/natural.png) - -and a `Curve.step`: - -![step curve](https://raw.githubusercontent.com/d3/d3-shape/master/img/step.png) - -The `@vx/curve` package is a wrapper over [d3-shape](https://github.com/d3/d3-shape) curve functions. +The `@vx/curve` package is a wrapper of the [d3-shape](https://github.com/d3/d3-shape) curve +functions. A `curve` is a function that can be passed into other `vx` objects that draw lines or +paths, such as a `LinePath`, to change the way the line between points is drawn. Click on the +example below for an interactive way to explore curve aesthetics. -Any function with the prefix `curve` in d3 can be used through `vx` like so: +Any function with the prefix `curve` in `d3` can be used through `vx` like so: -``` javascript +```javascript import { curveCatmullRomOpen } from '@vx/curve'; let line = () @@ -31,7 +30,7 @@ let line = () ## Functions -| vx | d3 | +| vx | d3 | | --------------------- | ----------------------------------------------------------------------------- | | curveBasis | [curveBasis](https://github.com/d3/d3-shape#curveBasis) | | curveBasisClose | [curveBasisClosed](https://github.com/d3/d3-shape#curveBasisClosed) | diff --git a/packages/vx-demo/src/components/Gallery/index.tsx b/packages/vx-demo/src/components/Gallery/index.tsx index f3f6d16e1..f86d4c699 100644 --- a/packages/vx-demo/src/components/Gallery/index.tsx +++ b/packages/vx-demo/src/components/Gallery/index.tsx @@ -82,9 +82,6 @@ const tiles = [ ZoomITile, ]; const tiltOptions = { max: 8, scale: 1 }; -const columnCount = 3; -const emptyTileCount = - tiles.length % columnCount > 0 ? columnCount - (tiles.length % columnCount) : 0; export default function Gallery() { return ( @@ -95,16 +92,11 @@ export default function Gallery() { ))} - {[...new Array(emptyTileCount)].map((_, i) => ( - null} /> - ))}