Interface QuerySummary

The QuerySummary headless controller offers a high-level interface for designing a common query summary UI controller.

interface QuerySummary {
state: QuerySummaryState;
subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- QuerySummary

Index

Methods

Properties

Methods

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/dist/definitions/controllers/controller/headless-controller.d.ts:10

Properties

state

state: QuerySummaryState

The state relevant to the CoreQuerySummary controller.