@carbon/ibm-products/lib/components/CoachmarkOverlayElement/CoachmarkOverlayElement.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';
export interface CoachmarkOverlayElementProps {
    /**
     * An optional button can be rendered below the description.
     * This can be a link, button, Coachmark button, etc.
     */
    button?: ReactNode;
    /**
     * Optional class name for this component.
     */
    className?: string;
    /**
     * The description of the Coachmark.
     */
    description: ReactNode;
    /**
     * The title of the Coachmark.
     */
    title: string;
}
/**
 * Component to be displayed within a CoachmarkOverlayElements container.
 * Can be used 1 to N number, to display content in a Coachmark's overlay
 * in a carousel fashion.
 */
export declare let CoachmarkOverlayElement: React.ForwardRefExoticComponent<CoachmarkOverlayElementProps & React.RefAttributes<HTMLDivElement>>;