@atlaskit/spotlight

Version:

A spotlight introduces users to points of interest, from focused messages to multi-step tours.

30 lines (29 loc) • 915 B

TypeScript

/**
 * @jsxRuntime classic
 * @jsx jsx
 */
import { type ReactNode } from 'react';
import type { Placement } from '../../types';
export interface SpotlightCardProps {
    /**
     * A `testId` prop is provided for specified elements, which is a unique
     * string that appears as a data attribute `data-testid` in the rendered code,
     * serving as a hook for automated tests
     */
    testId?: string;
    /**
     * The position in relation to the target the content should be shown at. Overrides `PopoverContent.placement`
     */
    placement?: Placement;
    /**
     * Elements to be rendered inside the `SpotlightCard`.
     */
    children?: ReactNode;
}
/**
 * __Spotlight__
 *
 * The base UI card that wraps composable spotlight components.
 *
 */
export declare const SpotlightCard: React.ForwardRefExoticComponent<React.PropsWithoutRef<SpotlightCardProps> & React.RefAttributes<HTMLDivElement>>;