

<DemoTitle title="FloatButton" desc="用于网站上的全局功能；无论浏览到何处都可以看见的按钮。">
#### API

<AntdApiRef url="https://ant.design/components/float-button-cn/#api"></AntdApiRef>


## antd API

通用属性参考：[通用属性](/docs/react/common-props)

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

### 共同的 API

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| icon | 自定义图标 | ReactNode | - |  | 
| description | 文字及其它内容 | ReactNode | - |  | 
| tooltip | 气泡卡片的内容 | ReactNode \|  | - | TooltipProps: 5.25.0 | 
| type | 设置按钮类型 | default | default |  | 
| shape | 设置按钮形状 | circle | circle |  | 
| onClick | 点击按钮时的回调 | (event) => void | - |  | 
| href | 点击跳转的地址，指定此属性 button 的行为和 a 链接一致 | string | - |  | 
| target | 相当于 a 标签的 target 属性，href 存在时生效 | string | - |  | 
| htmlType | 设置  | submit | button | 5.21.0 | 
| badge | 带徽标数字的悬浮按钮（不支持  |  | - | 5.4.0 | 


### FloatButton.Group

| 参数 | 说明 | 类型 | 默认值 | 版本 | 
|--------|--------|--------|--------|--------|
| shape | 设置包含的 FloatButton 按钮形状 | circle | circle |  | 
| trigger | 触发方式（有触发方式为菜单模式） | click | - |  | 
| open | 受控展开，需配合 trigger 一起使用 | boolean | - |  | 
| closeIcon | 自定义关闭按钮 | React.ReactNode |  |  | 
| placement | 自定义菜单弹出位置 | top | 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 | - |  | 
