@neo4j-ndl/react
Version:
React implementation of Neo4j Design System
40 lines • 2.42 kB
TypeScript
/**
*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import type React from 'react';
import { Spotlight, type SpotlightCloseAction } from './Spotlight';
type SpotlightTourAction = SpotlightCloseAction | 'dismiss' | 'back' | 'next' | 'close' | 'open';
type SpotlightTourProps = {
/** An array of `Spotlight` component props objects. SpotlightTour overrides the following props, to simplify your implementation, if they are undefined: `actions`, `beforeActions`, `initialFocus`, `onClose`. If you want custom behaviour for a certain `Spotlight` you can set these props yourself. */
spotlights: React.ComponentProps<typeof Spotlight>[];
/** A string that will be the text for the dismiss button */
dismissButtonLabel?: string;
/** A string that will be the text for the back button */
backButtonLabel?: string;
/** A string that will be the text for the next button */
nextButtonLabel?: string;
/** A string that will be the text for the close button */
closeButtonLabel?: string;
/** A callback function that is called when some actions are performed inside a `Spotlight`. It receives two arguments: `target` (string identifying the `Spotlight` that the action was performed in) and `action` (string describing the action that has been performed. These actions can be "dismiss", "back", "next", "close", "clickOutside" or "escapeKeyDown") */
onAction?: (target: string, action: SpotlightTourAction) => void;
};
export declare const SpotlightTour: ({ spotlights, dismissButtonLabel, backButtonLabel, nextButtonLabel, closeButtonLabel, onAction, }: SpotlightTourProps) => import("react/jsx-runtime").JSX.Element;
export {};
//# sourceMappingURL=SpotlightTour.d.ts.map