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 Chakra UI Breadcrumb components using the useBreadcrumb hook.

Swizzle

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

Properties

breadcrumbProps

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

http://localhost:3000/posts/show/123

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/posts/show/123

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/posts/show/123

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