ant-design/components/tour/interface.ts
Rinku Chaudhari c4040ec81b
chore: fix docs comments (#45156)
* refactor: convertLegacyProps function moved to buttonHelpers

* docs: spelling and grammar fixes

* docs: fix comments grammar
2023-10-03 05:44:09 +08:00

39 lines
1.1 KiB
TypeScript

import type {
TourProps as RCTourProps,
TourStepProps as RCTourStepProps,
} from '@rc-component/tour';
import type { ReactNode } from 'react';
export interface TourProps extends Omit<RCTourProps, 'renderPanel'> {
steps?: TourStepProps[];
className?: string;
prefixCls?: string;
current?: number;
indicatorsRender?: (current: number, total: number) => ReactNode;
type?: 'default' | 'primary'; // default type, affects the background color and text color
}
export interface TourStepProps extends RCTourStepProps {
cover?: ReactNode; // Display pictures or videos
nextButtonProps?: {
children?: ReactNode;
onClick?: () => void;
className?: string;
style?: React.CSSProperties;
};
prevButtonProps?: {
children?: ReactNode;
onClick?: () => void;
className?: string;
style?: React.CSSProperties;
};
indicatorsRender?: (current: number, total: number) => ReactNode;
type?: 'default' | 'primary'; // default type, affects the background color and text color
}
export interface TourLocale {
Next: string;
Previous: string;
Finish: string;
}