import React, { useContext, useMemo } from 'react'; import classNames from 'classnames'; import omit from 'rc-util/lib/omit'; import { useZIndex } from '../_util/hooks/useZIndex'; import { devUseWarning } from '../_util/warning'; import Badge from '../badge'; import type { ConfigConsumerProps } from '../config-provider'; import { ConfigContext } from '../config-provider'; import useCSSVarCls from '../config-provider/hooks/useCSSVarCls'; import Tooltip from '../tooltip'; import type BackTop from './BackTop'; import FloatButtonGroupContext from './context'; import Content from './FloatButtonContent'; import type FloatButtonGroup from './FloatButtonGroup'; import type { FloatButtonContentProps, FloatButtonElement, FloatButtonProps, FloatButtonShape, } from './interface'; import type PurePanel from './PurePanel'; import useStyle from './style'; export const floatButtonPrefixCls = 'float-btn'; const InternalFloatButton = React.forwardRef((props, ref) => { const { prefixCls: customizePrefixCls, className, rootClassName, style, type = 'default', shape = 'circle', icon, description, tooltip, htmlType = 'button', badge = {}, ...restProps } = props; const { getPrefixCls, direction } = useContext(ConfigContext); const groupShape = useContext(FloatButtonGroupContext); const prefixCls = getPrefixCls(floatButtonPrefixCls, customizePrefixCls); const rootCls = useCSSVarCls(prefixCls); const [wrapCSSVar, hashId, cssVarCls] = useStyle(prefixCls, rootCls); const mergedShape = groupShape || shape; const classString = classNames( hashId, cssVarCls, rootCls, prefixCls, className, rootClassName, `${prefixCls}-${type}`, `${prefixCls}-${mergedShape}`, { [`${prefixCls}-rtl`]: direction === 'rtl', }, ); // ============================ zIndex ============================ const [zIndex] = useZIndex('FloatButton', style?.zIndex as number); const mergedStyle: React.CSSProperties = { ...style, zIndex }; // 虽然在 ts 中已经 omit 过了,但是为了防止多余的属性被透传进来,这里再 omit 一遍,以防万一 const badgeProps = omit(badge, ['title', 'children', 'status', 'text'] as any[]); const contentProps = useMemo( () => ({ prefixCls, description, icon, type }), [prefixCls, description, icon, type], ); let buttonNode = (
); if ('badge' in props) { buttonNode = {buttonNode}; } if ('tooltip' in props) { buttonNode = ( {buttonNode} ); } if (process.env.NODE_ENV !== 'production') { const warning = devUseWarning('FloatButton'); warning( !(shape === 'circle' && description), 'usage', 'supported only when `shape` is `square`. Due to narrow space for text, short sentence is recommended.', ); } return wrapCSSVar( props.href ? ( {buttonNode} ) : ( ), ); }); type CompoundedComponent = typeof InternalFloatButton & { Group: typeof FloatButtonGroup; BackTop: typeof BackTop; _InternalPanelDoNotUseOrYouWillBeFired: typeof PurePanel; }; const FloatButton = InternalFloatButton as CompoundedComponent; if (process.env.NODE_ENV !== 'production') { FloatButton.displayName = 'FloatButton'; } export default FloatButton;