README.md

DataView

This file documents the DataViews UI component, which provides an API to render datasets using different view types (table, grid, etc.).

<DataViews
	data={ pages }
	isLoading= { isLoadingPages }
	view={ view }
	onChangeView={ onChangeView }
	fields={ fields }
	actions={ [ trashPostAction ] }
	paginationInfo={ { totalItems, totalPages } }
/>

Data

The dataset to work with, represented as a one-dimensional array.

Example:

[
	{ id: 1, title: "Title", ... },
	{ ... }
]

View

The view object configures how the dataset is visible to the user.

Example:

{
	type: 'list',
	perPage: 5,
	page: 1,
	sort: {
		field: 'date',
		direction: 'desc',
	},
	search: '',
	filters: [
		{ field: 'author', operator: 'in', value: 2 },
		{ field: 'status', operator: 'in', value: 'publish,draft' }
	],
	visibleFilters: [ 'author', 'status' ],
	hiddenFields: [ 'date', 'featured-image' ],
	layout: {},
}

• type: view type, one of list or grid.
• perPage: number of records to show per page.
• page: the page that is visible.
• sort.field: field used for sorting the dataset.
• sort.direction: the direction to use for sorting, one of asc or desc.
• search: the text search applied to the dataset.
• filters: the filters applied to the dataset. Each item describes:
  • field: which field this filter is bound to.
  • operator: which type of filter it is. Only in available at the moment.
  • vaule: the actual value selected by the user.
• visibleFilters: the id of the filters that are visible in the UI.
• hiddenFields: the id of the fields that are hidden in the UI.
• layout: ...

View <=> data

The view is a representation of the visible state of the dataset. Note, however, that it's the consumer's responsibility to work with the data provider to make sure the user options defined through the view's config (sort, pagination, filters, etc.) are respected.

The following example shows how a view object is used to query the WordPress REST API via the entities abstraction. The same can be done with any other data provider.

function MyCustomPageList() { 
	const [ view, setView ] = useState( {
		type: 'list',
		perPage: 5,
		page: 1,
		sort: {
			field: 'date',
			direction: 'desc',
		},
		search: '',
		filters: [
			{ field: 'author', operator: 'in', value: 2 },
			{ field: 'status', operator: 'in', value: 'publish,draft' }
		],
		visibleFilters: [ 'author', 'status' ],
		hiddenFields: [ 'date', 'featured-image' ],
		layout: {},
	} );

	const queryArgs = useMemo( () => {
		const filters = {};
		view.filters.forEach( ( filter ) => {
			if ( filter.field === 'status' && filter.operator === 'in' ) {
				filters.status = filter.value;
			}
			if ( filter.field === 'author' && filter.operator === 'in' ) {
				filters.author = filter.value;
			}
		} );
		return {
			per_page: view.perPage,
			page: view.page,
			_embed: 'author',
			order: view.sort?.direction,
			orderby: view.sort?.field,
			search: view.search,
			...filters,
		};
	}, [ view ] );

	const {
		records
	} = useEntityRecords( 'postType', 'page', queryArgs );

	return (
		<DataViews
			data={ records }
			view={ view }
			onChangeView={ setView }
			"..."
		/>
	);
}

Fields

The fields describe the visible items for each record in the dataset.

Example:

[
	{
		id: 'date',
		header: __( 'Date' ),
		getValue: ( { item } ) => item.date,
		render: ( { item } ) => {
			return (
				<time>{ getFormattedDate( item.date ) }</time>
			);
		}
	},
	{
		id: 'author',
		header: __( 'Author' ),
		getValue: ( { item } ) => item.author,
		render: ( { item } ) => {
			return (
				<a href="...">{ item.author }</a>
			);
		},
		elements: [
			{ value: 1, label: 'Admin' }
			{ value: 2, label: 'User' }
		]
		filters: [ 'in' ],
	}
]

• id: identifier for the field. Unique.
• header: the field's name to be shown in the UI.
• getValue: function that returns the value of the field.
• render: function that renders the field.
• elements: the set of valid values for the field's value.
• filters: what filter operators are available for the user to use over this field. Only in available at the moment.

Actions

Array of operations that can be performed upon each record. Each action is an object with the following properties:

• id: string, required. Unique identifier of the action. For example, move-to-trash.
• label: string, required. User facing description of the action. For example, Move to Trash.
• isPrimary: boolean, optional. Whether the action should be listed inline (primary) or in hidden in the more actions menu (secondary).
• icon: icon to show for primary actions. It's required for a primary action, otherwise the action would be considered secondary.
• isEligible: function, optional. Whether the action can be performed for a given record. If not present, the action is considered to be eligible for all items. It takes the given record as input.
• isDestructive: boolean, optional. Whether the action can delete data, in which case the UI would communicate it via red color.
• perform: function, required. Function that takes the record as input and performs the required action.