@carbon/ibm-products/lib/components/CoachmarkOverlayElements/CoachmarkOverlayElements.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 CoachmarkOverlayElementsProps {
    /**
     * CoachmarkOverlayElements should be used with one or many CoachmarkOverlayElement components as children.
     * @see CoachmarkOverlayElement
     */
    children: ReactNode;
    /**
     * Optional class name for this component.
     */
    className?: string;
    /**
     * The visibility of CoachmarkOverlayElements is
     * managed in the parent component.
     */
    isVisible?: boolean;
    /**
     * Optional prop to render any media like images or any animated media.
     */
    renderMedia?: (params: any) => ReactNode;
    /**
     * The label for the Next button.
     */
    nextButtonText?: string;
    /**
     * The label for the Previous button.
     */
    previousButtonLabel?: string;
    /**
     * The label for the Close button.
     */
    closeButtonLabel?: string;
    /**
     * Callback called when clicking on the Next button.
     */
    onNext?: () => void;
    /**
     * Callback called when clicking on the Previous button.
     */
    onBack?: () => void;
    /**
     * Current step of the coachmarks.
     */
    currentStep?: number;
}
/**
 * Composable container to allow for the displaying of CoachmarkOverlayElement
 * components in a carousel fashion.
 */
export declare let CoachmarkOverlayElements: React.ForwardRefExoticComponent<CoachmarkOverlayElementsProps & React.RefAttributes<HTMLDivElement>>;