ant-design/components/tour/index.tsx
MadCcc 29be72bc38
fix: Tour step.type should work (#45086)
* fix: Tour step.type should work

* chore: code clean

* chore: update memo deps

* chore: code clean
2023-09-26 13:42:43 +08:00

86 lines
2.2 KiB
TypeScript

import React, { useContext, useMemo } from 'react';
import RCTour from '@rc-component/tour';
import classNames from 'classnames';
import getPlacements from '../_util/placements';
import type { ConfigConsumerProps } from '../config-provider';
import { ConfigContext } from '../config-provider';
import { useToken } from '../theme/internal';
import type { TourProps, TourStepProps } from './interface';
import TourPanel from './panelRender';
import PurePanel from './PurePanel';
import useStyle from './style';
const Tour: React.FC<TourProps> & { _InternalPanelDoNotUseOrYouWillBeFired: typeof PurePanel } = (
props,
) => {
const {
prefixCls: customizePrefixCls,
type,
rootClassName,
indicatorsRender,
steps,
...restProps
} = props;
const { getPrefixCls, direction } = useContext<ConfigConsumerProps>(ConfigContext);
const prefixCls = getPrefixCls('tour', customizePrefixCls);
const [wrapSSR, hashId] = useStyle(prefixCls);
const [, token] = useToken();
const mergedSteps = useMemo(
() =>
steps?.map((step) => ({
...step,
className: classNames(step.className, {
[`${prefixCls}-primary`]: (step.type ?? type) === 'primary',
}),
})),
[steps, type],
);
const builtinPlacements = getPlacements({
arrowPointAtCenter: true,
autoAdjustOverflow: true,
offset: token.marginXXS,
arrowWidth: token.sizePopupArrow,
borderRadius: token.borderRadius,
});
const customClassName = classNames(
{
[`${prefixCls}-rtl`]: direction === 'rtl',
},
hashId,
rootClassName,
);
const mergedRenderPanel = (stepProps: TourStepProps, stepCurrent: number): React.ReactNode => (
<TourPanel
type={type}
stepProps={stepProps}
current={stepCurrent}
indicatorsRender={indicatorsRender}
/>
);
return wrapSSR(
<RCTour
{...restProps}
rootClassName={customClassName}
prefixCls={prefixCls}
animated
renderPanel={mergedRenderPanel}
builtinPlacements={builtinPlacements}
steps={mergedSteps}
/>,
);
};
if (process.env.NODE_ENV !== 'production') {
Tour.displayName = 'Tour';
}
Tour._InternalPanelDoNotUseOrYouWillBeFired = PurePanel;
export default Tour;