ant-design/components/anchor/index.en-US.md

38 lines
1.6 KiB
Markdown
Raw Normal View History

2016-10-28 14:02:55 +08:00
---
category: Components
type: Other
2016-11-18 17:02:57 +08:00
cols: 2
2016-10-28 14:02:55 +08:00
title: Anchor
cover: https://gw.alipayobjects.com/zos/alicdn/_1-C1JwsC/Anchor.svg
2016-10-28 14:02:55 +08:00
---
2016-11-09 21:06:43 +08:00
Hyperlinks to scroll on one page.
2016-10-28 14:02:55 +08:00
## When To Use
2016-11-29 17:13:24 +08:00
For displaying anchor hyperlinks on page and jumping between them.
2016-10-28 14:02:55 +08:00
## API
2016-11-03 16:45:13 +08:00
### Anchor Props
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| affix | Fixed mode of Anchor | boolean | true | |
| bounds | Bounding distance of anchor area | number | 5 | |
2019-11-21 19:58:41 +08:00
| getContainer | Scrolling container | () => HTMLElement | () => window | |
| getCurrentAnchor | Customize the anchor highlight | () => string | - | |
| offsetTop | Pixels to offset from top when calculating position of scroll | number | 0 | |
| showInkInFixed | Whether show ink-balls when `affix={false}` | boolean | false | |
| targetOffset | Anchor scroll offset, default as `offsetTop`, [example](#components-anchor-demo-targetOffset) | number | - | |
2019-11-21 19:58:41 +08:00
| onChange | Listening for anchor link change | (currentActiveLink: string) => void | | |
| onClick | Set the handler to handle `click` event | function(e: Event, link: Object) | - | |
2016-11-03 16:45:13 +08:00
2016-11-07 11:04:36 +08:00
### Link Props
2016-10-28 14:02:55 +08:00
2020-12-24 12:02:57 +08:00
| Property | Description | Type | Default | Version |
| -------- | ----------------------------------------- | --------- | ------- | ------- |
| href | The target of hyperlink | string | | |
| target | Specifies where to display the linked URL | string | | |
| title | The content of hyperlink | ReactNode | | |