Skip to main content
UniversalCore
Version: 4.xx.xx
Swizzle Ready

Refresh

<RefreshButton> uses Ant Design's <Button> component to update the data shown on the page via the useInvalidate hook.

Good to know:

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

Usage​

// visible-block-start
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;
}
// visible-block-end

render(
  <RefineAntdDemo
    initialRoutes={["/posts/show/123"]}
    resources={[
      {
        name: "posts",
        show: PostShow,
        list: () => {
          return (
            <RefineAntd.List>
              <p>Your list page here</p>
            </RefineAntd.List>
          );
        },
      },
    ]}
  />,
);

Properties​

recordItemId​

recordItemId allows us to manage which data is going to be refreshed. By default, the recordItemId is inferred from the route params.

// visible-block-start
import { RefreshButton } from "@refinedev/antd";

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

render(
  <RefineAntdDemo
    initialRoutes={["/"]}
    resources={[
      {
        name: "posts",
      },
    ]}
    DashboardPage={MyRefreshComponent}
  />,
);

Clicking the button will trigger the useInvalidate hook and then fetch the record whose resource is "post" and whose id is "1".

resource​

resource allows us to manage which resource is going to be refreshed. By default, the resource is inferred from the route params.

// visible-block-start
import { RefreshButton } from "@refinedev/antd";

const MyRefreshComponent = () => {
  return (
    <RefreshButton
      resource="categories"
      recordItemId="2"
    />
  );
};
// visible-block-end

render(
  <RefineAntdDemo
    initialRoutes={["/"]}
    resources={[
      {
        name: "posts",
      },
      {
        name: "categories",
      },
    ]}
    DashboardPage={MyRefreshComponent}
  />,
);

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

If you have multiple resources with the same name, you can pass the identifier instead of the name of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name of the resource defined in the <Refine/> component.

For more information, refer to the identifier of the <Refine/> component documentation →

hideText​

hideText is used to hide the text of the button. When its true, only the button icon will be visible.

// visible-block-start
import { RefreshButton } from "@refinedev/antd";

const MyRefreshComponent = () => {
  return (
    <RefreshButton
      hideText
    />
  );
};
// visible-block-end

render(
  <RefineAntdDemo
    initialRoutes={["/"]}
    resources={[
      {
        name: "posts",
      },
    ]}
    DashboardPage={MyRefreshComponent}
  />,
);

resourceNameOrRouteName
deprecated
​

Use resource prop instead.

API Reference​

Properties​

External Props:

It also accepts all props of Ant Design Button.

Previous
List
Next
Save