Skip to main content
Unlock powerful debugging and effortless query monitoring with Refine DevtoolsLearn More
RefineDocumentation
Version: 3.xx.xx
Swizzle Ready

Breadcrumb

A breadcrumb displays the current location within a hierarchy. It allows going back to states higher up in the hierarchy. <Breadcrumb> component built with Ant Design's Breadcrumb components using the useBreadcrumb hook.

Swizzle

You can swizzle this component to customize it with the refine CLI

localhost:3000/posts/show/123
Live previews only work with the latest documentation.
import { Show, Breadcrumb } from "@pankod/refine-antd";

const PostShow: React.FC = () => {
  return (
    <Show
      breadcrumb={<Breadcrumb />}
    >
      <p>Content of your show page...</p>
    </Show>
  );
};

Properties​

<Breadcrumb> component uses the Ant Design Breadcrumb component so it can be configured with the breadcrumbProps property.

import { List, Breadcrumb } from "@pankod/refine-antd";

export const PostList: React.FC = () => {
  return (
    <List
      breadcrumb={<Breadcrumb breadcrumbProps={{ separator: "-" }} />}
    >
      ...
    </List>
  );
};

showHome​

If your application has a DashboardPage, the home button is shown to the top of the hierarchy by default. If you don't want to show the home button, you can set showHome to false.

import { List, Breadcrumb } from "@pankod/refine-antd";

export const PostList: React.FC = () => {
  return (
    <List
      breadcrumb={<Breadcrumb showHome={false} />}
    >
      ...
    </List>
  );
};

hideIcons​

If you don't want to show the resource icons on the breadcrumb, you can set hideIcons to true.

import { List, Breadcrumb } from "@pankod/refine-antd";

export const PostList: React.FC = () => {
  return (
    <List
      breadcrumb={<Breadcrumb hideIcons />}
    >
      ...
    </List>
  );
};

API Reference​

Properties​

Previous
Show
Next
Clone