The `@wordpress/dataviews` package

Installation

Setup

Within WordPress

Outside WordPress

`DataViews`

Usage

Properties

`data`: `Object[]`

`getItemId`: `function`

`getItemLevel`: `function`

`fields`: `Object[]`

`view`: `Object`

Properties of `layout`

`onChangeView`: `function`

`actions`: `Object[]`

`paginationInfo`: `Object`

`search`: `boolean`

`searchLabel`: `string`

`isLoading`: `boolean`

`defaultLayouts`: `Object`

`selection`: `string[]`

`onChangeSelection`: `function`

`isItemClickable`: `function`

`onClickItem`: `function`

`renderItemLink`: `React.ComponentType`

`header`: React component

`config`: { perPageSizes: number[] }

`empty`: React node

`onReset`: `( () => void ) | false`

Styling

Composition modes

Free composition

example

Accessibility considerations

`DataViewsPicker`

Usage

Properties

`data`: `Object[]`

`fields`: `Object[]`

`view`: `Object`

`onChangeView`: `function`

`actions`: `Object[]`

`paginationInfo`: `Object`

`search`: `boolean`

`searchLabel`: `string`

`isLoading`: `boolean`

`defaultLayouts`: `Record`

`selection`: `string[]`

`onChangeSelection`: `function`

`getItemId`: `function`

`itemListLabel`: `string`

`config`: { perPageSizes: number[] }

`empty`: React node

`children`: React node

`DataForm`

Usage

Properties

`data`: `Object`

`fields`: `Object[]`

`form`: `Object`

`onChange`: `function`

validity

Utilities

`filterSortAndPaginate`

`useFormValidity`

Actions API

`id`

`label`

`isPrimary`

`icon`

`isEligible`

`supportsBulk`

`disabled`

`context`

`callback`

`RenderModal`

`hideModalHeader`

`modalHeader`

`modalSize`

`modalFocusOnMount`

Fields API

`id`

`type`

`label`

`header`

`description`

`placeholder`

`getValue` and `setValue`

`getValue`

`setValue`

Simple field access

Nested data access

Custom data transformation

`getValueFormatted`

`render`

`Edit`

`readOnly`

`sort`

`isValid`

`isVisible`

`enableSorting`

`enableHiding`

`enableGlobalSearch`

`elements`

`getElements`

`filterBy`

`format`

Form Field API

`id`

`layout`

Regular

Panel

Card

Row

Details

`label`

`description`

`children`

Contributing to this package