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-static" title="Static demo" />
    <Link href="#API" title="API">
      <Link href="#Anchor-Props" title="Anchor Props" />
      <Link href="#Link-Props" title="Link Props" />
    </Link>
  </Anchor>,
  mountNode
);

Customize the onClick event

Clicking on an anchor does not record history.

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-static" title="Static 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-static" title="Static 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#

Property	Description	Type	Default
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)	-

Link Props#

Property	Description	Type	Default
href	target of hyperlink	string
title	content of hyperlink	string\|ReactNode

Components

Anchor

When To Use#

Examples

API#

Anchor Props#

Link Props#