Skip to main content
useEntityList is the main hook for building entity feeds. Each list is identified by a listId, allowing multiple independent lists on the same page.

Basic Setup

fetchEntities Signature

Filters

Sort config

List config

Fetch options

Infinite Scroll

Call loadMore() to append the next page. The hook tracks pagination state internally.
hasMore reflects the value returned by the server, based on the total item count.

Creating Entities Within a List

createEntity creates an entity and automatically inserts it into the list:

Deleting Entities From a List

deleteEntity removes an entity from both the server and the local list state:

Sorting by Metadata

You can sort by any metadata field using the metadata.fieldName syntax:
Metadata field names must contain only alphanumeric characters and underscores.