Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 56 additions & 7 deletions src/Tour.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ import type { TriggerRef } from '@rc-component/trigger';
import Trigger from '@rc-component/trigger';
import { clsx } from 'clsx';
import useLayoutEffect from '@rc-component/util/lib/hooks/useLayoutEffect';
import useMergedState from '@rc-component/util/lib/hooks/useMergedState';
import useEvent from '@rc-component/util/lib/hooks/useEvent';
import KeyCode from '@rc-component/util/lib/KeyCode';
import useControlledState from '@rc-component/util/lib/hooks/useControlledState';
import { useMemo } from 'react';
import { useClosable } from './hooks/useClosable';
Expand Down Expand Up @@ -35,6 +36,7 @@ const Tour: React.FC<TourProps> = props => {
steps = [],
defaultCurrent,
current,
keyboard = true,
onChange,
onClose,
onFinish,
Expand Down Expand Up @@ -88,7 +90,7 @@ const Tour: React.FC<TourProps> = props => {
setHasOpened(true);
}
openRef.current = mergedOpen;
}, [mergedOpen]);
}, [mergedOpen, setMergedCurrent]);

const {
target,
Expand Down Expand Up @@ -156,18 +158,65 @@ const Tour: React.FC<TourProps> = props => {
}
return getPlacements(arrowPointAtCenter);
}, [builtinPlacements, arrowPointAtCenter]);
const handleClose = () => {
setMergedOpen(false);
onClose?.(mergedCurrent);
};

// ========================= Keyboard =========================
// Support Esc to close (if closable) and ArrowLeft/ArrowRight to navigate steps.
const keyboardHandler = useEvent((e: KeyboardEvent) => {
// Ignore keyboard events from input-like elements to avoid interfering when typing
const el = e.target as HTMLElement | null;
if (
el?.tagName === 'INPUT' ||
el?.tagName === 'TEXTAREA' ||
el?.tagName === 'SELECT' ||
el?.isContentEditable
) {
return;
}

if (keyboard && e.keyCode === KeyCode.ESC) {
if (mergedClosable !== null) {
e.stopPropagation();
e.preventDefault();
handleClose();
}
return;
}

if (keyboard && e.keyCode === KeyCode.LEFT) {
if (mergedCurrent > 0) {
e.preventDefault();
onInternalChange(mergedCurrent - 1);
}
return;
}

if (keyboard && e.keyCode === KeyCode.RIGHT) {
if (mergedCurrent < steps.length - 1) {
e.preventDefault();
onInternalChange(mergedCurrent + 1);
}
return;
}
});

useLayoutEffect(() => {
if (!mergedOpen) return;
window.addEventListener('keydown', keyboardHandler);
return () => {
window.removeEventListener('keydown', keyboardHandler);
};
}, [mergedOpen, keyboardHandler]);

// ========================= Render =========================
// Skip if not init yet
if (targetElement === undefined || !hasOpened) {
return null;
}

const handleClose = () => {
setMergedOpen(false);
onClose?.(mergedCurrent);
};

const getPopupElement = () => (
<TourStep
styles={styles}
Expand Down
1 change: 1 addition & 0 deletions src/interface.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export interface TourProps extends Pick<TriggerProps, 'onPopupAlign'> {
style?: React.CSSProperties;
steps?: TourStepInfo[];
open?: boolean;
keyboard?: boolean;
defaultOpen?: boolean;
defaultCurrent?: number;
current?: number;
Expand Down