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

Show

<ShowButton> uses Chakra 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 to customize it with the refine CLI

Usage​

http://localhost:3000
import {
List,
TableContainer,
Table,
Thead,
Tr,
Th,
Tbody,
Td,
ShowButton,
} from "@pankod/refine-chakra-ui";
import { useTable, ColumnDef, flexRender } from "@pankod/refine-react-table";

const PostList: React.FC = () => {
const columns = React.useMemo<ColumnDef<IPost>[]>(
() => [
{
id: "id",
header: "ID",
accessorKey: "id",
},
{
id: "title",
header: "Title",
accessorKey: "title",
},
{
id: "actions",
header: "Actions",
accessorKey: "id",
cell: function render({ getValue }) {
return (
<ShowButton recordItemId={getValue() as number} />
);
},
},
],
[],
);

const { getHeaderGroups, getRowModel } = useTable({
columns,
});

List.defaultProps = {
headerButtons: <></>,
};

return (
<List>
<TableContainer>
<Table variant="simple" whiteSpace="pre-line">
<Thead>
{getHeaderGroups().map((headerGroup) => (
<Tr key={headerGroup.id}>
{headerGroup.headers.map((header) => {
return (
<Th key={header.id}>
{!header.isPlaceholder &&
flexRender(
header.column.columnDef
.header,
header.getContext(),
)}
</Th>
);
})}
</Tr>
))}
</Thead>
<Tbody>
{getRowModel().rows.map((row) => {
return (
<Tr key={row.id}>
{row.getVisibleCells().map((cell) => {
return (
<Td key={cell.id}>
{flexRender(
cell.column.columnDef.cell,
cell.getContext(),
)}
</Td>
);
})}
</Tr>
);
})}
</Tbody>
</Table>
</TableContainer>
</List>
);
};

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

Properties​

recordItemId​

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

http://localhost:3000
import { ShowButton } from "@pankod/refine-chakra-ui";

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

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

note

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

resourceNameOrRouteName​

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.

http://localhost:3000
import { ShowButton } from "@pankod/refine-chakra-ui";

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

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

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 { ShowButton } from "@pankod/refine-chakra-ui";

const MyShowComponent = () => {
return <ShowButton colorScheme="black" recordItemId="123" 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 { ShowButton } from "@pankod/refine-chakra-ui";

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

API Reference​

Properties​