mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-28 11:08:30 +08:00
22 lines
747 B
Markdown
22 lines
747 B
Markdown
|
---
|
||
|
category: Components
|
||
|
type: Other
|
||
|
english: Affix
|
||
|
---
|
||
|
|
||
|
Make an element sticky to viewport.
|
||
|
|
||
|
## When to use
|
||
|
|
||
|
When user browses a long web page, some content need to sticky to viewport. It is common for menus and actions.
|
||
|
|
||
|
Please note that Affix should not cover other content in page, especially when the size of viewport is small.
|
||
|
|
||
|
## API
|
||
|
|
||
|
| Property | Description | Type | Default |
|
||
|
|--------------|-----------------------|----------|--------------|
|
||
|
| offsetTop | Pixels to offset from top when calculating position of scroll | Number | 0 |
|
||
|
| offsetBottom | Pixels to offset from bottom when calculating position of scroll | Number | - |
|
||
|
| onChange | Callback when affix state is changed | Function(affixed) | - |
|