import * as React from 'react'; import Animate from 'rc-animate'; import addEventListener from 'rc-util/lib/Dom/addEventListener'; import classNames from 'classnames'; import omit from 'omit.js'; import { ConfigConsumer, ConfigConsumerProps } from '../config-provider'; import getScroll from '../_util/getScroll'; import scrollTo from '../_util/scrollTo'; function getDefaultTarget() { return window; } export interface BackTopProps { visibilityHeight?: number; onClick?: React.MouseEventHandler; target?: () => HTMLElement | Window; prefixCls?: string; className?: string; style?: React.CSSProperties; visible?: boolean; // Only for test. Don't use it. } export default class BackTop extends React.Component { static defaultProps = { visibilityHeight: 400, }; scrollEvent: any; constructor(props: BackTopProps) { super(props); this.state = { visible: false, }; } componentDidMount() { const getTarget = this.props.target || getDefaultTarget; this.scrollEvent = addEventListener(getTarget(), 'scroll', this.handleScroll); this.handleScroll(); } componentWillUnmount() { if (this.scrollEvent) { this.scrollEvent.remove(); } } setScrollTop(value: number) { const getTarget = this.props.target || getDefaultTarget; const targetNode = getTarget(); if (targetNode === window) { document.body.scrollTop = value; document.documentElement!.scrollTop = value; } else { (targetNode as HTMLElement).scrollTop = value; } } getCurrentScrollTop = () => { const getTarget = this.props.target || getDefaultTarget; const targetNode = getTarget(); if (targetNode === window) { return window.pageYOffset || document.body.scrollTop || document.documentElement!.scrollTop; } return (targetNode as HTMLElement).scrollTop; }; scrollToTop = (e: React.MouseEvent) => { const { target = getDefaultTarget } = this.props; scrollTo(0, { getContainer: target, }); if (typeof this.props.onClick === 'function') { this.props.onClick(e); } }; handleScroll = () => { const { visibilityHeight, target = getDefaultTarget } = this.props; const scrollTop = getScroll(target(), true); this.setState({ visible: scrollTop > (visibilityHeight as number), }); }; renderBackTop = ({ getPrefixCls }: ConfigConsumerProps) => { const { prefixCls: customizePrefixCls, className = '', children } = this.props; const prefixCls = getPrefixCls('back-top', customizePrefixCls); const classString = classNames(prefixCls, className); const defaultElement = (
); // fix https://fb.me/react-unknown-prop const divProps = omit(this.props, [ 'prefixCls', 'className', 'children', 'visibilityHeight', 'target', 'visible', ]); const visible = 'visible' in this.props ? this.props.visible : this.state.visible; const backTopBtn = visible ? (
{children || defaultElement}
) : null; return ( {backTopBtn} ); }; render() { return {this.renderBackTop}; } }