mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-05 13:37:52 +08:00
40e77c40d3
* docs: add dark overview * docs: show dark cover in dark theme * docs: update cover
3.2 KiB
3.2 KiB
category | title | cover | coverDark | demo | group | ||||
---|---|---|---|---|---|---|---|---|---|
Components | Anchor | https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*TBTSR4PyVmkAAAAAAAAAAAAADrJ8AQ/original | https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*JGb3RIzyOCkAAAAAAAAAAAAADrJ8AQ/original |
|
Hyperlinks to scroll on one page.
When To Use
For displaying anchor hyperlinks on page and jumping between them.
Notes for developers
After version
4.24.0
, we rewrite Anchor use FC, Some methods of obtainingref
and calling internal instance methods will invalid.
Examples
Basic
Horizontal Anchor
Static Anchor
Customize the onClick event
Customize the anchor highlight
Set Anchor scroll offset
Listening for anchor link change
Deprecated JSX demo
API
Anchor Props
Property | Description | Type | Default | Version |
---|---|---|---|---|
affix | Fixed mode of Anchor | boolean | true | |
bounds | Bounding distance of anchor area | number | 5 | |
getContainer | Scrolling container | () => HTMLElement | () => window | |
getCurrentAnchor | Customize the anchor highlight | (activeLink: string) => string | - | |
offsetTop | Pixels to offset from top when calculating position of scroll | number | 0 | |
showInkInFixed | Whether show ink-square when affix={false} |
boolean | false | |
targetOffset | Anchor scroll offset, default as offsetTop , example |
number | - | |
onChange | Listening for anchor link change | (currentActiveLink: string) => void | ||
onClick | Set the handler to handle click event |
(e: MouseEvent, link: object) => void | - | |
items | Data configuration option content, support nesting through children | { key, href, title, target, children }[] see | - | 5.1.0 |
direction | Set Anchor direction | vertical | horizontal |
vertical |
5.2.0 |
AnchorItem
Property | Description | Type | Default | Version |
---|---|---|---|---|
key | The unique identifier of the Anchor Link | string | number | - | |
href | The target of hyperlink | string | ||
target | Specifies where to display the linked URL | string | ||
title | The content of hyperlink | ReactNode | ||
children | Nested Anchor Link, Attention: This attribute does not support horizontal orientation |
AnchorItem[] | - |
Link Props
We recommend using the items form instead.
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 |