Interface CoreQuickview

interface CoreQuickview {
    state: CoreQuickviewState;
    fetchResultContent(): void;
    next(): void;
    previous(): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- CoreQuickview
  - Quickview

Index

Methods

fetchResultContent next previous subscribe

Properties

Methods

fetchResultContent

fetchResultContent(): void
Retrieves the preview content for the configured result. If options.onlyContentURL is true this will update the contentURL state property rather than content.

Returns void
- Defined in packages/headless/src/controllers/core/quickview/headless-core-quickview.ts:58

next

next(): void
Retrieves the preview content for the next available result in the current result set.

If it reaches the last available result in the current result set, it will not perform an additional query to fetch new results.

Instead, it will loop back to the first available result.

If options.onlyContentURL is true this will update the contentURL state property rather than content.

Returns void
- Defined in packages/headless/src/controllers/core/quickview/headless-core-quickview.ts:69

previous

previous(): void
Retrieves the preview content for the previous available result in the current result set.

If it reaches the first available result in the current result set, it will not perform an additional query to fetch new results.

Instead, it will loop back to the last available result.

If options.onlyContentURL is true this will update the contentURL state property rather than content.

Returns void
- Defined in packages/headless/src/controllers/core/quickview/headless-core-quickview.ts:79

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

The state for the Quickview controller.