knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs][s]: update and rename components-api.md to components.md

Browse Source
This commit is contained in:
Anuar Ustayev (aka Anu) 2023-05-07 11:10:26 +06:00 committed by GitHub
parent 53b64b81c9
commit 8b51123290
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
site/content/docs/components-api.md → site/content/docs/components.md
View File

@ -1,13 +1,9 @@
# Components API
# Components
You now have a basic data catalog running, the next step would be to dig into the components library. PortalJS supports the following components by default:
PortalJS comes with a library of components that provides essential pieces for your data portal. The best way to explore the components is to look at our [Storybook](https://storybook.portaljs.org/) that contains all the details on how to use them. Below is a quick summary of existing components today:
- `<Catalog />` A searchable catalog that will index a list of datasets and allow for contextual searching + filters.
- `<LineChart />` A simple component that allows the creation of an opinionated line chart without the need to go deep into charting standards
- `<Vega />` A wrapper around the [Vega specification](https://vega.github.io/vega/) that allows you to build pretty much any kind of chart imaginable
- `<VegaLite />` A wrapper around the [Vega Lite specification](https://vega.github.io/vega-lite/) which allows for a more concise grammar than Vega around the building of charts.
- `<Table />` is an easy-to-use table component with built-in pagination, search, and sorting.
For more details on those please refer to our [Storybook Documentation](https://storybook.portaljs.org/), which contains all the details on how to use them.
<DocsPagination prev="/docs/deploying-your-portaljs-app" />