@atlaskit/spotlight
Version:
A spotlight introduces users to points of interest, from focused messages to multi-step tours.
25 lines (24 loc) • 810 B
TypeScript
/**
* @jsxRuntime classic
* @jsx jsx
*/
import { type ReactNode } from 'react';
export interface SpotlightHeadlineProps {
/**
* 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;
/**
* A brief and direct title to clearly communicate the intent.
*/
children: ReactNode;
}
/**
* __SpotlightHeadline__
*
* `SpotlightHeadline` is required in a `Spotlight`. The content should be brief and direct to quickly hook the user on the intent.
*
*/
export declare const SpotlightHeadline: React.ForwardRefExoticComponent<React.PropsWithoutRef<SpotlightHeadlineProps> & React.RefAttributes<HTMLHeadingElement>>;