@contentstack/live-preview-utils/dist/modern/visualBuilder/generators/generateOverlay.d.ts

Contentstack provides the Live Preview SDK to establish a communication channel between the various Contentstack SDKs and your website, transmitting live changes to the preview pane.

import { VisualBuilderPostMessageEvents } from '../utils/types/postMessage.types.js';
import EventListenerHandlerParams from '../listeners/types.js';
import '../types/visualBuilder.types.js';
import '../../cslp/types/cslp.types.js';

/**
 * Adds a focus overlay to the target element.
 * @param targetElement - The element to add the focus overlay to.
 * @param focusOverlayWrapper - The HTMLDivElement that contains the focus overlay.
 * @returns void
 */
declare function addFocusOverlay(targetElement: Element, focusOverlayWrapper: HTMLDivElement, disabled?: boolean): void;
/**
 * Hides the focus overlay and performs necessary cleanup actions when the user clicks outside of the focused element.
 * @param event - The mouse event that triggered the function.
 * @param elements - An object containing references to the focus overlay wrapper, the previously selected editable DOM element, and the visual builder wrapper.
 */
declare function hideFocusOverlay(elements: HideOverlayParams): void;
interface ISendFieldEventParams {
    visualBuilderContainer: HTMLElement | null;
    eventType: VisualBuilderPostMessageEvents.UPDATE_FIELD | VisualBuilderPostMessageEvents.SYNC_FIELD;
}
declare function sendFieldEvent(options: ISendFieldEventParams): void;
interface HideOverlayParams extends Pick<EventListenerHandlerParams, "visualBuilderContainer" | "focusedToolbar" | "resizeObserver"> {
    visualBuilderOverlayWrapper: HTMLDivElement | null;
    noTrigger?: boolean;
}
declare function hideOverlay(params: HideOverlayParams): void;

export { addFocusOverlay, hideFocusOverlay, hideOverlay, sendFieldEvent };