ant-design/components/anchor/index.en-US.md
mushan0x0 dd37457048 feat: Anchor onClick (#11898)
* update: 添加AntAnchor类型

* update: 完成代码逻辑

* update: 添加测试

* update: 点击锚点不记录历史

* update: 添加示例

* docs: 更新文档

* update: 更改onClick事件里的link为对象

* update: 优化代码

* update: 修改propClick为onClick
2018-08-28 20:20:46 +08:00

34 lines
1.0 KiB
Markdown

---
category: Components
type: Other
cols: 2
title: Anchor
---
Hyperlinks to scroll on one page.
## When To Use
For displaying anchor hyperlinks on page and jumping between them.
## API
### Anchor Props
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| affix | Fixed mode of Anchor | boolean | true |
| bounds | Bounding distance of anchor area | number | 5(px) |
| getContainer | Scrolling container | () => HTMLElement | () => window |
| offsetBottom | Pixels to offset from bottom when calculating position of scroll | number | - |
| offsetTop | Pixels to offset from top when calculating position of scroll | number | 0 |
| showInkInFixed | Whether show ink-balls in Fixed mode | boolean | false |
| onClick | set the handler to handle `click` event | Function(e: Event, link: Object) | - |
### Link Props
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| href | target of hyperlink | string | |
| title | content of hyperlink | string\|ReactNode | |