@atlaskit/spotlight/dist/types/ui/dismiss-control/index.d.ts

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

import { type PressableProps } from '@atlaskit/primitives/compiled';
export interface SpotlightDismissControlProps {
    /**
     * 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 action to take when the button is clicked.
     */
    onClick?: PressableProps['onClick'];
    /**
     * @default true
     *
     * Specifies whether the dismiss button should be focused when the spotlight is rendered.
     * For spotlights that are triggered by user-action, this should be `true`. In the event that
     * a spotlight is rendered on page load, without explicit user interaction, this should be `false`.
     */
    autoFocus?: boolean;
}
/**
 * __SpotlightDismissControl__
 *
 * SpotlightDismissControl allows the user to close the `Spotlight`.
 *
 */
export declare const SpotlightDismissControl: React.ForwardRefExoticComponent<React.PropsWithoutRef<SpotlightDismissControlProps> & React.RefAttributes<HTMLButtonElement>>;