@carbon/ibm-products
Version:
Carbon for IBM Products
73 lines • 2.3 kB
TypeScript
/**
* Copyright IBM Corp. 2023, 2025
*
* 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';
type TooltipAlignment = 'top' | 'bottom';
interface CoachmarkStackProps {
/**
* CoachmarkStack should use a single CoachmarkOverlayElements component as a child.
*/
children: ReactNode;
/**
* Provide an optional class to be applied to the containing node.
*/
className?: string;
/**
* The label for the button that will close the Stack
*/
closeButtonLabel?: string;
/**
* The description of the Coachmark.
*/
description: ReactNode;
/**
* Optional prop to render any media like images or any animated media.
*/
renderMedia?: (params: any) => ReactNode;
/**
* The labels used to link to the stackable Coachmarks.
*/
navLinkLabels: string[];
/**
* Function to call when the CoachmarkStack closes.
*/
onClose?: () => void;
/**
* Where in the DOM to render the stack.
* The default is `document.body`.
*/
portalTarget?: string;
/**
* The tagline title which will be fixed to the bottom right of the window and will serve as the display trigger.
*/
tagline: string;
/**
* Determines the theme of the component.
*/
theme?: 'light' | 'dark';
/**
* The title of the Coachmark.
*/
title: string;
/**
* Label's tooltip position
*/
tooltipAlign?: TooltipAlignment;
/**
* Tooltip text and aria label for the Close button icon.
*/
closeIconDescription?: string;
}
/**
* Stacked coachmarks are used to call out specific functionality or concepts
* within the UI that may not be intuitive but are important for the
* user to gain understanding of the product's main value and discover new use cases.
* This variant allows the stacking of multiple coachmark overlays to be displayed by interacting with the tagline.
* @deprecated This component is deprecated.
*/
export declare const CoachmarkStack: React.ForwardRefExoticComponent<CoachmarkStackProps & React.RefAttributes<HTMLDivElement>>;
export {};
//# sourceMappingURL=CoachmarkStack.d.ts.map