Skip to main content
Version: 4.xx.xxSwizzle Ready

List

<ListButton> is using Material UI <Button> component. It uses the list method from useNavigation under the hood. It can be useful when redirecting the app to the list page route of resource.

Swizzle

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

Usage​

http://localhost:3000/posts
import { useShow } from "@refinedev/core";
import { ListButton, Show } from "@refinedev/mui";
import { Typography, Stack } from "@mui/material";

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

return (
<Show
isLoading={isLoading}
headerButtons={
<ListButton />
}
>
<Stack gap="10px">
<Typography fontWeight="bold">Id</Typography>
<Typography>{record?.id}</Typography>
<Typography fontWeight="bold">Title</Typography>
<Typography>{record?.title}</Typography>
</Stack>
</Show>
);
};

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

The button text is defined automatically by refine based on resource object name property.

Properties​

resource​

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

http://localhost:3000
import { ListButton } from "@refinedev/mui";

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

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.

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​

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 { ListButton } from "@refinedev/mui";

const MyListComponent = () => {
return (
<ListButton
resourceNameOrRouteName="posts"
hideText
/>
);
};

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/mui";

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

resourceNameOrRouteName
deprecated
​

resourceNameOrRouteName prop is deprecated. Use resource prop instead.

Redirection endpoint(resourceNameOrRouteName/list) is defined by resourceNameOrRouteName property. By default, <ListButton> uses name property of the resource object as the endpoint to redirect after clicking.

http://localhost:3000
import { ListButton } from "@refinedev/mui";

const MyListComponent = () => {
return <ListButton resourceNameOrRouteName="categories" recordItemId="2" />;
};

Clicking the button will trigger the list method of useNavigation and then redirect to /categories.

API Reference​

Properties​

External Props

It also accepts all props of Material UI Button.