Anchor

Hyperlinks to scroll on one page.

When To Use#

For displaying anchor hyperlinks on page and jumping between them.

Examples

The simplest usage.

import { Anchor } from 'antd';
const { Link } = Anchor;

ReactDOM.render(
  <Anchor>
    <Link href="#components-anchor-demo-basic" title="Basic demo" />
    <Link href="#components-anchor-demo-fixed" title="Fixed demo" />
    <Link href="#API" title="API">
      <Link href="#Anchor-Props" title="Anchor Props" />
      <Link href="#Link-Props" title="Link Props" />
    </Link>
  </Anchor>
, mountNode);

Do not change state when page is scrolling.

import { Anchor } from 'antd';
const { Link } = Anchor;

ReactDOM.render(
  <Anchor affix={false}>
    <Link href="#components-anchor-demo-basic" title="Basic demo" />
    <Link href="#components-anchor-demo-fixed" title="Fixed demo" />
    <Link href="#API" title="API">
      <Link href="#Anchor-Props" title="Anchor Props" />
      <Link href="#Link-Props" title="Link Props" />
    </Link>
  </Anchor>
, mountNode);

API#

Anchor Props#

PropertyDescriptionTypeDefault
offsetTopPixels to offset from top when calculating position of scrollnumber0
offsetBottomPixels to offset from bottom when calculating position of scrollnumber-
boundsBounding distance of anchor areanumber5(px)
affixFixed mode of Anchorbooleanfalse
showInkInFixedWhether show ink-balls in Fixed modebooleanfalse
PropertyDescriptionTypeDefault
hreftarget of hyperlinkstring
titlecontent of hyperlinkstring|ReactNode