@contentstack/live-preview-utils/dist/modern/visualBuilder/utils/multipleElementAddButton.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 { VisualBuilderCslpEventDetails } from '../types/visualBuilder.types.js';
import { ISchemaFieldMap } from './types/index.types.js';
import '../../cslp/types/cslp.types.js';
import '../../cms/types/contentTypeSchema.types.js';

/**
 * The function that handles the add instance buttons for multiple fields.
 * @param eventDetails The details containing the field metadata and cslp value.
 * @param elements The elements object that contain the editable element and visual builder wrapper.
 * @param config The configuration object that contains the expected field data and disabled state.
 * @returns void
 */
declare function handleAddButtonsForMultiple(eventDetails: VisualBuilderCslpEventDetails, elements: {
    editableElement: Element | null;
    visualBuilderContainer: HTMLDivElement | null;
    resizeObserver: ResizeObserver;
}, config: {
    fieldSchema: ISchemaFieldMap;
    /**
     * expectedFieldData is the value of the whole multiple field (an array)
     */
    expectedFieldData: any;
    disabled: boolean;
    label: string | undefined;
}): void;
declare function removeAddInstanceButtons(elements: {
    visualBuilderContainer: HTMLDivElement | null;
    overlayWrapper: HTMLDivElement | null;
    eventTarget: EventTarget | null;
}, forceRemoveAll?: boolean): void;
/**
 * This function observes the parent element and focuses the newly added instance.
 *
 * @param parentCslp The parent cslp value.
 * @param index The index of the new instance.
 * @returns void
 *
 * We can evolve the retry logic, as different use cases arise.
 * Currently, if the new element is not found after the first mutation, we until
 * WAIT_FOR_NEW_INSTANCE_TIMEOUT, expecting that the new instance/block will be
 * found in later mutations and we can focus + disconnect then.
 * We also ensure there is only one setTimeout scheduled.
 */
declare function observeParentAndFocusNewInstance({ parentCslp, index, }: {
    parentCslp: string;
    index: number;
}): void;

export { handleAddButtonsForMultiple, observeParentAndFocusNewInstance, removeAddInstanceButtons };