[docs][m] - components api section
This commit is contained in:
13
site/content/docs/components-api.md
Normal file
13
site/content/docs/components-api.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# Components API
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
- `<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" />
|
||||||
@@ -52,5 +52,5 @@ 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.
|
Note that you don't have to change anything - just follow the steps, choosing the repository you created.
|
||||||
|
|
||||||
<DocsPagination prev="/docs/showing-metadata" />
|
<DocsPagination prev="/docs/showing-metadata" next="/docs/components-api" />
|
||||||
|
|
||||||
|
|||||||
@@ -21,6 +21,10 @@
|
|||||||
{
|
{
|
||||||
"name": "Deploying your PortalJS app",
|
"name": "Deploying your PortalJS app",
|
||||||
"href": "/docs/deploying-your-portaljs-app"
|
"href": "/docs/deploying-your-portaljs-app"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Components API",
|
||||||
|
"href": "/docs/components-api"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|||||||
Reference in New Issue
Block a user