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

Refresh

const { default: sharedRouterProvider } = LegacyRefineReactRouterV6;
const { default: simpleRest } = RefineSimpleRest;
setRefineProps({
  legacyRouterProvider: sharedRouterProvider,
  dataProvider: simpleRest("https://api.fake-rest.refine.dev"),
  Layout: RefineChakra.Layout,
  Sider: () => null,
  catchAll: <RefineChakra.ErrorComponent />,
});

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

<RefreshButton> uses Chakra UI'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​

setInitialRoutes(["/posts/show/123"]);
import { Refine } from "@refinedev/core";
import { ShowButton } from "@refinedev/chakra-ui";

// visible-block-start
import { useShow } from "@refinedev/core";
import {
  Show,
  MarkdownField,
  RefreshButton,
} from "@refinedev/chakra-ui";
import { Heading, Text, Spacer } from "@chakra-ui/react";

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

  return (
    <Show headerButtons={<RefreshButton />} isLoading={isLoading}>
      <Heading as="h5" size="sm">
        Id
      </Heading>
      <Text mt={2}>{record?.id}</Text>

      <Heading as="h5" size="sm" mt={4}>
        Title
      </Heading>
      <Text mt={2}>{record?.title}</Text>

      <Heading as="h5" size="sm" mt={4}>
        Content
      </Heading>
      <Spacer mt={2} />
      <MarkdownField value={record?.content} />
    </Show>
  );
};
// visible-block-end

const App = () => {
  return (
    <Refine
      notificationProvider={RefineChakra.notificationProvider()}
      resources={[
        {
          name: "posts",
          show: PostShow,
          list: () => (
            <RefineChakra.VStack alignItems="flex-start">
              <RefineChakra.Text>This page is empty.</RefineChakra.Text>
              <ShowButton colorScheme="black" recordItemId="123">
                Show Item 123
              </ShowButton>
            </RefineChakra.VStack>
          ),
        },
      ]}
    />
  );
};
render(
  <Wrapper>
    <App />
  </Wrapper>,
);

Properties​

recordItemId​

recordItemId allows us to manage which data is going to be refreshed. By default it will read the id information from the route.

setInitialRoutes(["/"]);
import { Refine } from "@refinedev/core";

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

const MyRefreshComponent = () => {
  return <RefreshButton colorScheme="black" recordItemId="123" />;
};
// visible-block-end

const App = () => {
  return (
    <Refine
      resources={[
        {
          name: "posts",
          list: MyRefreshComponent,
        },
      ]}
    />
  );
};

render(
  <Wrapper>
    <App />
  </Wrapper>,
);

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

resource​

resource allows us to manage which resource is going to be refreshed. By default it will read the id information from the route.

setInitialRoutes(["/"]);

import { Refine } from "@refinedev/core";

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

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

const App = () => {
  return (
    <Refine
      resources={[
        {
          name: "posts",
          list: MyRefreshComponent,
        },
      ]}
    />
  );
};

render(
  <Wrapper>
    <App />
  </Wrapper>,
);

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 show and not show the text of the button. When true, only the button icon is visible.

setInitialRoutes(["/"]);

import { Refine } from "@refinedev/core";

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

const MyRefreshComponent = () => {
  return <RefreshButton colorScheme="black" hideText recordItemId="123" />;
};
// visible-block-end

const App = () => {
  return (
    <Refine
      resources={[
        {
          name: "posts",
          list: MyRefreshComponent,
        },
      ]}
    />
  );
};

render(
  <Wrapper>
    <App />
  </Wrapper>,
);

resourceNameOrRouteName
deprecated
​

Use resource prop instead.

API Reference​

Properties​

Previous
List
Next
Save