@wordpress/views

A lightweight package for managing DataViews view state with persistence using WordPress preferences.

The @wordpress/views package provides:

• Persistence: Automatically saves and restores DataViews state using @wordpress/preferences
• View Modification Detection: Tracks when views differ from their default state
• Reset Functionality: Simple reset to default view capability
• Clean Integration: Drop-in replacement for manual view state management

Installation

Install the module

npm install @wordpress/views --save

API Reference

loadView

Async function for loading view state in route loaders.

Resolves the same layers useView does, so a route loader and the hook that takes over from it agree on the view.

Parameters

• config ViewConfig: Configuration object for loading the view.
• config.kind ViewConfig: Entity kind (e.g., 'postType', 'taxonomy', 'root').
• config.name ViewConfig: Specific entity name.
• config.slug ViewConfig: View identifier.
• config.defaultView ViewConfig: Default view configuration.
• config.defaultLayouts ViewConfig: Default layout configurations keyed by layout type.
• config.activeViewOverrides ViewConfig: View overrides applied on top but never persisted.
• config.queryParams ViewConfig: Object with page and/or search from URL.

Returns

• Promise resolving to the loaded view object.

useView

Hook for managing DataViews view state with local persistence.

Only the properties the user actually modified are persisted: every other property keeps resolving out of the layers below, so a change to the default view, to the layout defaults or to the active view overrides keeps showing through.

Parameters

• config ViewConfig: Configuration object for loading the view.

Returns

• UseViewReturn: Object with current view, modification state, and update functions.

useViewConfig

A hook that retrieves the view configuration for a given entity from the core data store.

Parameters

• params Object:
• params.kind string: The kind of the entity.
• params.name string: The name of the entity.
• params.fields [?(string|string[])]: Subset of top-level config properties to request, as an array or a comma-separated string (mapped to the REST API _fields parameter). When omitted, the full config is requested.

Returns

• Object: An object containing the default_view, default_layouts, view_list, and form configuration for the entity.