Interface QuickviewState

A scoped and simplified part of the headless state that is relevant to the Quickview controller.

interface QuickviewState {
    content: string;
    contentURL?: string;
    currentResult: number;
    currentResultUniqueId: string;
    isLoading: boolean;
    resultHasPreview: boolean;
    totalResults: number;
}

Hierarchy (View Summary)

Properties

content contentURL? currentResult currentResultUniqueId isLoading resultHasPreview totalResults

Properties

content

content: string

The result preview HTML content.

Default

""

OptionalcontentURL

contentURL?: string

The src path to use if rendering the quickview in an iframe.

currentResult

currentResult: number

The position of the result in the current result set.

Can be used for quickview pagination purpose.

currentResultUniqueId

currentResultUniqueId: string

The current result unique ID,

isLoading

isLoading: boolean

true if content is being fetched, and false otherwise.

resultHasPreview

resultHasPreview: boolean

true if the configured result has a preview, and false otherwise.

totalResults

totalResults: number

The number of available results for the current result set.

Can be used for quickview pagination purpose.

Settings

Member Visibility

On This Page

Properties