Refresh

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

localhost:3000/posts/show/123

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>
    );
};

Properties

`recordItemId`

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

localhost:3000

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

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

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

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.

localhost:3000

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

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

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.

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`

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

localhost:3000

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

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

`resourceNameOrRouteName`
deprecated

resourceNameOrRouteName prop is deprecated. Use resource prop instead.

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

localhost:3000

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

const MyRefreshComponent = () => {
    return (
        <RefreshButton
            colorScheme="black"
            resourceNameOrRouteName="categories"
            recordItemId="2"
        />
    );
};

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.

Usage​

Properties​

recordItemId​

resource​

hideText​

resourceNameOrRouteName deprecated​

API Reference​

Properties​

Usage

Properties

`recordItemId`

`resource`

`hideText`

`resourceNameOrRouteName`
deprecated

API Reference

Properties