import * as React from 'react'; import VerticalAlignTopOutlined from '@ant-design/icons/VerticalAlignTopOutlined'; import classNames from 'classnames'; import CSSMotion from 'rc-motion'; import omit from 'rc-util/lib/omit'; import getScroll from '../_util/getScroll'; import { cloneElement } from '../_util/reactNode'; import scrollTo from '../_util/scrollTo'; import throttleByAnimationFrame from '../_util/throttleByAnimationFrame'; import { devUseWarning } from '../_util/warning'; import type { ConfigConsumerProps } from '../config-provider'; import { ConfigContext } from '../config-provider'; import useStyle from './style'; import useCSSVar from './style/cssVar'; export interface BackTopProps { visibilityHeight?: number; onClick?: React.MouseEventHandler; target?: () => HTMLElement | Window | Document; prefixCls?: string; children?: React.ReactNode; className?: string; rootClassName?: string; style?: React.CSSProperties; duration?: number; } const BackTop: React.FC = (props) => { const { prefixCls: customizePrefixCls, className, rootClassName, visibilityHeight = 400, target, onClick, duration = 450, } = props; const [visible, setVisible] = React.useState(visibilityHeight === 0); const ref = React.useRef(null); const getDefaultTarget = (): HTMLElement | Document | Window => ref.current && ref.current.ownerDocument ? ref.current.ownerDocument : window; const handleScroll = throttleByAnimationFrame( (e: React.UIEvent | { target: any }) => { const scrollTop = getScroll(e.target, true); setVisible(scrollTop >= visibilityHeight); }, ); if (process.env.NODE_ENV !== 'production') { const warning = devUseWarning('BackTop'); warning.deprecated(false, 'BackTop', 'FloatButton.BackTop'); } React.useEffect(() => { const getTarget = target || getDefaultTarget; const container = getTarget(); handleScroll({ target: container }); container?.addEventListener('scroll', handleScroll); return () => { handleScroll.cancel(); container?.removeEventListener('scroll', handleScroll); }; }, [target]); const scrollToTop = (e: React.MouseEvent) => { scrollTo(0, { getContainer: target || getDefaultTarget, duration }); onClick?.(e); }; const { getPrefixCls, direction } = React.useContext(ConfigContext); const prefixCls = getPrefixCls('back-top', customizePrefixCls); const rootPrefixCls = getPrefixCls(); const [, hashId] = useStyle(prefixCls); const wrapCSSVar = useCSSVar(prefixCls); const classString = classNames( hashId, prefixCls, { [`${prefixCls}-rtl`]: direction === 'rtl', }, className, rootClassName, ); // fix https://fb.me/react-unknown-prop const divProps = omit(props, [ 'prefixCls', 'className', 'rootClassName', 'children', 'visibilityHeight', 'target', ]); const defaultElement = (
); return wrapCSSVar(
{({ className: motionClassName }) => cloneElement(props.children || defaultElement, ({ className: cloneCls }) => ({ className: classNames(motionClassName, cloneCls), })) }
, ); }; if (process.env.NODE_ENV !== 'production') { BackTop.displayName = 'BackTop'; } export default BackTop;