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

Show

<ShowButton> uses Material UI's <Button> component. It uses the show method from useNavigation under the hood. It can be useful when redirecting the app to the show page with the record id route of resource.

Swizzle

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

Usage​

localhost:3000/posts
import {
useDataGrid,
List,
ShowButton,
} from "@refinedev/mui";
import { DataGrid, GridColDef } from "@mui/x-data-grid";

const columns: GridColDef[] = [
{ field: "id", headerName: "ID", type: "number" },
{ field: "title", headerName: "Title", minWidth: 400, flex: 1 },
{
field: "actions",
headerName: "Actions",
renderCell: function render({ row }) {
return <ShowButton size="small" recordItemId={row.id} />;
},
align: "center",
headerAlign: "center",
minWidth: 80,
},
];

const PostsList: React.FC = () => {
const { dataGridProps } = useDataGrid<IPost>();

return (
<List>
<DataGrid {...dataGridProps} columns={columns} autoHeight />
</List>
);
};

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

Properties​

recordItemId​

recordItemId is used to append the record id to the end of the route path.

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

const MyShowComponent = () => {
return (
<ShowButton
resource="posts"
recordItemId="1"
/>
);
};

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

NOTE

<ShowButton> component reads the id information from the route by default.

resource​

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

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

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

Clicking the button will trigger the show method of useNavigation and then redirect the app to the show 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 of the <Refine/> component documentation β†’

meta​

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

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

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

hideText​

hideText is used to show or hide the text of the button. When true, only the button icon is visible.

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

const MyShowComponent = () => {
return (
<ShowButton
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 { ShowButton } from "@refinedev/mui";

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

resourceNameOrRouteName
deprecated
​

resourceNameOrRouteName prop is deprecated. Use resource prop instead.

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

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

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

Clicking the button will trigger the show method of useNavigation and then redirect the app to /categories/show/2.

API Reference​

Properties​

External Props

It also accepts all props of Material UI Button.