import type { CaseAssistEngine } from '../../app/case-assist-engine/case-assist-engine.js'; import { type Quickview, type QuickviewOptions, type QuickviewProps, type QuickviewState } from '../core/quickview/headless-core-quickview.js'; export interface CaseAssistQuickviewProps extends QuickviewProps { } export interface CaseAssistQuickviewOptions extends QuickviewOptions { } /** * The `CaseAssistQuickview` controller provides an interface for triggering desirable side effects, such as logging UA events to the Coveo Platform, when a user interacts with a quickview. * * For example implementations, see the following [Coveo Quantic Case Assist components](https://docs.coveo.com/en/quantic/latest/reference/case-assist-components/): * * [quanticCaseClassification.js](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticCaseClassification/quanticCaseClassification.js) * * [quanticDocumentSuggestion](https://github.com/coveo/ui-kit/blob/main/packages/quantic/force-app/main/default/lwc/quanticDocumentSuggestion/quanticDocumentSuggestion.js) * * @group Controllers * @category CaseAssistQuickview */ export interface CaseAssistQuickview extends Quickview { state: CaseAssistQuickviewState; } /** * A scoped and simplified part of the headless state that is relevant to the `CaseAssistQuickview` controller. * * @group Controllers * @category CaseAssistQuickview */ export interface CaseAssistQuickviewState extends QuickviewState { /** * The number of available document for the current document set. * * Can be used for quickview pagination purpose. */ totalDocuments: number; /** * The position of the document in the current document set. * * Can be used for quickview pagination purpose. */ currentDocument: number; } /** * Creates a `CaseAssistQuickview` controller instance. * * @param engine - The headless engine. * @param props - The configurable `CaseAssistQuickview` properties. * @returns A `CaseAssistQuickview` controller instance. * * @group Controllers * @category CaseAssistQuickview */ export declare function buildCaseAssistQuickview(engine: CaseAssistEngine, props: CaseAssistQuickviewProps): CaseAssistQuickview;