Merge pull request #852 from datopian/components-tutorial

[docs][m] - components api section
This commit is contained in:
Anuar Ustayev (aka Anu) 2023-05-07 11:45:56 +06:00 committed by GitHub
commit e5c89308d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 1 deletions

View File

@ -0,0 +1,9 @@
# Components
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.

View File

@ -53,4 +53,3 @@ https://developers.cloudflare.com/pages/framework-guides/deploy-a-nextjs-site/#d
Note that you don't have to change anything - just follow the steps, choosing the repository you created.
<DocsPagination prev="/docs/showing-metadata" />

View File

@ -24,6 +24,10 @@
}
]
},
{
"name": "Components",
"href": "/docs/components"
},
{
"name": "Examples",
"children": [