diff --git a/packages/edit-site/src/components/dataviews/README.md b/packages/edit-site/src/components/dataviews/README.md index 9128c71e64874d..7e39da79a3dae9 100644 --- a/packages/edit-site/src/components/dataviews/README.md +++ b/packages/edit-site/src/components/dataviews/README.md @@ -1,6 +1,19 @@ # DataView -This file aims to document the main APIs related to the DataView component. +This file aims to document the main APIs related to the DataViews component, which aims to provide an API to render datasets using different views (table, grid, etc.). + +```js + +``` ## View @@ -92,18 +105,12 @@ The fields describe the dataset. For example: - `resetLabel`: the label for the reset option of the filter. If none provided, `All` is used. - `resetValue`: the value for the reset option of the filter. If none provedid, `''` is used. -## DataViews +## Filters -The UI component responsible for rendering the dataset. +Global vs Field filters. -```js - -``` +Shape of the filter. + +## Actions + +Record actions.