zent/src/affix/README_en-US.md

一套前端设计语言和基于React的实现

---
title: Affix
path: component/affix
group: Navigation
---

## Affix

Pin element in a specific position.

### API

| Property             | Description                          | Type               | Default | Alternative |
| -------------------- | ------------------------------------ | ------------------ | ------- | ----------- |
| offsetTop            | Offset to the top of the viewport    | `number`           |         |             |
| offsetBottom         | Offset to the bottom of the viewport | `number`           |         |             |
| getAffixContainer    | Custom target node for positioning   | `() => HTMLElement | null`   | `window`    |
| children             | Children                             | `React.ReactNode`  |         |             |
| onPin                | Callback when affix pins             | `() => void`       |         |             |
| onUnpin              | Callback when affix unpins           | `() => void`       |         |             |
| zIndex               | Pin `z-index`                        | `number`           | 10      |             |
| className            | Extra class name                     | `string`           | `''`    |             |
| placeholderClassName | Placeholder container class name     | `string`           | `''`    |             |

**Note**

- At least one of `offsetTop` and `offsetBottom` must be set; you can set both at the same time but you're warned of bizarre things that may happen if window height is too small.
- Using `ref` and `getAffixContainer` for relative positioning at the same time when there are two scrollbars. You should add scroll event listener for outer scroll container manually.