ant-design/components/anchor/index.en-US.md
MadCcc e7edfa42d7
docs: update overview img (#38946)
* docs: update overview img

* chore: code clean

* chore: code clean

* chore: update

* chore: code clean
2022-11-30 20:14:41 +08:00

2.2 KiB

category title cover demo group
Components Anchor https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*TBTSR4PyVmkAAAAAAAAAAAAADrJ8AQ/original
cols
2
title order
Navigation 3

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 obtaining ref and calling internal instance methods will invalid.

Examples

Basic Static Anchor Customize the onClick event Customize the anchor highlight Set Anchor scroll offset Listening for anchor link change

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-balls 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 function(e: Event, link: Object) -
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