mirror of
https://github.com/ant-design/ant-design.git
synced 2025-06-15 22:49:07 +08:00
a05b9d92c5
* feat: add FloatButton * feat: add FloatButton * feat: FloatButton * feat: FloatButton * fix: fix * feat: FloatButton * feat: FloatButton * feat: FloatButton * feat: FloatButton * feat: FloatButton * fix: add groupShape * feat: mergeShape * fix: fix * fix: fix style * fix: style fix * fix: fix * fix: style fix * fix: fix * fix: fix * fix: fix * fix: fix style * fix: fix style * fix: fix style * fix: style fix * feat: back-top * fix: style bug fix * fix: fix erroe * fix: add tiggerElement * fix: add tiggerElement * fix: add tiggerElement * fix: add tiggerElement * feat: add useMemo * docs: add docs * fix: bugFix * fix: bugFix * fix: bugfix * fix: style fix * fix: bugfix * test: add test case * fix: style fix * fix: style fix * fix: fix style * fix: fix style * fix: fix trigger action * fix: fix style * feat: add demo * fix: add demo * feat: add docs * fix: style ifx * feat: update maxSize of bundlesize * feat: add animation for group * fix: fix * fix: fix style * fix: fix test case * fix: fix test case * fix: fix type * fix: fix type * fix: update bundlesize * fix: fix * fix: fix style * fix: fix style * fix: updata snap * fix: fix CI * fix: fix style * fix: rename float button motion * fix: fix style * fix: bugFix * fix: fix style * fix: bugFix * fix: update docs * refactor: float button trigger * test: fix test case & update snapshot * fix: delete rest * docs: update demo * test: update snapshot * fix: fix eslint error * test: update snapshot * style: update icon fontSize to 18 * fix: fix style * fix: style fix * fix: test case fix * test: add test case * fix: style fix * test: update snap * fix: style fix * fix: style fix * fix: style fix * docs: demo update * fix: style fix * docs: update demo * test: update snapshot Co-authored-by: 黑雨 <wangning4567@163.com> Co-authored-by: MadCcc <1075746765@qq.com>
47 lines
1.8 KiB
Markdown
47 lines
1.8 KiB
Markdown
---
|
||
category: Components
|
||
type: Other
|
||
title: FloatButton
|
||
cover: https://gw.alipayobjects.com/zos/bmw-prod/9b1b62fe-e677-4afc-b9fe-1b2993662611.svg
|
||
---
|
||
|
||
FloatButton. Available since `5.0.0`.
|
||
|
||
## When To Use
|
||
|
||
- For global functionality on the site.
|
||
- Buttons that can be seen wherever you browse.
|
||
|
||
## API
|
||
|
||
### common API
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| icon | Set the icon component of button | ReactNode | - | |
|
||
| description | Text and other | ReactNode | - | |
|
||
| tooltip | The text shown in the tooltip | ReactNode \| () => ReactNode | | |
|
||
| type | Setting button type | `default` \| `primary` | `default` | |
|
||
| shape | Setting button shape | `circle` \| `square` | `circle` | |
|
||
| onClick | Set the handler to handle `click` event | (event) => void | - | |
|
||
| href | The target of hyperlink | string | - | |
|
||
| target | Specifies where to display the linked URL | string | - | |
|
||
|
||
### FloatButton.Group
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| shape | Setting button shape of children | `circle` \| `square` | `circle` | |
|
||
| trigger | Which action can trigger menu open/close | `click` \| `hover` | - | |
|
||
| open | Whether the menu is visible or not | boolean | - | |
|
||
| onOpenChange | Callback executed when active menu is changed | (open: boolean) => void | - | |
|
||
|
||
### FloatButton.BackTop
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| duration | Time to return to top（ms） | number | 450 | |
|
||
| target | Specifies the scrollable area dom node | () => HTMLElement | () => window | |
|
||
| visibilityHeight | The BackTop button will not show until the scroll height reaches this value | number | 400 | |
|
||
| onClick | A callback function, which can be executed when you click the button | () => void | - | |
|