@atlaskit/spotlight/dist/types/ui/secondary-action/index.d.ts

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

/**
 * @jsxRuntime classic
 * @jsx jsx
 */
import { type ReactNode } from 'react';
import { type PressableProps } from '@atlaskit/primitives/compiled';
export interface SpotlightSecondaryActionProps {
    /**
     * 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;
    /**
     * Text to be rendered inside the `SpotlightActions`.
     */
    children: ReactNode;
    /**
     * The action to take when the button is clicked.
     */
    onClick?: PressableProps['onClick'];
    /**
     * An accessible label to read out in the event that the displayed text does not provide enough context.
     */
    'aria-label'?: string;
}
/**
 * __Spotlight secondary action__
 *
 * `SpotlightSecondaryAction` is not required for all spotlight components. It should supplement the `SpotlightPrimaryAction`.
 * It is intended to be used to go back to the previous step in multi step spotlight tours, or other similar actions.
 *
 */
export declare const SpotlightSecondaryAction: React.ForwardRefExoticComponent<React.PropsWithoutRef<SpotlightSecondaryActionProps> & React.RefAttributes<HTMLButtonElement>>;