@atlaskit/onboarding
Version:
An onboarding spotlight introduces new features to users through focused messages or multi-step tours.
46 lines (45 loc) • 1.35 kB
TypeScript
/**
* @jsxRuntime classic
* @jsx jsx
*/
import { type HTMLAttributes, type ReactNode } from 'react';
type BaseProps = React.HTMLAttributes<HTMLDivElement> & {
bgColor?: string;
children?: ReactNode;
className?: string;
radius?: number | string;
testId?: string;
};
type TargetProps = Omit<BaseProps, 'css'> & {
pulse?: boolean;
};
/**
* __Target inner__
*
* Used to apply spotlight border and pulse to spotlight targets.
*
* @internal
*/
export declare const TargetInner: ({ bgColor, children, className, pulse, radius, testId, ...props }: TargetProps) => JSX.Element;
/**
* __Target overlay__
*
* Overlays a spotlight target, allowing for custom click events that are intended
* only for onboarding.
*
* @internal
*/
export declare const TargetOverlay: ({ onClick, ...props }: HTMLAttributes<HTMLDivElement>) => JSX.Element;
/**
* __Spotlight pulse__
*
* A spotlight pulse draws attention to a new feature.
*
* - [Examples](https://atlassian.design/components/onboarding/examples)
* - [Code](https://atlassian.design/components/onboarding/code)
* - [Usage](https://atlassian.design/components/onboarding/usage)
*
* @deprecated Use `@atlaskit/spotlight` instead.
*/
export declare const Pulse: ({ bgColor, children, className, radius, pulse, testId, ...props }: TargetProps) => JSX.Element;
export {};