Refresh

<RefreshButton> uses Ant Design's <Button> component to update the data shown on the page via the useOne method provided by your dataProvider.

Swizzle

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

Usage

http://localhost:3000

import { useShow } from "@refinedev/core";
import {
    RefreshButton,
    Show,
} from "@refinedev/antd";
import { Typography } from "antd";

const { Title, Text } = Typography;

const PostShow: React.FC = () => {
    const { queryResult } = useShow<IPost>();
    const { data, isLoading } = queryResult;
    const record = data?.data;

    return (
        <Show
            isLoading={isLoading}
            headerButtons={<RefreshButton />}
        >
            <Title level={5}>Id</Title>
            <Text>{record?.id}</Text>

            <Title level={5}>Title</Title>
            <Text>{record?.title}</Text>
        </Show>
    );
};

interface IPost {
    id: string;
    title: string;
}

Properties

recordItemId

recordItemId allows us to manage which data is going to be refreshed.

http://localhost:3000

import { RefreshButton } from "@refinedev/antd";

const MyRefreshComponent = () => {
    return (
        <RefreshButton
            resource="posts"
            recordItemId="1"
        />
    );
};

Clicking the button will trigger the useOne method and then fetches the record whose resource is "post" and whose id is "1".

note

<RefreshButton> component reads the id information from the route by default.

resource

resource allows us to manage which resource is going to be refreshed.

http://localhost:3000

import { RefreshButton } from "@refinedev/antd";

const MyRefreshComponent = () => {
    return (
        <RefreshButton
            resource="posts"
        />
    );
};

Clicking the button will trigger the useOne method and then fetches the record whose resource is "categories" and whose id is "2".

note

<RefreshButton> component reads the resource name from the route by default.

hideText

It is used to show and not show the text of the button. When true, only the button icon is visible.

http://localhost:3000

import { RefreshButton } from "@refinedev/antd";

const MyRefreshComponent = () => {
    return (
        <RefreshButton
            hideText
        />
    );
};

resourceNameOrRouteName

deprecated

resourceNameOrRouteName prop is deprecated. Use resource prop instead.

resourceNameOrRouteName allows us to manage which resource is going to be refreshed.

http://localhost:3000

import { RefreshButton } from "@refinedev/antd";

const MyRefreshComponent = () => {
    return (
        <RefreshButton
            resourceNameOrRouteName="posts"
        />
    );
};

Clicking the button will trigger the useOne method and then fetches the record whose resource is "categories" and whose id is "2".

note

<RefreshButton> component reads the resource name from the route by default.

API Reference

Properties

External Props

It also accepts all props of Ant Design Button.