List

<ListButton> is using Ant Design's <Button> component and the list method from useNavigation under the hood.

It can be useful when redirecting the app to the list page route of resource.

Usage​

import { useShow } from "@refinedev/core";
import {
  Show,
  ListButton,
} 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 headerButtons={<ListButton />} isLoading={isLoading}>
      <Title level={5}>Id</Title>
      <Text>{record?.id}</Text>

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

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

The button text is defined automatically by Refine based on the resource definition.

Properties​

resource​

The redirection endpoint is defined by the resource's list action path. By default, <ListButton> uses the inferred resource from the route.

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

const MyListComponent = () => {
  return <ListButton resource="categories" />;
};

Clicking the button will trigger the list method of useNavigation and then redirect the app to the list action path of the resource, filling the necessary parameters in the route.

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 section of the <Refine/> component documentation →

meta​

It is used to pass additional parameters to the list method of useNavigation. By default, existing parameters in the route are used by the list method. You can pass additional parameters or override the existing ones using the meta prop.

If the list action route is defined by the pattern: /:authorId/posts, the meta prop can be used as follows:

const MyComponent = () => {
  return <ListButton meta={{ authorId: "10" }} />;
};

hideText​

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

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

const MyListComponent = () => {
  return (
    <ListButton
      hideText={true}
    />
  );
};

accessControl​

This prop can be used to skip access control check with its enabled property or to hide the button when the user does not have the permission to access the resource with hideIfUnauthorized property. This is relevant only when an accessControlProvider is provided to <Refine/>

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

export const MyListComponent = () => {
  return (
    <ListButton accessControl={{ enabled: true, hideIfUnauthorized: true }} />
  );
};

resourceNameOrRouteName

deprecated

​

Use resource prop instead.

API Reference​

Properties​