Skip to content

Commit

Permalink
DataViews documentation: add high-level graph explaining DataViews an…
Browse files Browse the repository at this point in the history
…d data sources interaction (#65457)

Co-authored-by: oandregal <oandregal@git.wordpress.org>
Co-authored-by: youknowriad <youknowriad@git.wordpress.org>
Co-authored-by: juanmaguitar <juanmaguitar@git.wordpress.org>
  • Loading branch information
4 people authored Sep 20, 2024
1 parent 219065c commit e691b04
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/dataviews/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

DataViews is a component that provides an API to render datasets using different types of layouts (table, grid, list, etc.).

DataViews is data agnostic, it can work with data coming from a static (JSON file) or dynamic source (HTTP Request) — it just requires the data to be an array of objects that have an unique identifier. Consumers are responsible to query the data source appropiately based on the DataViews props:

![DataViews flow](https://developer.wordpress.org/files/2024/09/368600071-20aa078f-7c3d-406d-8dd0-8b764addd22a.png "DataViews flow")

## Installation

Install the module
Expand Down

0 comments on commit e691b04

Please sign in to comment.