Interface FoldedResultList

The FoldedResultList headless controller re-organizes results into hierarchical collections (a.k.a. threads).

Example: folded-result-list.fn.tsx

interface FoldedResultList {
    state: FoldedResultListState;
    fetchMoreResults(): void;
    findResultByCollection(collection: FoldedCollection): null | FoldedResult;
    findResultById(collection: FoldedCollection): null | FoldedResult;
    loadCollection(collection: FoldedCollection): void;
    logShowLessFoldedResults(): void;
    logShowMoreFoldedResults(result: Result): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- FoldedResultList

Index

Methods

fetchMoreResults findResultByCollection findResultById loadCollection logShowLessFoldedResults logShowMoreFoldedResults 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/folded-result-list/headless-core-folded-result-list.ts:112

findResultByCollection

findResultByCollection(collection: FoldedCollection): null | FoldedResult
Finds a folded result by its collection.
Parameters
- collection: FoldedCollection
  The folded collection whose collection name will be used to find a collection in the results.
Returns null | FoldedResult
The FoldedResult associated with the collection's name.
- Defined in packages/headless/src/controllers/core/folded-result-list/headless-core-folded-result-list.ts:142

findResultById

findResultById(collection: FoldedCollection): null | FoldedResult
Finds a folded result by its unique ID.
Parameters
- collection: FoldedCollection
  The folded collection whose ID will be used to find a collection in the results.
Returns null | FoldedResult
The FoldedResult associated with the collection's ID.
- Defined in packages/headless/src/controllers/core/folded-result-list/headless-core-folded-result-list.ts:135

loadCollection

loadCollection(collection: FoldedCollection): void
Loads all the folded results for a given collection.
Parameters
- collection: FoldedCollection
  The collection for which to load more results.
Returns void
- Defined in packages/headless/src/controllers/core/folded-result-list/headless-core-folded-result-list.ts:118

logShowLessFoldedResults

logShowLessFoldedResults(): void
Logs a custom event when a user shows less folded results.

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

logShowMoreFoldedResults

logShowMoreFoldedResults(result: Result): void
Logs a click event when a user loads/shows more folded results.
Parameters
- result: Result
  The result to send analytics for.
Returns void
- Defined in packages/headless/src/controllers/core/folded-result-list/headless-core-folded-result-list.ts:124

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: FoldedResultListState

The state of the FoldedResultList controller.