import React from 'react'; export type CoachmarkPlacement = 'top' | 'bottom' | 'start' | 'end'; export interface CoachmarkProps { /** * What the coachmark points at: an element's `id`, or a ref to it. Ids let * a tour be written as data, with no refs threaded through the page. */ target: string | React.RefObject; /** Names the coachmark — it is a dialog, and this is its label. */ title: string; /** What to know about the target. Linked as the dialog's description. */ children?: React.ReactNode; /** * Which side of the target it sits on. Logical: `start` is the left in a * left-to-right page and the right in a right-to-left one. React Aria * flips it when there is no room. */ placement?: CoachmarkPlacement; /** Shown or not. Defaults to shown: render it when a person asks for it. */ isOpen?: boolean; /** The close button and Escape. Without it there is no close button. */ onClose?: () => void; /** Actions under the body, end-aligned: a tour's Back and Next. */ footer?: React.ReactNode; /** Where this is in a sequence — "2 of 4" — at the start of the footer. */ progress?: string; /** The close button's name. Default "Close". */ closeLabel?: string; className?: string; } /** * Coachmark — a callout pointing at one thing on the page, to say what it is * or what changed. Anchored to its target, which is ringed while it shows. * Several in a row are a Tour. * * ONLY WHEN ASKED * * It takes focus when it appears, so it must appear because someone asked: * a "Take the tour" button, a "What's new?" link. Opened on page load, it * would pull a keyboard or screen-reader user out of whatever they came to * do. To tell people something changed without being asked, use a Banner. * * NOT MODAL * * The page behind stays usable and is not hidden from assistive tech: this * points at the page, and the page is the point. Focus is not trapped; it * goes back where it was when the coachmark closes, and Escape closes it. */ export declare function Coachmark({ isOpen, ...props }: CoachmarkProps): React.JSX.Element | null; export declare namespace Coachmark { var displayName: string; } //# sourceMappingURL=Coachmark.d.ts.map