Anchor

Hyperlinks to scroll on one page.

When To Use#

For displaying anchor hyperlinks on page and jumping between them.

Examples

The simplest usage.

expand codeexpand code
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
);

Clicking on an anchor does not record history.

expand codeexpand code
import { Anchor } from 'antd';

const { Link } = Anchor;

const handleClick = (e, link) => {
  e.preventDefault();
  console.log(link);
};

ReactDOM.render(
  <Anchor affix={false} onClick={handleClick}>
    <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.

expand codeexpand code
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
affixFixed mode of Anchorbooleantrue
boundsBounding distance of anchor areanumber5(px)
getContainerScrolling container() => HTMLElement() => window
offsetBottomPixels to offset from bottom when calculating position of scrollnumber-
offsetTopPixels to offset from top when calculating position of scrollnumber0
showInkInFixedWhether show ink-balls in Fixed modebooleanfalse
onClickset the handler to handle click eventFunction(e: Event, link: Object)-
PropertyDescriptionTypeDefault
hreftarget of hyperlinkstring
titlecontent of hyperlinkstring|ReactNode