Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs and showcase links with the new packages structure #1341

Merged
merged 1 commit into from
May 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/examples/building-things-other-than-charts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!-- INJECT:"ForceDirectedGraph" -->

[Source code](https://github.com/uber/react-vis/blob/master/showcase/examples/force-directed-graph/force-directed-graph.js)
[Source code](https://github.com/uber/react-vis/blob/master/packages/showcase/examples/force-directed-graph/force-directed-graph.js)
2 changes: 1 addition & 1 deletion docs/examples/extensibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
react-vis is easily extensible! If we don't have what you want it's easy to make! For instance, the above chart
was made by simply extending abstract series and adding a little sugar.

[Source code](https://github.com/uber/react-vis/blob/master/showcase/examples/candlestick/candlestick.js)
[Source code](https://github.com/uber/react-vis/blob/master/packages/showcase/examples/candlestick/candlestick.js)
2 changes: 1 addition & 1 deletion docs/examples/iris-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ The iris data set is a well beloved data set for getting to know various technic
Here we use it to show how to make a small multiples dashboard with react vis.
You can find out more about it at it's [wikipedia page](https://en.wikipedia.org/wiki/Iris_flower_data_set)

[Source code](https://github.com/uber/react-vis/blob/master/showcase/examples/iris-dashboard/iris-dashboard.js)
[Source code](https://github.com/uber/react-vis/blob/master/packages/showcase/examples/iris-dashboard/iris-dashboard.js)
4 changes: 2 additions & 2 deletions docs/examples/responsive-vis.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ This demo explores the concept of "Responsive Data Visualization" (As coined by

In data visualization, we often need to create applications that work with enormous ranges of sizes of data. Sometimes the data might be small (10 - 100 rows), or it might be gigantic (100k-1M+ row): throughout the entire range it just needs to work. Again, following our cues from responsive design, we note that maybe labels on scatterplots look great when you have under 50 data points, but bad when you have 2000. Checkout Nicks [original demo](http://nrabinowitz.github.io/rdv/) for more details on the theory, as well to see his rad implementation in raw d3.

[Scatterplot source code](https://github.com/uber/react-vis/blob/master/showcase/examples/responsive-vis/responsive-scatterplot.js)
[Scatterplot source code](https://github.com/uber/react-vis/blob/master/packages/showcase/examples/responsive-vis/responsive-scatterplot.js)

[Barchart source code](https://github.com/uber/react-vis/blob/master/showcase/examples/responsive-vis/responsive-bar-chart.js)
[Barchart source code](https://github.com/uber/react-vis/blob/master/packages/showcase/examples/responsive-vis/responsive-bar-chart.js)
2 changes: 1 addition & 1 deletion docs/examples/stream-graph.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- STYLETYPE:"example-page" -->
<!-- INJECT:"StreamgraphExample" -->

[Source code](https://github.com/uber/react-vis/blob/master/showcase/examples/streamgraph/streamgraph-example.js)
[Source code](https://github.com/uber/react-vis/blob/master/packages/showcase/examples/streamgraph/streamgraph-example.js)
4 changes: 2 additions & 2 deletions docs/sunburst.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,13 @@ Tooltips and other helpful annotations can be added to the sunburst diagram by p
hideRootNode
colorType="literal"
data={data}
height={300}
height={300}
width={350}>
<Hint value={hoveredValue} />
</Sunburst>
```

Where `hoveredValue` is an appropriately curated coordinate value. See the [sunburst-with-tooltips](https://github.com/uber/react-vis/blob/master/showcase/sunbursts/sunburst-with-tooltips.js) code for more details.
Where `hoveredValue` is an appropriately curated coordinate value. See the [sunburst-with-tooltips](https://github.com/uber/react-vis/blob/master/packages/showcase/sunbursts/sunburst-with-tooltips.js) code for more details.

## API Reference

Expand Down
275 changes: 95 additions & 180 deletions packages/showcase/showcase-links.js

Large diffs are not rendered by default.

12 changes: 5 additions & 7 deletions packages/showcase/showcase-sections/misc-showcase.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from 'react';
import {mapSection} from '../showcase-components/showcase-utils';
import {showCase} from '../index';
import {SHOWCASE_BASE_URL, REACTVIS_BASE_URL} from '../showcase-links';
const {
AnimationExample,
LabelSeriesExample,
Expand Down Expand Up @@ -31,8 +32,7 @@ const MISC = [
name: 'Polygon Example',
component: TriangleExample,
componentName: 'TriangleExample',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/polygon-series.js',
sourceLink: `${REACTVIS_BASE_URL}/src/plot/series/polygon-series.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/polygon-series'
},
Expand All @@ -45,8 +45,7 @@ const MISC = [
name: 'Gradient & Custom Border Example',
component: GradientExample,
componentName: 'GradientExample',
sourceLink:
'https://github.com/uber/react-vis/blob/master/showcase/misc/gradient-example.js',
sourceLink: `${SHOWCASE_BASE_URL}/misc/gradient-example.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/api-reference/gradients'
},
Expand All @@ -55,14 +54,13 @@ const MISC = [
component: AnimationExample,
componentName: 'AnimationExample',
docsLink:
'http://uber.github.io/react-vis/documentation/general-principles/animation'
'http://uber.github.io/react-vis/documentation/series-reference/label-series'
},
{
name: 'Label Series Example',
component: LabelSeriesExample,
componentName: 'LabelSeriesExample',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/label-series.js',
sourceLink: `${SHOWCASE_BASE_URL}/src/plot/series/label-series.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/label-series'
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import React from 'react';

import {mapSection} from '../showcase-components/showcase-utils';
import {showCase} from '../index';
import {REACTVIS_BASE_URL} from '../index';
const {
AnimatedParallelCoordinates,
BasicParallelCoordinates,
Expand All @@ -14,8 +15,7 @@ const PARALLEL_COORDINATES = [
name: 'Basic Parallel Coordinates',
component: BasicParallelCoordinates,
componentName: 'BasicParallelCoordinates',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/radar-chart/index.js',
sourceLink: `${REACTVIS_BASE_URL}/radar-chart/index.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/other-charts/radar-chart'
},
Expand Down
35 changes: 13 additions & 22 deletions packages/showcase/showcase-sections/plots-showcase.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from 'react';
import PropTypes from 'prop-types';
import {showCase} from '../index';
import {REACTVIS_BASE_URL} from '../showcase-links';
import {mapSection} from '../showcase-components/showcase-utils';
const {
AreaChart,
Expand Down Expand Up @@ -45,26 +46,23 @@ const PLOTS = [
component: LineChart,
componentName: 'LineChart',
name: 'Line Series',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/line-series.js',
sourceLink: `${REACTVIS_BASE_URL}/plot/series/line-series.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/line-series'
},
{
component: LineChartWithStyle,
componentName: 'LineChartWithStyle',
name: 'Line Series with style',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/line-series.js',
sourceLink: `${REACTVIS_BASE_URL}/plot/series/line-series.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/line-series'
},
{
component: LineMarkChart,
componentName: 'LineMarkChart',
name: 'LineMark Series',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/line-mark-series.js',
sourceLink: `${REACTVIS_BASE_URL}/plot/series/line-mark-series.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/line-mark-series'
},
Expand All @@ -87,8 +85,7 @@ const PLOTS = [
component: ScatterplotChart,
componentName: 'ScatterplotChart',
name: 'Mark Series',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/mark-series.js',
sourceLink: `${REACTVIS_BASE_URL}/plot/series/mark-series.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/mark-series'
},
Expand All @@ -101,17 +98,15 @@ const PLOTS = [
component: WhiskerChart,
componentName: 'WhiskerChart',
name: 'Whisker Series',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/whisker-series.js',
sourceLink: `${REACTVIS_BASE_URL}/plot/series/whisker-series.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/whisker-series'
},
{
component: AreaChart,
componentName: 'AreaChart',
name: 'Area Series',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/area-series.js'
sourceLink: `${REACTVIS_BASE_URL}/plot/series/area-serie.js`
},
{
component: AreaChartElevated,
Expand All @@ -124,8 +119,7 @@ const PLOTS = [
component: BarChart,
componentName: 'BarChart',
name: 'Bar Series',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/bar-series.js',
sourceLink: `${REACTVIS_BASE_URL}/plot/series/bar-series.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/bar-series'
},
Expand Down Expand Up @@ -177,17 +171,15 @@ const PLOTS = [
name: 'Heatmap Series',
component: HeatmapChart,
componentName: 'HeatmapChart',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/heatmap-series.js',
sourceLink: `${REACTVIS_BASE_URL}/plot/series/heatmap-series.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/heatmap-series'
},
{
name: 'Hexbin Series',
component: HexHeatmap,
componentName: 'HexHeatmap',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/hexbin-series.js',
sourceLink: `${REACTVIS_BASE_URL}/plot/series/hexbin-series.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/hexbin-series'
},
Expand All @@ -200,8 +192,7 @@ const PLOTS = [
name: 'Labeled Heatmap',
component: LabeledHeatmap,
componentName: 'LabeledHeatmap',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/heatmap-series.js'
sourceLink: `${REACTVIS_BASE_URL}/plot/series/heatmap-serie.js`
},
{
name: 'Contour Series',
Expand Down Expand Up @@ -250,8 +241,7 @@ const BASIC_COMPONENTS = [
name: 'Circular Gridlines',
component: FauxScatterplotChart,
componentName: 'FauxScatterplotChart',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/circular-grid-lines.js',
sourceLink: `${REACTVIS_BASE_URL}/plot/circular-grid-lines.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/api-reference/grids'
}
Expand All @@ -268,6 +258,7 @@ function PlotsShowcase(props) {
</section>
)}
<h2>Series Types</h2>

{PLOTS.map(mapSection)}
<h2>Basic Components</h2>
{BASIC_COMPONENTS.map(mapSection)}
Expand Down
4 changes: 2 additions & 2 deletions packages/showcase/showcase-sections/radar-showcase.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from 'react';

import {mapSection} from '../showcase-components/showcase-utils';
import {REACTVIS_BASE_URL} from '../showcase-links';
import {showCase} from '../index';
const {
AnimatedRadarChart,
Expand All @@ -15,8 +16,7 @@ const RADAR = [
name: 'Basic Radar Chart',
component: BasicRadarChart,
componentName: 'BasicRadarChart',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/radar-chart/index.js',
sourceLink: `${REACTVIS_BASE_URL}/radar-chart/index.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/other-charts/radar-chart'
},
Expand Down
4 changes: 2 additions & 2 deletions packages/showcase/showcase-sections/radial-showcase.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from 'react';

import {mapSection} from '../showcase-components/showcase-utils';
import {REACTVIS_BASE_URL} from '../showcase-links';
import {showCase} from '../index';
const {
CustomRadiusRadialChart,
Expand All @@ -14,8 +15,7 @@ const RADIAL = [
name: 'Simple Radial Chart',
component: SimpleRadialChart,
componentName: SimpleRadialChart,
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/radial-chart/index.js',
sourceLink: `${REACTVIS_BASE_URL}/radial-chart/index.js`,
docsLink:
'http://uber.github.io/react-vis/documentation/other-charts/radial-chart'
},
Expand Down
4 changes: 2 additions & 2 deletions packages/showcase/showcase-sections/sankeys-showcase.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from 'react';

import {mapSection} from '../showcase-components/showcase-utils';
import {REACTVIS_BASE_URL} from '../showcase-links';
import {showCase} from '../index';
const {
BasicSankeyExample,
Expand All @@ -17,8 +18,7 @@ const SANKEYS = [
componentName: 'BasicSankeyExample',
docsLink:
'http://uber.github.io/react-vis/documentation/other-charts/sankey-diagram',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/sankey/index.js'
sourceLink: `${REACTVIS_BASE_URL}/sankey/index.js`
},
{
name: 'With Voronoi Selection',
Expand Down
7 changes: 3 additions & 4 deletions packages/showcase/showcase-sections/sunburst-showcase.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from 'react';

import {showCase} from '../index';
import {REACTVIS_BASE_URL} from '../showcase-links';
import {mapSection} from '../showcase-components/showcase-utils';
const {
AnimatedSunburst,
Expand All @@ -17,17 +18,15 @@ const SUNBURSTS = [
componentName: 'ArcSeriesExample',
docsLink:
'http://uber.github.io/react-vis/documentation/series-reference/arc-series',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/plot/series/arc-series.js'
sourceLink: `${REACTVIS_BASE_URL}/plot/series/arc-series.js`
},
{
name: 'Basic Sunburst',
component: BasicSunburst,
componentName: 'BasicSunburst',
docsLink:
'http://uber.github.io/react-vis/documentation/other-charts/sunburst-diagram',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/sunburst/index.js'
sourceLink: `${REACTVIS_BASE_URL}/sunburst/index.js`
},
{
name: 'Clock',
Expand Down
5 changes: 3 additions & 2 deletions packages/showcase/showcase-sections/treemap-showcase.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import React from 'react';

import {showCase} from '../index';
import {REACTVIS_BASE_URL} from '../showcase-links';
import {mapSection} from '../showcase-components/showcase-utils';

const {SimpleTreemap, TreemapExample} = showCase;

const TREEMAPS = [
Expand All @@ -11,8 +13,7 @@ const TREEMAPS = [
componentName: 'SimpleTreemap',
docsLink:
'http://uber.github.io/react-vis/documentation/other-charts/treemap',
sourceLink:
'https://github.com/uber/react-vis/blob/master/src/treemap/index.js'
sourceLink: `${REACTVIS_BASE_URL}/treemap/index.js`
},
{
name: 'Animated Treemap',
Expand Down