@carbon/ibm-products
Version:
Carbon for IBM Products
68 lines • 2.2 kB
TypeScript
/**
* 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';
type TooltipAlignment = 'top' | 'bottom';
interface CoachmarkStackHomeProps {
/**
* Optional class name for this component.
*/
className?: string;
/**
* The label for the button that will close the stack
*/
closeButtonLabel?: string;
/**
* The description of the Coachmark.
*/
description: React.ReactNode;
/**
* If the stack home is open.
*/
isOpen: boolean;
/**
* 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[];
/**
* For internal use only by CoachmarkStack and CoachmarkStackHome.
*/
onClickNavItem: (index: number) => void;
/**
* Function to call when the stack closes.
*/
onClose: () => void;
/**
* By default, the CoachmarkStackHome will be appended to the end of `document.body`.
* The CoachmarkStackHome will remain persistent as the user navigates the app until
* the user closes the CoachmarkStackHome.
*
* Alternatively, the app developer can tightly couple the CoachmarkStackHome to a DOM
* element or other component by specifying a CSS selector. The CoachmarkStackHome will
* remain visible as long as that element remains visible or mounted. When the
* element is hidden or component is unmounted, the CoachmarkStackHome will disappear.
*/
portalTarget?: string;
/**
* The title of the Coachmark.
*/
title: string;
/**
* Label's tooltip position
*/
tooltipAlign?: TooltipAlignment;
}
/**
* DO NOT USE. This component is for the exclusive use
* of other Onboarding components.
*/
export declare const CoachmarkStackHome: React.ForwardRefExoticComponent<CoachmarkStackHomeProps & React.RefAttributes<HTMLDivElement>>;
export {};
//# sourceMappingURL=CoachmarkStackHome.d.ts.map