Interface Quickview

The Quickview controller provides a way to fetch and display a preview of a result.

interface Quickview {
    state: QuickviewState;
    fetchResultContent(): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- Quickview

Index

Methods

fetchResultContent subscribe

Properties

Methods

fetchResultContent

fetchResultContent(): void
Updates the contentURL state property with the correct URL.

Returns void
- Defined in packages/headless/src/controllers/insight/quickview/headless-insight-quickview.ts:43

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

The state for the Quickview controller.