1

2026-05-25 17:08:18 +08:00
parent df501f6151
commit f1259b71b5
9178 changed files with 1626125 additions and 0 deletions
@@ -0,0 +1,80 @@
+import type { TriggerProps } from '@rc-component/trigger';
+import type { PlacementType } from './placements';
+import type { CSSProperties, ReactNode } from 'react';
+import type { Gap } from './hooks/useTarget';
+import { type DefaultPanelProps } from './TourStep/DefaultPanel';
+export type SemanticName = 'section' | 'footer' | 'actions' | 'header' | 'title' | 'description' | 'mask';
+export type HTMLAriaDataAttributes = React.AriaAttributes & {
+    [key: `data-${string}`]: unknown;
+} & Pick<React.HTMLAttributes<HTMLDivElement>, 'role'>;
+export interface TourStepInfo {
+    arrow?: boolean | {
+        pointAtCenter: boolean;
+    };
+    target?: HTMLElement | (() => HTMLElement) | null | (() => null);
+    title: ReactNode;
+    description?: ReactNode;
+    placement?: PlacementType;
+    mask?: boolean | {
+        style?: React.CSSProperties;
+        color?: string;
+    };
+    className?: string;
+    style?: CSSProperties;
+    scrollIntoViewOptions?: boolean | ScrollIntoViewOptions;
+    closeIcon?: ReactNode;
+    closable?: boolean | ({
+        closeIcon?: ReactNode;
+    } & HTMLAriaDataAttributes);
+}
+export interface TourStepProps extends TourStepInfo {
+    prefixCls?: string;
+    total?: number;
+    current?: number;
+    onClose?: () => void;
+    onFinish?: () => void;
+    renderPanel?: (step: TourStepProps, current: number) => ReactNode;
+    onPrev?: () => void;
+    onNext?: () => void;
+    classNames?: Partial<Record<SemanticName, string>>;
+    styles?: Partial<Record<SemanticName, React.CSSProperties>>;
+}
+export interface TourProps extends Pick<TriggerProps, 'onPopupAlign'> {
+    classNames?: Partial<Record<SemanticName, string>>;
+    styles?: Partial<Record<SemanticName, React.CSSProperties>>;
+    className?: string;
+    style?: React.CSSProperties;
+    steps?: TourStepInfo[];
+    open?: boolean;
+    keyboard?: boolean;
+    defaultOpen?: boolean;
+    defaultCurrent?: number;
+    current?: number;
+    onChange?: (current: number) => void;
+    onClose?: (current: number) => void;
+    onFinish?: () => void;
+    closeIcon?: TourStepProps['closeIcon'];
+    closable?: TourStepProps['closable'];
+    mask?: boolean | {
+        style?: React.CSSProperties;
+        color?: string;
+    };
+    arrow?: boolean | {
+        pointAtCenter: boolean;
+    };
+    rootClassName?: string;
+    placement?: PlacementType;
+    prefixCls?: string;
+    renderPanel?: (props: DefaultPanelProps, current: number) => ReactNode;
+    gap?: Gap;
+    animated?: boolean | {
+        placeholder: boolean;
+    };
+    scrollIntoViewOptions?: boolean | ScrollIntoViewOptions;
+    zIndex?: number;
+    getPopupContainer?: TriggerProps['getPopupContainer'] | false;
+    builtinPlacements?: TriggerProps['builtinPlacements'] | ((config?: {
+        arrowPointAtCenter?: boolean;
+    }) => TriggerProps['builtinPlacements']);
+    disabledInteraction?: boolean;
+}