ant-design/components/float-button/index.zh-CN.md

category, group, title, subtitle, description, cover, coverDark, demo

category	group	title	subtitle	description	cover	coverDark	demo
Components	通用	FloatButton	悬浮按钮	悬浮于页面上方的按钮。	https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*tXAoQqyr-ioAAAAAAAAAAAAADrJ8AQ/original	https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*hSAwR7cnabwAAAAAAAAAAAAADrJ8AQ/original	cols 2

何时使用

• 用于网站上的全局功能；
• 无论浏览到何处都可以看见的按钮。

代码演示

基本 类型 形状 描述 含有气泡卡片的悬浮按钮 浮动按钮组 菜单模式 受控模式 弹出方向 回到顶部 徽标数 调试小圆点使用 自定义语义结构的样式和类 _InternalPanelDoNotUseOrYouWillBeFired

API

通用属性参考：通用属性

自 antd@5.0.0 版本开始提供该组件。

共同的 API

参数	说明	类型	默认值	版本
icon	自定义图标	ReactNode	-
classNames	用于自定义组件内部各语义化结构的 class，支持对象或函数	Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string>	-
content	文字及其它内容	ReactNode	-
description	请使用 content 代替	ReactNode	-
tooltip	气泡卡片的内容	ReactNode | TooltipProps	-	TooltipProps: 5.25.0
type	设置按钮类型	default | primary	default
shape	设置按钮形状	circle | square	circle
styles	用于自定义组件内部各语义化结构的行内 style，支持对象或函数	Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties>	-
onClick	点击按钮时的回调	(event) => void	-
href	点击跳转的地址，指定此属性 button 的行为和 a 链接一致	string	-
target	相当于 a 标签的 target 属性，href 存在时生效	string	-
htmlType	设置 button 原生的 type 值，可选值请参考 HTML 标准	submit | reset | button	button	5.21.0
badge	带徽标数字的悬浮按钮（不支持 status 以及相关属性）	BadgeProps	-	5.4.0

FloatButton.Group

参数	说明	类型	默认值	版本
shape	设置包含的 FloatButton 按钮形状	circle | square	circle
trigger	触发方式（有触发方式为菜单模式）	click | hover	-
open	受控展开，需配合 trigger 一起使用	boolean	-
closeIcon	自定义关闭按钮	React.ReactNode	<CloseOutlined />
placement	自定义菜单弹出位置	top | left | right | bottom	top	5.21.0
onOpenChange	展开收起时的回调，需配合 trigger 一起使用	(open: boolean) => void	-
onClick	点击按钮时的回调（仅在菜单模式中有效）	(event) => void	-	5.3.0

FloatButton.BackTop

参数	说明	类型	默认值	版本
duration	回到顶部所需时间（ms）	number	450
target	设置需要监听其滚动事件的元素	() => HTMLElement	() => window
visibilityHeight	滚动高度达到此参数值才出现 BackTop	number	400
onClick	点击按钮的回调函数	() => void	-

Semantic DOM

FloatButton

FloatButton.Group

主题变量（Design Token）