ant-design/components/anchor/index.en-US.md
Arvin Xu dda650cc7b
docs: Update components cover (#24744)
* docs: Update components cover

#24629

* docs: Update components cover
2020-06-05 13:50:09 +08:00

1.7 KiB

category type cols title cover
Components Other 2 Anchor https://gw.alipayobjects.com/zos/alicdn/_1-C1JwsC/Anchor.svg

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 Version
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) -
getCurrentAnchor Customize the anchor highlight () => string -
targetOffset Anchor scroll offset, default as offsetTop, example number offsetTop
onChange Listening for anchor link change (currentActiveLink: string) => void
Property Description Type Default Version
href target of hyperlink string
title content of hyperlink string|ReactNode
target Specifies where to display the linked URL string