Skip to main content
Version: 3.xx.xxSwizzle Ready

Breadcrumb

http://localhost:3000
Live previews only work with the latest documentation.
const { default: routerProvider } = RefineReactRouterV6
const { default: simpleRest } = RefineSimpleRest
setRefineProps({
  routerProvider,
  dataProvider: simpleRest('https://api.fake-rest.refine.dev'),
  Layout: RefineChakra.Layout,
  Sider: () => null,
  DashboardPage: () => <p>Dashboard Page</p>,
})

const Wrapper = ({ children }) => {
  return (
    <RefineChakra.ChakraProvider theme={RefineChakra.refineTheme}>
      {children}
    </RefineChakra.ChakraProvider>
  )
}

const PostIcon = (
  <svg
    xmlns="http://www.w3.org/2000/svg"
    className="icon icon-tabler icon-tabler-list"
    width={18}
    height={18}
    viewBox="0 0 24 24"
    strokeWidth="2"
    stroke="currentColor"
    fill="none"
    strokeLinecap="round"
    strokeLinejoin="round"
  >
    <path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
    <line x1={9} y1={6} x2={20} y2={6}></line>
    <line x1={9} y1={12} x2={20} y2={12}></line>
    <line x1={9} y1={18} x2={20} y2={18}></line>
    <line x1={5} y1={6} x2={5} y2="6.01"></line>
    <line x1={5} y1={12} x2={5} y2="12.01"></line>
    <line x1={5} y1={18} x2={5} y2="18.01"></line>
  </svg>
)

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

Swizzle

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

Properties​

<Breadcrumb> component uses the Chakra UI Breadcrumb component so it can be configured with the breadcrumbProps property.

http://localhost:3000
Live previews only work with the latest documentation.
import { Show, Breadcrumb } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show
      breadcrumb={<Breadcrumb breadcrumbProps={{ separator: '-' }} />}
    >
      <p>Rest of your page here</p>
    </Show>
  )
}

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.

http://localhost:3000
Live previews only work with the latest documentation.
import { Show, Breadcrumb } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show
      breadcrumb={<Breadcrumb showHome={false} />}
    >
      <p>Rest of your page here</p>
    </Show>
  )
}

hideIcons​

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

http://localhost:3000
Live previews only work with the latest documentation.
import { Show, Breadcrumb } from '@pankod/refine-chakra-ui'

const PostShow: React.FC = () => {
  return (
    <Show
      breadcrumb={<Breadcrumb hideIcons />}
    >
      <p>Rest of your page here</p>
    </Show>
  )
}

API Reference​

Properties​