@carbon/ibm-products/lib/components/Coachmark/CoachmarkOverlay.d.ts

Carbon for IBM Products

/**
 * Copyright IBM Corp. 2023, 2024
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */
import React, { ReactNode } from 'react';
import { COACHMARK_OVERLAY_KIND } from './utils/enums';
interface CoachmarkOverlayProps {
    /**
     * The CoachmarkOverlayElements child components.
     * Validation is handled in the parent Coachmark component.
     */
    children: ReactNode;
    /**
     * Optional class name for this component.
     */
    className?: string;
    /**
     * The visibility of CoachmarkOverlay is
     * managed in the parent Coachmark component.
     */
    fixedIsVisible: boolean;
    /**
     * What kind or style of Coachmark to render.
     */
    kind?: COACHMARK_OVERLAY_KIND;
    /**
     * Function to call when the Coachmark closes.
     */
    onClose: () => void;
    /**
     * Determines the theme of the component.
     */
    theme?: 'light' | 'dark';
    /**
     * Additional props passed to the component.
     */
    [key: string]: any;
}
/**
 * DO NOT USE. This component is for the exclusive use
 * of other Onboarding components.
 */
export declare let CoachmarkOverlay: React.ForwardRefExoticComponent<Omit<CoachmarkOverlayProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
export {};