[x] all the components stories are reviewed and components props are documented clearly
[x] hide BucketViewer for now as not really usable
[x] hide OpenLayers one as we're using a new Map component
[ ] unify components data-passing API to allow for passing only data prop (no csv, url, or rawCsv), which would have the following interface (or similar)
[ ] 🚧 go through all the components' stories and add missing field descriptions and enhance existing ones, making it super-clear on how to use them
[ ] (maybe) deprecate the Table component as I've heard
data argument: Multiple names - Situation + Problem + Solution
(maybe) tidy up the API just a bit: e.g. some components allow for passing either csv OR data OR url props, some allow for passing data that can be either of those three things, some allow for passing rawCsv (instead of csv)
[ ] Solution A: use only one data prop in all those components that can take in either csv string or url or data array
[ ] Solution B: use csv, url, data props in all those components
NB: mostly what we are doing is just wrapping an existing library so that it can be used in DataHub ...
e.g. already have ReactVega but we modify it a litle ...
What do we modify it ...
In terms of design:
If i were building a component
// data is preparsed in a nice form ...
Table(data=...)
Chart(data=...)
Acceptance
BucketViewer
for now as not really usableOpenLayers
one as we're using a newMap
componentdata
prop (nocsv
,url
, orrawCsv
), which would have the following interface (or similar)Notes / Shaping
Tasks:
Table
component as I've hearddata
argument: Multiple names - Situation + Problem + Solutioncsv
ORdata
ORurl
props, some allow for passingdata
that can be either of those three things, some allow for passingrawCsv
(instead ofcsv
)data
prop in all those components that can take in either csv string or url or data arraycsv
,url
,data
props in all those componentsNB: mostly what we are doing is just wrapping an existing library so that it can be used in DataHub ...
e.g. already have ReactVega but we modify it a litle ...
In terms of design:
// data is preparsed in a nice form ... Table(data=...) Chart(data=...)
Usage
But for markdown we don't have this option ... and we need to wrap ...