reablocks/dist/utils/Overlay/ConnectedOverlay/ConnectedOverlayContent.d.ts

Component library for React

import { FC, LegacyRef } from 'react';
import { Modifiers, Placement } from '../../Position';
export interface ConnectedOverlayContentRef {
    /** Recalculates and updates the overlay's position. */
    updatePosition: () => void;
}
export interface ConnectedOverlayContentProps {
    /**
     * Modifiers to adjust the behavior of the overlay content.
     */
    modifiers?: Modifiers;
    /**
     * If true, the overlay content will follow the cursor.
     */
    followCursor?: boolean;
    /**
     * The CSS class name to be applied to the portal of the overlay content.
     */
    portalClassName?: string;
    /**
     * The placement of the overlay content relative to the trigger.
     * @default 'bottom'
     */
    placement?: Placement;
    /**
     * A reference to the trigger element.
     */
    triggerRef: any;
    /**
     * The children to be rendered within the overlay content.
     */
    children: any;
    /**
     * If true, the overlay content will close when a click is detected on the body.
     * @default true
     */
    closeOnBodyClick?: boolean;
    /**
     * If true, the overlay content will close when the escape key is pressed.
     * @default true
     */
    closeOnEscape?: boolean;
    /**
     * The type of element that will be used as the overlay content.
     */
    elementType?: any;
    /**
     * If true, the overlay content will be appended to the body.
     * @default true
     */
    appendToBody?: boolean;
    /**
     * A function that is called when the overlay content is closed. It receives an optional event object as an argument.
     */
    onClose?: (event?: any) => void;
}
export declare const ConnectedOverlayContent: FC<ConnectedOverlayContentProps & {
    ref?: LegacyRef<ConnectedOverlayContentRef>;
}>;