@carbon/ibm-products
Version:
Carbon for IBM Products
42 lines • 1.32 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 from 'react';
interface CoachmarkDragbarProps {
/**
* Handler to manage keyboard interactions with the dragbar.
*/
a11yKeyboardHandler: (event: React.KeyboardEvent<HTMLButtonElement>) => void;
/**
* Function to call when the close button is clicked.
*/
onClose?: () => void;
/**
* Function to call when the user clicks and drags the Coachmark.
* For internal use only by the parent CoachmarkOverlay.
*/
onDrag?: (movementX: number, movementY: number) => void;
/**
* Show/hide the "X" close button.
*/
showCloseButton?: boolean;
/**
* 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.
* @deprecated This component is deprecated.
*/
export declare const CoachmarkDragbar: React.ForwardRefExoticComponent<Omit<CoachmarkDragbarProps, "ref"> & React.RefAttributes<HTMLElement>>;
export {};
//# sourceMappingURL=CoachmarkDragbar.d.ts.map