@carbon/ibm-products
Version:
Carbon for IBM Products
29 lines (28 loc) • 824 B
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 { BEACON_KIND } from '../Coachmark';
import React from 'react';
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;
}
/**
* Use beacon for the target prop of a Coachmark component.
*/
export declare let CoachmarkBeacon: React.ForwardRefExoticComponent<CoachmarkBeaconProps & React.RefAttributes<HTMLDivElement>>;