@carbon/ibm-products
Version:
Carbon for IBM Products
41 lines • 1.22 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 { BEACON_KIND } from '../Coachmark';
import React from 'react';
import { ButtonProps } from '@carbon/react';
export interface CoachmarkButtonProps extends ButtonProps<React.ElementType> {
onClick?(): void;
onDoubleClick?(): void;
tabIndex?: number;
['aria-bool']?: boolean;
}
export interface CoachmarkBeaconProps {
/**
* Optional class name for this component.
*/
className?: string;
/**
* What style of beacon.
* BEACON_KIND is an exported enum from the Coachmark and can be used for this value.
* @see {@link BEACON_KIND}
*/
kind?: BEACON_KIND;
/**
* The aria label.
*/
label: string;
/**
* button props
*/
buttonProps?: CoachmarkButtonProps;
}
/**
* Use beacon for the target prop of a Coachmark component.
* @deprecated This component is deprecated.
*/
export declare const CoachmarkBeacon: React.ForwardRefExoticComponent<CoachmarkBeaconProps & React.RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=CoachmarkBeacon.d.ts.map