Interface ResultList

The ResultList headless controller offers a high-level interface for designing a common result list UI controller.

Example: result-list.fn.tsx

interface ResultList {
    state: ResultListState;
    fetchMoreResults(): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- ResultList

Index

Methods

fetchMoreResults subscribe

Properties

Methods

fetchMoreResults

fetchMoreResults(): void
Using the same parameters as the last successful query, fetch another batch of results, if available. Particularly useful for infinite scrolling, for example.

This method is not compatible with the Pager controller.

Returns void
- Defined in packages/headless/src/controllers/core/result-list/headless-core-result-list.ts:71

subscribe

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

Properties

state

state: ResultListState

The state of the ResultList controller.